org.compiere.model
Class MQuery

java.lang.Object
  org.compiere.model.MQuery

All Implemented Interfaces:

Serializable

public class MQuery
extends Object
implements Serializable

Query Descriptor. Maintains restrictions (WHERE clause)

Version:

$Id: MQuery.java,v 1.4 2006/07/30 00:58:04 jjanke Exp $

Author:

Jorg Janke

See Also:

Serialized Form

Field Summary

static String	BETWEEN Between
static int	BETWEEN_INDEX Between - 8
static String	EQUAL Equal
static int	EQUAL_INDEX Equal - 0
static String	GREATER Greater
static String	GREATER_EQUAL Greater Equal
static String	LESS Less
static String	LESS_EQUAL Less Equal
static String	LIKE Like
static String	NOT_EQUAL Not Equal
static String	NOT_LIKE Not Like
static ValueNamePair[]	OPERATORS Operators for Strings
static ValueNamePair[]	OPERATORS_ID Operators for IDs
static ValueNamePair[]	OPERATORS_YN Operators for Boolean

Constructor Summary

MQuery()
Constructor w/o table name

MQuery(int AD_Table_ID)
Constructor get TableNAme from Table

MQuery(String TableName)
Constructor

Method Summary

void	addRangeRestriction(String ColumnName, Object Code, Object Code_to) Add Range Restriction (BETWEEN)
void	addRangeRestriction(String ColumnName, Object Code, Object Code_to, String InfoName, String InfoDisplay, String InfoDisplay_to) Add Range Restriction (BETWEEN)
protected void	addRestriction(org.compiere.model.Restriction r) Add Restriction
void	addRestriction(String whereClause) Add Restriction
void	addRestriction(String ColumnName, String Operator, int Code) Add Restriction
void	addRestriction(String ColumnName, String Operator, Object Code) Add Restriction
void	addRestriction(String ColumnName, String Operator, Object Code, String InfoName, String InfoDisplay) Add Restriction
MQuery	deepCopy() Clone Query
static MQuery	get(Properties ctx, int AD_PInstance_ID, String TableName) Get Query from Parameter
int	getAD_PInstance_ID()
Object	getCode(int index) Get Operator of index
String	getColumnName(int index) Get ColumnName of index
String	getDisplayName(Properties ctx) Get Display Name
static MQuery	getEqualQuery(String columnName, int value) Create simple Equal Query.
static MQuery	getEqualQuery(String columnName, Object value) Create simple Equal Query.
String	getInfo() Get printable Query Info
String	getInfoDisplay_to(int index) Get TO Restriction Display of index
String	getInfoDisplay(int index) Get Restriction Display of index
String	getInfoDisplayAll(int index) Get Display with optional To
String	getInfoName(int index) Get Info Name
String	getInfoOperator(int index) Get Info Operator
static MQuery	getNoRecordQuery(String tableName, boolean newRecord) Create No Record query.
String	getOperator(int index) Get Operator of index
int	getRecordCount() Get Record Count
int	getRestrictionCount() Get Restriction Count
String	getTableName() Get Table Name
String	getWhereClause() Create the resulting Query WHERE Clause
String	getWhereClause(boolean fullyQualified) Create the resulting Query WHERE Clause
String	getWhereClause(int index) Create Query WHERE Clause.
static String	getZoomColumnName(String columnName) Get Zoom Column Name.
static String	getZoomTableName(String columnName) Derive Zoom Table Name from column name.
boolean	isActive() Is Query Active
boolean	isNewRecordQuery() New Record Query
protected void	setColumnName(int index, String ColumnName) Set ColumnName of index
void	setRecordCount(int count) Set Record Count
void	setTableName(String TableName) Set Table Name
String	toString() String representation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EQUAL

public static final String EQUAL

Equal

See Also:

Constant Field Values

EQUAL_INDEX

public static final int EQUAL_INDEX

Equal - 0

See Also:

Constant Field Values

NOT_EQUAL

public static final String NOT_EQUAL

Not Equal

See Also:

Constant Field Values

LIKE

public static final String LIKE

Like

See Also:

Constant Field Values

NOT_LIKE

public static final String NOT_LIKE

Not Like

See Also:

Constant Field Values

GREATER

public static final String GREATER

Greater

See Also:

Constant Field Values

GREATER_EQUAL

public static final String GREATER_EQUAL

Greater Equal

See Also:

Constant Field Values

LESS

public static final String LESS

Less

See Also:

Constant Field Values

LESS_EQUAL

public static final String LESS_EQUAL

Less Equal

See Also:

Constant Field Values

BETWEEN

public static final String BETWEEN

Between

See Also:

Constant Field Values

BETWEEN_INDEX

public static final int BETWEEN_INDEX

Between - 8

See Also:

Constant Field Values

OPERATORS

public static final ValueNamePair[] OPERATORS

Operators for Strings

OPERATORS_ID

public static final ValueNamePair[] OPERATORS_ID

Operators for IDs

OPERATORS_YN

public static final ValueNamePair[] OPERATORS_YN

Operators for Boolean

Constructor Detail

MQuery

public MQuery()

Constructor w/o table name

MQuery

public MQuery(String TableName)

Constructor

Parameters:

TableName - Table Name

MQuery

public MQuery(int AD_Table_ID)

Constructor get TableNAme from Table

Parameters:

AD_Table_ID - Table_ID

Method Detail

get

public static MQuery get(Properties ctx,
                         int AD_PInstance_ID,
                         String TableName)

Get Query from Parameter

Parameters:

ctx - context (to determine language)

AD_PInstance_ID - instance

TableName - table name

Returns:

where clause

getZoomColumnName

public static String getZoomColumnName(String columnName)

Get Zoom Column Name. Converts Synonyms like SalesRep_ID to AD_User_ID

Parameters:

columnName - column name

Returns:

column name

getZoomTableName

public static String getZoomTableName(String columnName)

Derive Zoom Table Name from column name. (e.g. drop _ID)

Parameters:

columnName - column name

Returns:

table name

getEqualQuery

public static MQuery getEqualQuery(String columnName,
                                   Object value)

Create simple Equal Query. Creates columnName=value or columnName='value'

Parameters:

columnName - columnName

value - value

Returns:

quary

getEqualQuery

public static MQuery getEqualQuery(String columnName,
                                   int value)

Create simple Equal Query. Creates columnName=value

Parameters:

columnName - columnName

value - value

Returns:

quary

getNoRecordQuery

public static MQuery getNoRecordQuery(String tableName,
                                      boolean newRecord)

Create No Record query.

Parameters:

tableName - table name

newRecord - new Record Indicator (2=3)

Returns:

query

getRecordCount

public int getRecordCount()

Get Record Count

Returns:

count - default 999999

setRecordCount

public void setRecordCount(int count)

Set Record Count

Parameters:

count - count

addRestriction

public void addRestriction(String ColumnName,
                           String Operator,
                           Object Code,
                           String InfoName,
                           String InfoDisplay)

Add Restriction

Parameters:

ColumnName - ColumnName

Operator - Operator, e.g. = != ..

Code - Code, e.g 0, All%

InfoName - Display Name

InfoDisplay - Display of Code (Lookup)

addRestriction

public void addRestriction(String ColumnName,
                           String Operator,
                           Object Code)

Add Restriction

Parameters:

ColumnName - ColumnName

Operator - Operator, e.g. = != ..

Code - Code, e.g 0, All%

addRestriction

public void addRestriction(String ColumnName,
                           String Operator,
                           int Code)

Add Restriction

Parameters:

ColumnName - ColumnName

Operator - Operator, e.g. = != ..

Code - Code, e.g 0

addRangeRestriction

public void addRangeRestriction(String ColumnName,
                                Object Code,
                                Object Code_to,
                                String InfoName,
                                String InfoDisplay,
                                String InfoDisplay_to)

Add Range Restriction (BETWEEN)

Parameters:

ColumnName - ColumnName

Code - Code, e.g 0, All%

Code_to - Code, e.g 0, All%

InfoName - Display Name

InfoDisplay - Display of Code (Lookup)

InfoDisplay_to - Display of Code (Lookup)

addRangeRestriction

public void addRangeRestriction(String ColumnName,
                                Object Code,
                                Object Code_to)

Add Range Restriction (BETWEEN)

Parameters:

ColumnName - ColumnName

Code - Code, e.g 0, All%

Code_to - Code, e.g 0, All%

addRestriction

protected void addRestriction(org.compiere.model.Restriction r)

Add Restriction

Parameters:

r - Restriction

addRestriction

public void addRestriction(String whereClause)

Add Restriction

Parameters:

whereClause - SQL WHERE clause

isNewRecordQuery

public boolean isNewRecordQuery()

New Record Query

Returns:

true if new nercord query

getWhereClause

public String getWhereClause()

Create the resulting Query WHERE Clause

Returns:

Where Clause

getWhereClause

public String getWhereClause(boolean fullyQualified)

Create the resulting Query WHERE Clause

Parameters:

fullyQualified - fully qualified Table.ColumnName

Returns:

Where Clause

getInfo

public String getInfo()

Get printable Query Info

Returns:

info

getWhereClause

public String getWhereClause(int index)

Create Query WHERE Clause. Not fully qualified

Parameters:

index - restriction index

Returns:

Where Clause or "" if not valid

getRestrictionCount

public int getRestrictionCount()

Get Restriction Count

Returns:

number of restricctions

isActive

public boolean isActive()

Is Query Active

Returns:

true if number of restricctions > 0

getTableName

public String getTableName()

Get Table Name

Returns:

Table Name

setTableName

public void setTableName(String TableName)

Set Table Name

Parameters:

TableName - Table Name

getColumnName

public String getColumnName(int index)

Get ColumnName of index

Parameters:

index - index

Returns:

ColumnName

setColumnName

protected void setColumnName(int index,
                             String ColumnName)

Set ColumnName of index

Parameters:

index - index

ColumnName - new column name

getOperator

public String getOperator(int index)

Get Operator of index

Parameters:

index - index

Returns:

Operator

getCode

public Object getCode(int index)

Get Operator of index

Parameters:

index - index

Returns:

Operator

getInfoDisplay

public String getInfoDisplay(int index)

Get Restriction Display of index

Parameters:

index - index

Returns:

Restriction Display

getInfoDisplay_to

public String getInfoDisplay_to(int index)

Get TO Restriction Display of index

Parameters:

index - index

Returns:

Restriction Display

getInfoName

public String getInfoName(int index)

Get Info Name

Parameters:

index - index

Returns:

Info Name

getInfoOperator

public String getInfoOperator(int index)

Get Info Operator

Parameters:

index - index

Returns:

info Operator

getInfoDisplayAll

public String getInfoDisplayAll(int index)

Get Display with optional To

Parameters:

index - index

Returns:

info display

toString

public String toString()

String representation

Overrides:

toString in class Object

Returns:

info

getDisplayName

public String getDisplayName(Properties ctx)

Get Display Name

Parameters:

ctx - context

Returns:

display Name

deepCopy

public MQuery deepCopy()

Clone Query

Returns:

Query

getAD_PInstance_ID

public int getAD_PInstance_ID()

Returns:

AD_PInstance_ID; this value is set if you created this query by using get(Properties, int, String)