|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tivoli.twg.engine.TWGDbQueryParms
The TWGDbQueryParms class contains the parameters to create a query. It is used in the create query and change query commands.
All tables used in a query must be from one physical Director database.
Constructor Summary | |
---|---|
protected |
TWGDbQueryParms(byte[] buf)
Constructor for the TWGDbQueryParms class using an intel byte buffer format of a TWGDbQueryParms object as input. |
|
TWGDbQueryParms(java.lang.String select_field)
Constructor for the TWGDbQueryParms class. |
|
TWGDbQueryParms(java.lang.String[] select_fields)
Constructor for the TWGDbQueryParms class that specifies multiple selected fields (columns). |
|
TWGDbQueryParms(java.lang.String[] select_fields,
java.lang.String database_name)
Constructor for the TWGDbQueryParms class that specifies multiple selected fields (columns) and a specific database. |
|
TWGDbQueryParms(java.lang.String select_field,
java.lang.String database_name)
Constructor for the TWGDbQueryParms for a query that uses one table column and specifies a database. |
|
TWGDbQueryParms(java.util.Vector select_fields)
Constructor for the TWGDbQueryParms class that specifies multiple selected fields (columns). |
|
TWGDbQueryParms(java.util.Vector select_fields,
java.lang.String database_name)
Constructor for the TWGDbQueryParms class that specifies multiple selected fields (columns) and a specific database. |
|
TWGDbQueryParms(Vect select_fields,
java.lang.String database_name)
Constructor for the TWGDbQueryParms class that specifies multiple selected fields (columns) and a specific database. |
Method Summary | |
---|---|
void |
addSelectFields(java.lang.String[] select_fields)
Add additional select fields to the current select fields for the query. |
void |
addSelectFields(Vect select_fields)
Add additional select fields to the current select fields for the query. |
void |
addSelectFields(java.util.Vector select_fields)
Add additional select fields to the current select fields for the query. |
void |
changeDatabaseName(java.lang.String dbName)
Set the database name the tables in the query are in. |
TWGDbColumnFilter |
getColumnFilter()
Get the column filter for the query. |
protected TWGDbColumnFilter |
getColumnFilterByTable(java.lang.String tableName)
Method to get column filter for a specific table in the query. |
java.lang.String |
getDatabaseName()
Get the database name that all the tables in the query are in. |
boolean |
getDefault()
Is the query a default query? |
boolean |
getDistinctRows()
Are distinct rows to be returned in the query results (duplicate rows omitted). |
protected int[] |
getFieldsByTable(java.lang.String tableName,
Vect queryColumnIds,
java.util.Vector fields)
Method to get list of TWGDbQueryField objects used for the select fields in the query for a table. |
int |
getFormat()
Method to get the query format. |
java.lang.String |
getGroupName()
Get the group name which is used to group queries. |
java.lang.String |
getIdString()
Get the id string which is used to uniquely identify a default queries. |
protected Vect |
getListTableTokens()
Method to get list of the token names of tables to select fields from. |
java.lang.String |
getQueryDisplayName()
This method applies to user defined queries to get the query name user provides. |
java.lang.String |
getQueryGraphic()
Get the icon name for the query |
int |
getQueryParmBufLen()
Get length of buffer containing information about query parms. |
java.lang.String |
getResourceBundleKey()
Get resource bundle key for default query to get the localized query name. |
java.lang.String |
getResourceBundleName()
Get the resource bundle base class name for the default query. |
boolean |
getSavedQuery()
Is this a saved query |
java.util.Vector |
getSelectFields()
Get a list of TWGDbQueryField objects which contain the selected columns in the query. |
Vect |
getSelectFieldsInVect()
Get a list of TWGDbQueryField objects as a Vect |
java.util.Vector |
getSortFields()
Get a list of TWGDbQueryField objects that aontain the column fields by which to sort the result set of the query |
protected java.util.Vector |
getSortFieldsByTable(java.lang.String tableName)
Method to get list of TWGDbQueryField objects used to sort the query for a table. |
Vect |
getSortFieldsInVect()
Get a list of TWGDbQueryField objects which contain the column fields by which to sort the result set of the query |
boolean |
getTranslateValues()
Are column values returned in this query to be translated for columns that support translation or enumeration. |
protected java.lang.String |
getUserId()
Get the user id for the query. |
void |
setColumnFilter(TWGDbColumnFilter columnFilter)
Set column filter used to select specific table rows base on the values in a column. |
void |
setDefault(boolean isDefaultQuery)
Set true if the query is default query created by an Director extension, false if the query is user defined. |
void |
setFormat(int queryFormat)
Method to set the query format. |
void |
setGraphic(java.lang.String queryGraphic)
Set the name of the icon for the query |
void |
setGroupName(java.lang.String groupName)
Set the group name of the query. |
void |
setIdString(java.lang.String id_string)
Set the id string which is used to uniquely identify default queries. |
void |
setIntelByteBufferParms(Command cmd)
This method is public as an implementation side effect. |
void |
setQueryDisplayName(java.lang.String queryDisplayName)
Set the display name of the query. |
void |
setResourceBundleKey(java.lang.String key)
Set resource bundle key for default query to get the localized query name. |
void |
setResourceBundleName(java.lang.String resourceBundleName)
Set the resource bundle base class name for the default query. |
void |
setRowDistinct(boolean distinctRows)
Set true, if entire duplicate rows are omitted in result set. |
void |
setSavedQuery(boolean savedQuery)
Set true to save the query and false not to save the query. |
void |
setSelectFields(java.lang.String[] select_fields)
Set the selected fields for the query |
void |
setSelectFields(Vect select_fields)
Set the selected fields for the query |
void |
setSelectFields(java.util.Vector select_fields)
Set the selected fields for the query. |
void |
setSortField(java.lang.String sort_field)
Method to set column field by which to sort the result set. |
void |
setSortField(Vect sort_fields)
Method to set column fields by which to sort the result set. |
void |
setSortField(java.util.Vector sort_fields)
Method to set column fields by which to sort the result set. |
void |
setTranslateValues(boolean translateValues)
Set true to translate the values of the query result set into the specific language or enumeration and false to keep the raw original values. |
protected void |
setUserId(java.lang.String userId)
Sets user id for the query. |
java.lang.String |
toString()
Convert object to String for debug |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public TWGDbQueryParms(java.lang.String select_field, java.lang.String database_name) throws TWGDbException
select_field
- - The selected column name. It should be column full name.
The format is 'table_token_name.column_token_name'database_name
- - database name in which the query is.com.tivoli.twg.engine.TWGDatabaseconstants
public TWGDbQueryParms(java.lang.String select_field) throws TWGDbException
select_field
- - The selected column name. The format should be
'table_token_name.column_token_name'public TWGDbQueryParms(java.util.Vector select_fields, java.lang.String database_name) throws TWGDbException
select_fields
- - Vector of TWGDbQueryField or String objects. The format
for strings must be "table_token_name.column_token_name"database_name
- - database name in which the query is.TWGDbQueryField
public TWGDbQueryParms(Vect select_fields, java.lang.String database_name) throws TWGDbException
select_fields
- - Vect of TWGDbQueryField or String objects. The format
for strings must be "table_token_name.column_token_name"database_name
- - database name in which the query is.TWGDbQueryField
,
Vect
public TWGDbQueryParms(java.util.Vector select_fields) throws TWGDbException
select_fields
- - Vector of TWGDbQueryField or String objects. The format
for strings must be "table_token_name.column_token_name"TWGDbQueryField
public TWGDbQueryParms(java.lang.String[] select_fields, java.lang.String database_name) throws TWGDbException
select_fields
- - String array containing selected fields for the query.
The format for strings must be "table_token_name.column_token_name"database_name
- - database name in which the query is.public TWGDbQueryParms(java.lang.String[] select_fields) throws TWGDbException
select_fields
- - String array containing selected fields for the query.
Its syntax should be table_token_name.column_token_name.protected TWGDbQueryParms(byte[] buf) throws TWGDbException
This method should be called only in the Director server engine.
buf
- - the intel byte buffer format of a TWGDbQueryParms objectMethod Detail |
protected Vect getListTableTokens()
This method is protected as an implementation side effect. Do not call or change. Its interface may be changed in a later release.
com.tivoli.twg.libs.Vect.
protected int[] getFieldsByTable(java.lang.String tableName, Vect queryColumnIds, java.util.Vector fields) throws TWGDbException
This method is protected as an implementation side effect. Do not call or change. Its interface may be changed in a later release.
tableName
- - table token namequeryColumnIds
- - Vect containing the column numbers for the query.fields
- - store the TWGDbQueryField objects in the query for the
table passed. It's output parameter.
TWGDbException
protected java.util.Vector getSortFieldsByTable(java.lang.String tableName)
This method is protected as an implementation side effect. Do not call or change. Its interface may be changed in a later release.
tableName
- - table token name
protected TWGDbColumnFilter getColumnFilterByTable(java.lang.String tableName)
This method is protected as an implementation side effect. Do not call or change. Its interface may be changed in a later release.
tableName
- - table token name
public void setFormat(int queryFormat)
queryFormat
- - query formatTWGDatabaseQuery
protected void setUserId(java.lang.String userId)
This method should be called only in the Director server engine.
userId
- - user identificationpublic void setIdString(java.lang.String id_string)
id_string
- - id string.public void setQueryDisplayName(java.lang.String queryDisplayName)
queryDisplayName
- - query name for display.public void setGroupName(java.lang.String groupName)
groupName
- - group name of the query.public void changeDatabaseName(java.lang.String dbName)
dbName
- - database namepublic void setDefault(boolean isDefaultQuery)
public void setGraphic(java.lang.String queryGraphic)
public void setColumnFilter(TWGDbColumnFilter columnFilter)
columnFilter
- - reference to a TWGDbColumnFilter object.TWGDbColumnFilter
public void setSortField(java.util.Vector sort_fields)
TWGDbQueryField
public void setSortField(Vect sort_fields)
TWGDbQueryField
public void setSortField(java.lang.String sort_field) throws TWGDbException
TWGDbException
public void setSavedQuery(boolean savedQuery)
savedQuery
- - boolean variablepublic void setTranslateValues(boolean translateValues)
translateValues
- - boolean variablepublic void setResourceBundleName(java.lang.String resourceBundleName)
resourceBundleName
- - the base class name for resource bundle objectspublic void setResourceBundleKey(java.lang.String key)
key
- - a resource bundle key for the query namepublic void setRowDistinct(boolean distinctRows)
distinctRows
- - true if duplicate rows are removed, otherwise, falsepublic int getFormat()
TWGDatabaseQuery
public java.lang.String getDatabaseName()
public boolean getDefault()
public java.lang.String getIdString()
public java.lang.String getQueryDisplayName()
public java.lang.String getGroupName()
public java.lang.String getQueryGraphic()
protected java.lang.String getUserId()
public TWGDbColumnFilter getColumnFilter()
public Vect getSelectFieldsInVect()
TWGDbQueryField
public java.util.Vector getSelectFields()
TWGDbQueryField
public Vect getSortFieldsInVect()
public java.util.Vector getSortFields()
public boolean getDistinctRows()
public boolean getSavedQuery()
public boolean getTranslateValues()
public java.lang.String getResourceBundleName()
public java.lang.String getResourceBundleKey()
public void setSelectFields(java.util.Vector select_fields) throws TWGDbException
select_fields
- - Vector of TWGDbQueryField or String objects. Format for
strings must be "table_token_name.column_token_name"
TWGDbException
TWGDbQueryField
public void setSelectFields(Vect select_fields) throws TWGDbException
select_fields
- - Vect of TWGDbQueryField or String objects. Format for
strings must be 'table_token_name.column_token_name"
TWGDbException
TWGDbQueryField
public void setSelectFields(java.lang.String[] select_fields) throws TWGDbException
select_fields
- - Array of String objects. Format for
strings must be 'table_token_name.column_token_name"
TWGDbException
TWGDbQueryField
public void addSelectFields(java.util.Vector select_fields) throws TWGDbException
select_fields
- - Vector of TWGDbQueryField or String objects. Format for
strings must be 'table_token_name.column_token_name"
TWGDbException
TWGDbQueryField
public void addSelectFields(Vect select_fields) throws TWGDbException
select_fields
- - Vect of TWGDbQueryField or String objects. Format for
strings must be 'table_token_name.column_token_name"
TWGDbException
TWGDbQueryField
public void addSelectFields(java.lang.String[] select_fields) throws TWGDbException
select_fields
- - Array of String objects. Format for
strings must be 'table_token_name.column_token_name"
TWGDbException
TWGDbQueryField
public void setIntelByteBufferParms(Command cmd) throws TWGDbException
Build IntelByteBuffer parms version of this command and add them to the IPC command
cmd
- - the IPC command whose input parameters will be set by this method
-
- TWGDbException thrown for parameter or version errors
TWGDbException
public int getQueryParmBufLen()
This method is public as an implementation side effect. Do not call or change. Its interface may be changed in a later release.
public java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |