Style Intelligence v12.0

inetsoft.uql
Interface XTable

All Superinterfaces:
Cloneable, Serializable
All Known Subinterfaces:
BinaryTableFilter, DataTableLens, GroupedTable, MemberObjectTableLens, RegionTable, SortedTable, TableFilter, TableLens
All Known Implementing Classes:
AbstractBinaryTableFilter, AbstractConditionFilter, AbstractGroupedTable, AbstractTableLens, AttributeTableLens, CalcTableLens, ColumnMapFilter, CompositeTableLens, ConditionFilter, CORBATableLens, CrossJoinTableLens, CrosstabConditionFilter, CrossTabCubeFilter, CrossTabFilter, CubeTableFilter, DataSetTable, DefaultSortedTable, DefaultTableFilter, DefaultTableLens, DistinctTableLens, EightyTwentyFilter, FormulaTableLens, GroupedColumnMapFilter, GroupedSortFilter, GroupFilter, HeaderRowTableLens, HighlightFilter, IntersectTableLens, JDBCTableLens, JoinTableLens, MaxRowsTableLens, MaxRowsTableLens2, MergedJoinTableLens, MetaTableFilter, MinusTableLens, PagedTableLens, RankingTableLens, RotatedTableLens, RowSummaryFilter, SelfJoinTableLens, SetTableLens, SortFilter, SubTableLens, SummaryFilter, SummaryTableLens, TableSummaryFilter, TextTableLens, TopNFilter, TransparentGroupFilter, UnionTableLens, XMLTableLens, XNodeTableLens

public interface XTable
extends Serializable, Cloneable

XTable provides the API for accessing table data. It is similar to XTableNode but is more report oriented, and serves to provide more direct access without row iteration. The interface is used in the report engine.


Field Summary
static int EOT
          End of table flag for method moreRows.
 
Method Summary
 void dispose()
          Dispose the table to clear up temporary resources.
 boolean getBoolean(int r, int c)
          Get the boolean value in one row.
 byte getByte(int r, int c)
          Get the byte value in one row.
 int getColCount()
          Return the number of columns in the table.
 Class getColType(int col)
          Get the current column content type.
 String getColumnIdentifier(int col)
          Get the column identifier of a column.
 TableDataDescriptor getDescriptor()
          Get internal table data descriptor which contains table structural infos.
 double getDouble(int r, int c)
          Get the double value in one row.
 float getFloat(int r, int c)
          Get the float value in one row.
 int getHeaderColCount()
          Return the number of columns on the left of the table to be treated as header columns.
 int getHeaderRowCount()
          Return the number of rows on the top of the table to be treated as header rows.
 int getInt(int r, int c)
          Get the int value in one row.
 long getLong(int r, int c)
          Get the long value in one row.
 Object getObject(int r, int c)
          Return the value at the specified cell.
 int getRowCount()
          Return the number of rows in the table.
 short getShort(int r, int c)
          Get the short value in one row.
 int getTrailerColCount()
          Return the number of columns on the right of the table to be treated as trailer columns.
 int getTrailerRowCount()
          Return the number of rows on the bottom of the table to be treated as trailer rows.
 boolean isNull(int r, int c)
          Check if the value at one cell is null.
 boolean isPrimitive(int col)
          Check if is primitive.
 boolean moreRows(int row)
          Check if there are more rows.
 void setColumnIdentifier(int col, String identifier)
          Set the column identifier of a column.
 void setObject(int r, int c, Object v)
          Set the cell value.
 

Field Detail

EOT

static final int EOT
End of table flag for method moreRows.

See Also:
Constant Field Values
Method Detail

moreRows

boolean moreRows(int row)
Check if there are more rows. The row index is the row that will be accessed. This method must block until the row is available, or return false if the row does not exist in the table. This method is used to iterate through the table, and allow partial table to be accessed in report processing.

Parameters:
row - row number. If EOT is passed in, this method should wait until the table is fully loaded.
Returns:
true if the row exists, or false if no more rows.

getRowCount

int getRowCount()
Return the number of rows in the table. The number of rows includes the header rows. If the table is loading in background and loading is not done, return the negative number of loaded rows minus 1.

Returns:
number of rows in table.

getColCount

int getColCount()
Return the number of columns in the table. The number of columns includes the header columns.

Returns:
number of columns in table.

getHeaderRowCount

int getHeaderRowCount()
Return the number of rows on the top of the table to be treated as header rows.

Returns:
number of header rows. Default is 1.

getHeaderColCount

int getHeaderColCount()
Return the number of columns on the left of the table to be treated as header columns.


getTrailerRowCount

int getTrailerRowCount()
Return the number of rows on the bottom of the table to be treated as trailer rows.

Returns:
number of header rows.

getTrailerColCount

int getTrailerColCount()
Return the number of columns on the right of the table to be treated as trailer columns.


isNull

boolean isNull(int r,
               int c)
Check if the value at one cell is null.

Parameters:
r - the specified row index.
c - column number.
Returns:
true if null, false otherwise.

getObject

Object getObject(int r,
                 int c)
Return the value at the specified cell.

Parameters:
r - row number.
c - column number.
Returns:
the value at the location.

getDouble

double getDouble(int r,
                 int c)
Get the double value in one row.

Parameters:
r - the specified row index.
c - column number.
Returns:
the double value in the specified row.

getFloat

float getFloat(int r,
               int c)
Get the float value in one row.

Parameters:
r - the specified row index.
c - column number.
Returns:
the float value in the specified row.

getLong

long getLong(int r,
             int c)
Get the long value in one row.

Parameters:
r - the specified row index.
c - column number.
Returns:
the long value in the specified row.

getInt

int getInt(int r,
           int c)
Get the int value in one row.

Parameters:
r - the specified row index.
c - column number.
Returns:
the int value in the specified row.

getShort

short getShort(int r,
               int c)
Get the short value in one row.

Parameters:
r - the specified row index.
c - column number.
Returns:
the short value in the specified row.

getByte

byte getByte(int r,
             int c)
Get the byte value in one row.

Parameters:
r - the specified row index.
c - column number.
Returns:
the byte value in the specified row.

getBoolean

boolean getBoolean(int r,
                   int c)
Get the boolean value in one row.

Parameters:
r - the specified row index.
c - column number.
Returns:
the boolean value in the specified row.

setObject

void setObject(int r,
               int c,
               Object v)
Set the cell value. For table filters, the setObject() call should be forwarded to the base table if possible. An implementation should throw a runtime exception if this method is not supported. In that case, data in a table can not be modified in scripts.

Parameters:
r - row number.
c - column number.
v - cell value.

getColType

Class getColType(int col)
Get the current column content type.

Parameters:
col - column number.
Returns:
column type.

isPrimitive

boolean isPrimitive(int col)
Check if is primitive.

Returns:
true if is primitive, false otherwise.

dispose

void dispose()
Dispose the table to clear up temporary resources.


getColumnIdentifier

String getColumnIdentifier(int col)
Get the column identifier of a column.

Parameters:
col - the specified column index.
Returns:
the column indentifier of the column. The identifier might be different from the column name, for it may contain more locating information than the column name.

setColumnIdentifier

void setColumnIdentifier(int col,
                         String identifier)
Set the column identifier of a column.

Parameters:
col - the specified column index.
identifier - the column indentifier of the column. The identifier might be different from the column name, for it may contain more locating information than the column name.

getDescriptor

TableDataDescriptor getDescriptor()
Get internal table data descriptor which contains table structural infos.

Returns:
table data descriptor.

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.