|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.gre.samples.collectionhelpers.IRMResultList
The IRMResultList encapsulates the XML returned from a Records Manager Query. The class contains methods for iterating through all the results from a query while iterating through all the individual Columns for each result. Tables of values can be built using this process. There are methods that can be used to limit the number of columns to display.
Constructor Summary | |
---|---|
IRMResultList(IRMQuery irmQuery)
Constructor |
|
IRMResultList(java.lang.String resultList)
Constructor |
Method Summary | |
---|---|
void |
AddColumn(java.lang.String strFlPlnCmpntAttrDefColNm)
This method specifies the name of a column to include in the displayed results. |
int |
getColumnCount()
The number of columns to be displayed. |
java.lang.String |
getFlPlnCmpntAttrDefCapt(int index)
Gets the Caption of a table column for the specified index. |
java.lang.String |
getFlPlnCmpntAttrDefColNm(int index)
Gets the FlPlnCmpntAttrDefColNm of a table column for the specified index. |
java.lang.String |
getItemByFlPlnCmpntAttrDefColNm(int index,
java.lang.String strFlPlnCmpntAttrDefColNm)
This method gets the value for the column as specified by the strFlPlnCmpntAttrDefColNm param for the result set row specified by the index parameter. |
java.lang.String |
getItemByRowColumnIndex(int row,
int column)
This is a variation on the above method. |
int |
getItemCount()
The Number of rows that will be returned in the result set. |
int |
getPercentageColumnWidth(int index)
The suggested percentage of the total width for all Columns that the specified column should take up. |
void |
setWheight1(byte val)
Set the wheight value that is used for BINARY and BOOLEAN values when the percentage width is calculated for these types. |
void |
setWheight2(byte val)
Set the wheight value that is used for DATE, DOUBLE, INTEGER and VIRTUAL values when the percentage width is calculated for these types. |
void |
setWheight3(byte val)
Set the wheight value that is used for DATETIME, CLOB and STRING values when the percentage width is calculated for these types. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public IRMResultList(IRMQuery irmQuery) throws com.ibm.gre.engine.util.RecordManagerException, java.lang.Exception
irmQuery
- An IRMQuery object.
This constructor is provide for future
expansion of the class so that it may be possible
to re-order column results for
stateless clients.
com.ibm.gre.engine.util.RecordManagerException
java.lang.Exception
public IRMResultList(java.lang.String resultList) throws com.ibm.gre.engine.util.RecordManagerException
resultList
- The XML formatted String returned from
the QueryControllerEJB.runQuery method.
NOTE the queryResultOption value supplied
to the the runQuery method must be the value
com.ibm.gre.engine.util.QueryResultOptions.INCLUDE_COLUMNS
so that the MetaData element is included
in the result.
com.ibm.gre.engine.util.RecordManagerException
Method Detail |
public void AddColumn(java.lang.String strFlPlnCmpntAttrDefColNm) throws java.lang.Exception
strFlPlnCmpntAttrDefColNm
- The File Plan Component Attribute Column Name
that should be displayed.
java.lang.Exception
public int getColumnCount() throws java.lang.Exception
java.lang.Exception
public java.lang.String getFlPlnCmpntAttrDefCapt(int index) throws java.lang.Exception
index
- The index into the collection of Columns for this result list.
java.lang.Exception
public java.lang.String getFlPlnCmpntAttrDefColNm(int index) throws java.lang.Exception
index
- The index into the collection of Columns for this result list.
java.lang.Exception
public int getPercentageColumnWidth(int index)
index
- The index into the collection of Columns for this result list.
public int getItemCount()
public java.lang.String getItemByFlPlnCmpntAttrDefColNm(int index, java.lang.String strFlPlnCmpntAttrDefColNm) throws java.lang.Exception
index
- Use this value to specify the index value of
the Item (row) in the result set to return the value for.strFlPlnCmpntAttrDefColNm
- Use this value to specify the
name of the column to return the result for.
java.lang.Exception
public java.lang.String getItemByRowColumnIndex(int row, int column) throws java.lang.Exception
row
- Use this value to specify the index value of
the Item (row) in the result set to return the value for.column
- Use this value to specify the index value of the column
in the table.
java.lang.Exception
public void setWheight1(byte val)
val
- public void setWheight2(byte val)
val
- public void setWheight3(byte val)
val
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |