|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tivoli.twg.engine.TWGDbColumnFilter
TWGDbColumnFilter is an abstract base class that encapsulates the common parameters used to filter rows in a table based on the values of a column. The table name, column name , and logical operator are included. Subclasses of this class hold the values used to filter the column based on the type of data in the column.
Constructor Summary | |
---|---|
protected |
TWGDbColumnFilter(byte[] buf,
int offset,
java.lang.String version)
This method is protected as an implementation side effect. |
|
TWGDbColumnFilter(java.lang.String columnFullName,
java.lang.String operation)
Constructor for the TWGDbColumnFilter class. |
|
TWGDbColumnFilter(java.lang.String tableName,
java.lang.String columnName,
java.lang.String operation)
Constructor for the TWGDbColumnFilter class. |
|
TWGDbColumnFilter(TWGDbColumnFilter copyColFilter)
Constructor to create a copy of another column filter. |
Method Summary | |
---|---|
boolean |
allowsGTLT()
Is the user allowed to use greater than and less than in queries and filters for this column? |
protected boolean |
checkOperator(java.lang.String op)
Check the validity of the operator |
static TWGDbColumnFilter |
create(byte[] buf,
int offset,
java.lang.String version)
This method is public as an implementation side effect. |
protected abstract TWGDbColumnFilter |
createFilterInfo(java.util.Locale loc)
Abstract method to create a columnFilter with locale specific info filled in. |
java.lang.String |
getColumnDisplayName()
Get the displayable column name for this column filter. |
java.lang.String |
getColumnFullName()
Get the combined table token name and column token name for this filter. |
java.lang.String |
getColumnName()
Get the token column name for this column filter |
int |
getColumnType()
Get the column type for the column this filter was used for. |
abstract int |
getDataValueType()
Abstract method to return data value type. |
protected int |
getIntelByteBufferSize()
This method is protected as an implementation side effect. |
java.lang.String |
getOperator()
Get the logical operator for this filter |
java.lang.String |
getTableDisplayName()
Get the displayable table name for this column filter. |
java.lang.String |
getTableName()
Get the token table name for this column filter |
abstract java.util.Vector |
getValuesAsObject()
Abstract method to translate values into corresponding Objects and put them in a vector. |
abstract int |
getValueSize()
Abstract method to get the size of the values array. |
protected void |
setFilterInfo(java.util.Locale loc)
This method is protected as an implementation side effect. |
int |
setIntelByteBufferParms(byte[] buf,
int offset)
This method is protected as an implementation side effect. |
void |
setOperator(java.lang.String operation)
Set the operator for this filter. |
java.lang.String |
toString()
Convert column to String for debug |
protected boolean |
verify()
This method should be called only from withing the Director engine. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public TWGDbColumnFilter(java.lang.String columnFullName, java.lang.String operation) throws TWGDbException
columnFullName
- - table token name plus column token name. Format
is "tableName.columnName".operation
- - operator for the filter. Valid values are:
TWGDbColumnOperators.EQUAL
NOT_EQUAL
GREATER_THAN
GREATER_THAN_OR_EQUAL
LESS_THAN
LESS_THAN_OR_EQUAL
TWGDbException
TWGDbColumnOperators
public TWGDbColumnFilter(java.lang.String tableName, java.lang.String columnName, java.lang.String operation) throws TWGDbException
tableName
- - table token namecolumnName
- - column token nameoperation
- - operator for the filter. Valid values are:
TWGDbColumnOperators.EQUAL
NOT_EQUAL
GREATER_THAN
GREATER_THAN_OR_EQUAL
LESS_THAN
LESS_THAN_OR_EQUAL \
TWGDbException
TWGDbColumnOperators
public TWGDbColumnFilter(TWGDbColumnFilter copyColFilter)
protected TWGDbColumnFilter(byte[] buf, int offset, java.lang.String version) throws TWGDbException
Constructor to create a column filter from an intel byte buffer format byte array
buf
- - the byte arrayoffset
- - the offset in the buffer that the column filter starts atversion
- - the database version
TWGDbException
Method Detail |
public static TWGDbColumnFilter create(byte[] buf, int offset, java.lang.String version) throws TWGDbException
Create a column filter from an intel byte buffer format byte array
buf
- - the byte arrayoffset
- - the offset in the buffer that the column filter starts atversion
- - the database version
TWGDbException
protected abstract TWGDbColumnFilter createFilterInfo(java.util.Locale loc) throws TWGDbException
loc
- - the Locale for translations
TWGDbException
public abstract int getValueSize()
public java.lang.String getOperator()
public void setOperator(java.lang.String operation) throws TWGDbException
operation
- - the logical operator for this filter. Valid values are
found in TWGDatabaseConstants
TWGDbException
TWGDatabaseConstants
public java.lang.String getColumnFullName()
public java.lang.String getTableName()
public java.lang.String getTableDisplayName()
protected void setFilterInfo(java.util.Locale loc) throws TWGDbException
loc
- - the locale to use for translations
-
- a TWGDbException if the table or column is not found.
TWGDbException
public boolean allowsGTLT()
public int getColumnType()
public java.lang.String getColumnName()
public java.lang.String getColumnDisplayName()
public abstract java.util.Vector getValuesAsObject()
public abstract int getDataValueType()
DataValue
protected boolean verify()
protected boolean checkOperator(java.lang.String op)
public int setIntelByteBufferParms(byte[] buf, int offset) throws TWGDbException
Write an intel byte buffer version of this column filter to a byte array at the offset specified.
buf
- - byte array in which to write the dataoffset
- - offset into the array to start writing
-
- TWGDbException thrown for parameter or version errors
TWGDbException
protected int getIntelByteBufferSize()
public java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |