Style Intelligence v12.0

inetsoft.uql
Class XTableNode

java.lang.Object
  extended by inetsoft.uql.XNode
      extended by inetsoft.uql.XTableNode
All Implemented Interfaces:
Serializable, Cloneable, Comparable

public abstract class XTableNode
extends XNode

XTableNode represents a table. Although a table can be easily represented as a tree, with each table row converted to a subtree, it is often more efficient to keep the table semantics if the original data is returned as a table. This is particularly true for SQL data sources.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class inetsoft.uql.XNode
value
 
Constructor Summary
XTableNode()
          Create an empty table.
 
Method Summary
 void cancel()
          Cancel the query request to the datasource if datasource supports such a call
 void close()
          This method should be called after the data in the table node is read.
 int getAppliedMaxRows()
          Get the applied max rows.
abstract  int getColCount()
          Get the number of columns in the table.
 inetsoft.uql.table.XTableColumnCreator getColumnCreator(int col)
          Get the table column creator.
 inetsoft.uql.table.XTableColumnCreator[] getColumnCreators()
          Get the table column creators.
abstract  String getName(int col)
          Get the column name.
abstract  Object getObject(int col)
          Get the value in the current row at the specified column.
abstract  Class getType(int col)
          Get the column type.
abstract  XMetaInfo getXMetaInfo(int col)
          Get the meta info at the specified column.
 boolean isCacheable()
          Check if is cacheable.
abstract  boolean isRewindable()
          Check if the cursor can be rewinded.
 boolean isTimeoutTable()
          Check if a table is a result of timeout.
abstract  boolean next()
          Check if there are more rows.
abstract  boolean rewind()
          Move the cursor to the beginning.
 void setAppliedMaxRows(int amax)
          Set the applied max rows.
 
Methods inherited from class inetsoft.uql.XNode
addChild, addChild, addChild, addr, checkDuplicate, clone, cloneValue, compareTo, eq, equals, getAttribute, getAttributeNames, getChild, getChild, getChildCount, getChildIndex, getDefaultFormat, getName, getNode, getParent, getPath, getPath, getValue, getValue, hashCode, insertChild, isAncestor, removeAllChildren, removeChild, removeChild, removeChild, removeChild, setAttribute, setChild, setDefaultFormat, setName, setValue, sort, sort, toString, writeXML
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

XTableNode

public XTableNode()
Create an empty table.

Method Detail

next

public abstract boolean next()
Check if there are more rows. The first time this method is called, the cursor is positioned at the first row of the table.

Returns:
true if there are more rows.

getColCount

public abstract int getColCount()
Get the number of columns in the table.


getName

public abstract String getName(int col)
Get the column name.

Parameters:
col - column index.
Returns:
column name or alias if defined.

getType

public abstract Class getType(int col)
Get the column type.

Parameters:
col - column index.
Returns:
column data type.

getObject

public abstract Object getObject(int col)
Get the value in the current row at the specified column.

Parameters:
col - column index.
Returns:
column value.

getXMetaInfo

public abstract XMetaInfo getXMetaInfo(int col)
Get the meta info at the specified column.

Parameters:
col - column index.
Returns:
the meta info.

rewind

public abstract boolean rewind()
Move the cursor to the beginning. This is ignored if the cursor is already at the beginning.

Returns:
true if the rewinding is successful.

isRewindable

public abstract boolean isRewindable()
Check if the cursor can be rewinded.

Returns:
true if the cursor can be rewinded.

isTimeoutTable

public boolean isTimeoutTable()
Check if a table is a result of timeout.


getAppliedMaxRows

public int getAppliedMaxRows()
Get the applied max rows.

Returns:
the applied max rows.

setAppliedMaxRows

public void setAppliedMaxRows(int amax)
Set the applied max rows.

Parameters:
amax - the applied max rows.

close

public void close()
This method should be called after the data in the table node is read. If this object holds any connection, they will be released at this point.


cancel

public void cancel()
Cancel the query request to the datasource if datasource supports such a call


isCacheable

public boolean isCacheable()
Check if is cacheable.


getColumnCreator

public inetsoft.uql.table.XTableColumnCreator getColumnCreator(int col)
Get the table column creator.

Parameters:
col - the specified column index.
Returns:
the table column creator.

getColumnCreators

public inetsoft.uql.table.XTableColumnCreator[] getColumnCreators()
Get the table column creators.

Returns:
the table column creators.

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