Style Intelligence v12.0

inetsoft.report.lens.xnode
Class XNodeTableLens

java.lang.Object
  extended by inetsoft.report.lens.AbstractTableLens
      extended by inetsoft.report.lens.xnode.XNodeTableLens
All Implemented Interfaces:
inetsoft.report.internal.table.CachedTableLens, inetsoft.report.internal.table.CancellableTableLens, StyleConstants, TableLens, XConstants, XTable, Serializable, Cloneable

public class XNodeTableLens
extends AbstractTableLens
implements inetsoft.report.internal.table.CancellableTableLens, inetsoft.report.internal.table.CachedTableLens

Table lens used to convert a data tree to a table. If the data tree is already a table, the table is used directly. Otherwise, if the data tree is a sequence, each item in the sequence is transformed into a row. Otherwise, the tree is converted into a one row table, with the columns from each branch of the tree.

Note: only after setNode is called could we access it as a table lens.

See Also:
Serialized Form

Field Summary
protected  XTable table
           
 
Fields inherited from class inetsoft.report.lens.AbstractTableLens
isLeftAlign
 
Fields inherited from interface inetsoft.report.TableLens
BREAK_BORDER, NULL
 
Fields inherited from interface inetsoft.uql.XTable
EOT
 
Fields inherited from interface inetsoft.report.StyleConstants
ARROW_LINE_1, ARROW_LINE_2, ARROW_LINE_3, BACKGROUND_CENTER, BACKGROUND_TILED, BOX_RECTANGLE, BOX_ROUNDED_RECTANGLE, CENTER, CHART_3D_BAR, CHART_3D_BAR_3D, CHART_3D_PIE, CHART_3D_STACK_BAR, CHART_AREA, CHART_BAR, CHART_BUBBLE, CHART_CANDLE, CHART_CURVE, CHART_FILL_RADAR, CHART_GANTT, CHART_INV_BAR, CHART_INV_CURVE, CHART_INV_LINE, CHART_INV_POINT, CHART_INV_STACK_BAR, CHART_LINE, CHART_MAX_USER, CHART_PARETO, CHART_PIE, CHART_PIE_EXPLODED_ALL, CHART_PIE_EXPLODED_FIRST, CHART_PIE_EXPLODED_NONE, CHART_POINT, CHART_RADAR, CHART_RIBBON, CHART_SCATTER, CHART_SPEEDOMETER, CHART_STACK_AREA, CHART_STACK_BAR, CHART_STICK, CHART_STOCK, CHART_SURFACE, CHART_USER, CHART_VOLUME, CHART_WATERFALL, CHART_XY_LINE, CIRCLE, CROSS, CURRENCY, DASH_LINE, DASH_MASK, DEFAULT_PAGE_SIZE, DIAMOND, DOT_LINE, DOUBLE_3D_LOWERED, DOUBLE_3D_RAISED, DOUBLE_LINE, DOUBLE_MASK, FILL, FILLED_CIRCLE, FILLED_DIAMOND, FILLED_SQUARE, FILLED_TRIANGLE, FRACTION_WIDTH_MASK, H_ALIGN_MASK, H_CENTER, H_CURRENCY, H_LEFT, H_LINE, H_RIGHT, LANDSCAPE, LARGE_DASH, LEFT, LINECAP_BUTT, LINECAP_ROUND, LINECAP_SQUARE, LINEJOIN_BEVEL, LINEJOIN_MITER, LINEJOIN_ROUND, LOWERED_3D, LOWERED_MASK, LT_ANGLE, MEDIUM_DASH, MEDIUM_LINE, NIL, NO_BORDER, NONE, PAPER_10X11, PAPER_10X14, PAPER_11X17, PAPER_15X11, PAPER_9X11, PAPER_A_PLUS, PAPER_A2, PAPER_A3, PAPER_A3_EXTRA, PAPER_A3_EXTRA_TRANSVERSE, PAPER_A3_TRANSVERSE, PAPER_A4, PAPER_A4_EXTRA, PAPER_A4_PLUS, PAPER_A4_TRANSVERSE, PAPER_A4SMALL, PAPER_A5, PAPER_A5_EXTRA, PAPER_A5_TRANSVERSE, PAPER_B_PLUS, PAPER_B4, PAPER_B5, PAPER_B5_EXTRA, PAPER_B5_TRANSVERSE, PAPER_CSHEET, PAPER_DSHEET, PAPER_ENV_10, PAPER_ENV_11, PAPER_ENV_12, PAPER_ENV_14, PAPER_ENV_9, PAPER_ENV_B4, PAPER_ENV_B5, PAPER_ENV_B6, PAPER_ENV_C3, PAPER_ENV_C4, PAPER_ENV_C5, PAPER_ENV_C6, PAPER_ENV_C65, PAPER_ENV_DL, PAPER_ENV_INVITE, PAPER_ENV_ITALY, PAPER_ENV_MONARCH, PAPER_ENV_PERSONAL, PAPER_ESHEET, PAPER_EXECUTIVE, PAPER_FANFOLD_LGL_GERMAN, PAPER_FANFOLD_STD_GERMAN, PAPER_FANFOLD_US, PAPER_FOLIO, PAPER_ISO_B4, PAPER_JAPANESE_POSTCARD, PAPER_LEDGER, PAPER_LEGAL, PAPER_LEGAL_EXTRA, PAPER_LETTER, PAPER_LETTER_EXTRA, PAPER_LETTER_EXTRA_TRANSVERSE, PAPER_LETTER_PLUS, PAPER_LETTER_TRANSVERSE, PAPER_LETTERSMALL, PAPER_NOTE, PAPER_QUARTO, PAPER_STATEMENT, PAPER_TABLOID, PAPER_TABLOID_EXTRA, PATTERN_0, PATTERN_1, PATTERN_10, PATTERN_11, PATTERN_12, PATTERN_13, PATTERN_14, PATTERN_15, PATTERN_16, PATTERN_17, PATTERN_18, PATTERN_19, PATTERN_2, PATTERN_3, PATTERN_4, PATTERN_5, PATTERN_6, PATTERN_7, PATTERN_8, PATTERN_9, PATTERN_NONE, PORTRAIT, RAISED_3D, RAISED_MASK, REMAINDER, RIGHT, RIGHT_ANGLE, SOLID_MASK, SQUARE, STAR, THICK_LINE, THIN_LINE, THIN_THIN_LINE, TRAY_AUTO, TRAY_CASSETTE, TRAY_ENVELOPE, TRAY_ENVMANUAL, TRAY_FORMSOURCE, TRAY_LARGECAPACITY, TRAY_LARGEFMT, TRAY_LOWER, TRAY_MANUAL, TRAY_MIDDLE, TRAY_ONLYONE, TRAY_SMALLFMT, TRAY_TRACTOR, TRAY_UPPER, TRIANGLE, ULTRA_THIN_LINE, V_ALIGN_MASK, V_ANGLE, V_BASELINE, V_BOTTOM, V_CENTER, V_LINE, V_TOP, WIDTH_MASK, X
 
Fields inherited from interface inetsoft.uql.XConstants
AM_PM_DATE_GROUP, AM_PM_OF_DAY_DATE_GROUP, AVERAGE_FORMULA, CALC_FORMULA, COLUMN, CONCAT_FORMULA, CONDITION_EMPTY_STRING, CONDITION_NULL_STRING, CONDITION_NULL_VALUE, CONDITION_REAL_NULL, CORRELATION_FORMULA, COUNT_FORMULA, COVARIANCE_FORMULA, CURRENCY_FORMAT, CURRENT_REP_CHANGED, CURRENT_REP_WILL_CHANGE, DATE_FORMAT, DAY_DATE_GROUP, DAY_OF_MONTH_DATE_GROUP, DAY_OF_WEEK_DATE_GROUP, DAY_OF_YEAR_DATE_GROUP, DECIMAL_FORMAT, DISTINCTCOUNT_FORMULA, FIRST_FORMULA, FULL_JOIN, GREATER_EQUAL_JOIN, GREATER_JOIN, GROUP_OTHERS, HOUR_DATE_GROUP, HOUR_OF_DAY_DATE_GROUP, INNER_JOIN, JOIN, LAST_FORMULA, LEAVE_OTHERS, LEFT_JOIN, LESS_EQUAL_JOIN, LESS_JOIN, MAX_FORMULA, MEDIAN_FORMULA, MESSAGE_FORMAT, MILLISECOND_DATE_GROUP, MIN_FORMULA, MINUTE_DATE_GROUP, MODE_FORMULA, MONTH_DATE_GROUP, MONTH_OF_YEAR_DATE_GROUP, NONE_DATE_GROUP, NONE_FORMULA, NOT_EQUAL_JOIN, NTHLARGEST_FORMULA, NTHMOSTFREQUENT_FORMULA, NTHSMALLEST_FORMULA, PARAM_PREFIX, PART_DATE_GROUP, PERCENT_FORMAT, PERCENTAGE_BY_COL, PERCENTAGE_BY_ROW, PERCENTAGE_NONE, PERCENTAGE_OF_COL_GRANDTOTAL, PERCENTAGE_OF_COL_GROUP, PERCENTAGE_OF_GRANDTOTAL, PERCENTAGE_OF_GROUP, PERCENTAGE_OF_ROW_GRANDTOTAL, PERCENTAGE_OF_ROW_GROUP, POPULATIONSTANDARDDEVIATION_FORMULA, POPULATIONVARIANCE_FORMULA, PRODUCT_FORMULA, PTHPERCENTILE_FORMULA, QUARTER_DATE_GROUP, QUARTER_OF_YEAR_DATE_GROUP, RIGHT_JOIN, SECOND_DATE_GROUP, SET_FORMULA, SORT_ASC, SORT_DESC, SORT_NONE, SORT_ORIGINAL, SORT_SPECIFIC, SORT_VALUE_ASC, SORT_VALUE_DESC, STANDARDDEVIATION_FORMULA, SUB_QUERY_PARAM, SUM_FORMULA, SUMSQ_FORMULA, SUMWT_FORMULA, VARIANCE_FORMULA, WEEK_DATE_GROUP, WEEK_OF_MONTH_DATE_GROUP, WEEK_OF_YEAR_DATE_GROUP, WEIGHTEDAVERAGE_FORMULA, YEAR_DATE_GROUP
 
Constructor Summary
XNodeTableLens()
          Create an empty XNodeTableLens.
XNodeTableLens(XNode root)
          Create a table from a data tree.
 
Method Summary
 void cancel()
          Cancel the lens and running queries if supported
 void clearCache()
          Clear all cached data.
 XNodeTableLens cloneShared()
          Make a clone of the table with shared data.
 void dispose()
          Dispose the table lens.
 int getAppliedMaxRows()
          Get the applied max rows.
 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.
 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.
 inetsoft.uql.table.XSwappableTable getSwappableTable()
          Get swappable table.
 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 isCancelled()
          Check the XNodeTableLens to see if it is cancelled.
 boolean isNull(int r, int c)
          Check if the value at one cell is null.
 boolean isPrimitive(int col)
          Check if is primitive.
 boolean isRecursiveDispose()
          Check if should dispose tables recursively when dispose this table.
 boolean isTimeoutTable()
          Check if a table is a result of timeout.
 boolean isValid()
          Check if this table lens is valid for use.
 boolean moreRows(int row)
          Check if there are more rows.
 void setNode(XNode root)
          Set the data tree used to create a table.
 void setObject(int r, int c, Object v)
          Set the cell value.
 void setRecursiveDispose(boolean rdispose)
          Set whether should dispose tables recursively when dispose this table.
 
Methods inherited from class inetsoft.report.lens.AbstractTableLens
addChangeListener, clone, containsDrill, containsFormat, findColumnByIdentifier, fireChangeEvent, getAlignment, getBackground, getColBorder, getColBorderColor, getColType, getColumnIdentifier, getColWidth, getDefaultFormat, getFont, getForeground, getInsets, getRowBorder, getRowBorderColor, getRowHeight, getSpan, getXDrillInfo, isLineWrap, removeChangeListener, setColumnIdentifier, setLeftAlign, setLocal
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface inetsoft.report.TableLens
addChangeListener, containsDrill, containsFormat, getAlignment, getBackground, getColBorder, getColBorderColor, getColWidth, getDefaultFormat, getFont, getForeground, getInsets, getRowBorder, getRowBorderColor, getRowHeight, getSpan, getXDrillInfo, isLineWrap, removeChangeListener
 
Methods inherited from interface inetsoft.uql.XTable
getColType, getColumnIdentifier, setColumnIdentifier
 

Field Detail

table

protected XTable table
Constructor Detail

XNodeTableLens

public XNodeTableLens()
Create an empty XNodeTableLens.


XNodeTableLens

public XNodeTableLens(XNode root)
Create a table from a data tree.

Method Detail

setNode

public void setNode(XNode root)
Set the data tree used to create a table.


cancel

public void cancel()
Cancel the lens and running queries if supported

Specified by:
cancel in interface inetsoft.report.internal.table.CancellableTableLens

isCancelled

public boolean isCancelled()
Check the XNodeTableLens to see if it is cancelled.

Specified by:
isCancelled in interface inetsoft.report.internal.table.CancellableTableLens

isValid

public boolean isValid()
Check if this table lens is valid for use.

Returns:
true if valid for use, false otherwise.

clearCache

public void clearCache()
Clear all cached data.

Specified by:
clearCache in interface inetsoft.report.internal.table.CachedTableLens

setRecursiveDispose

public void setRecursiveDispose(boolean rdispose)
Set whether should dispose tables recursively when dispose this table.


isRecursiveDispose

public boolean isRecursiveDispose()
Check if should dispose tables recursively when dispose this table.


dispose

public void dispose()
Dispose the table lens.

Specified by:
dispose in interface XTable
Overrides:
dispose in class AbstractTableLens

moreRows

public 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.

Specified by:
moreRows in interface XTable
Overrides:
moreRows in class AbstractTableLens
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

public 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.

Specified by:
getRowCount in interface XTable
Returns:
number of rows in table.

getColCount

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

Specified by:
getColCount in interface XTable
Returns:
number of columns in table.

getHeaderRowCount

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

Specified by:
getHeaderRowCount in interface XTable
Overrides:
getHeaderRowCount in class AbstractTableLens
Returns:
number of header rows. Default is 1.

getHeaderColCount

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

Specified by:
getHeaderColCount in interface XTable
Overrides:
getHeaderColCount in class AbstractTableLens

getTrailerRowCount

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

Specified by:
getTrailerRowCount in interface XTable
Overrides:
getTrailerRowCount in class AbstractTableLens
Returns:
number of header rows.

getTrailerColCount

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

Specified by:
getTrailerColCount in interface XTable
Overrides:
getTrailerColCount in class AbstractTableLens

isPrimitive

public final boolean isPrimitive(int col)
Check if is primitive.

Specified by:
isPrimitive in interface XTable
Overrides:
isPrimitive in class AbstractTableLens
Returns:
true if is primitive, false otherwise.

isNull

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

Specified by:
isNull in interface XTable
Overrides:
isNull in class AbstractTableLens
Parameters:
r - the specified row index.
c - column number.
Returns:
true if null, false otherwise.

getObject

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

Specified by:
getObject in interface XTable
Parameters:
r - row number.
c - column number.
Returns:
the value at the location.

getDouble

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

Specified by:
getDouble in interface XTable
Overrides:
getDouble in class AbstractTableLens
Parameters:
r - the specified row index.
c - column number.
Returns:
the double value in the specified row.

getFloat

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

Specified by:
getFloat in interface XTable
Overrides:
getFloat in class AbstractTableLens
Parameters:
r - the specified row index.
c - column number.
Returns:
the float value in the specified row.

getLong

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

Specified by:
getLong in interface XTable
Overrides:
getLong in class AbstractTableLens
Parameters:
r - the specified row index.
c - column number.
Returns:
the long value in the specified row.

getInt

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

Specified by:
getInt in interface XTable
Overrides:
getInt in class AbstractTableLens
Parameters:
r - the specified row index.
c - column number.
Returns:
the int value in the specified row.

getShort

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

Specified by:
getShort in interface XTable
Overrides:
getShort in class AbstractTableLens
Parameters:
r - the specified row index.
c - column number.
Returns:
the short value in the specified row.

getByte

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

Specified by:
getByte in interface XTable
Overrides:
getByte in class AbstractTableLens
Parameters:
r - the specified row index.
c - column number.
Returns:
the byte value in the specified row.

getBoolean

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

Specified by:
getBoolean in interface XTable
Overrides:
getBoolean in class AbstractTableLens
Parameters:
r - the specified row index.
c - column number.
Returns:
the boolean value in the specified row.

setObject

public void setObject(int r,
                      int c,
                      Object v)
Set the cell value.

Specified by:
setObject in interface XTable
Overrides:
setObject in class AbstractTableLens
Parameters:
r - row number.
c - column number.
v - cell value.

cloneShared

public XNodeTableLens cloneShared()
Make a clone of the table with shared data. Each cloned copy does not shared data modified through setObject().


getDescriptor

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

Specified by:
getDescriptor in interface TableLens
Specified by:
getDescriptor in interface XTable
Overrides:
getDescriptor in class AbstractTableLens
Returns:
table data descriptor.

getAppliedMaxRows

public int getAppliedMaxRows()
Get the applied max rows.

Returns:
the applied max rows.

isTimeoutTable

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


getSwappableTable

public inetsoft.uql.table.XSwappableTable getSwappableTable()
Get swappable table.


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