Style Intelligence v12.0

inetsoft.uql.asset
Interface TableAssembly

All Superinterfaces:
Assembly, AssetObject, Cloneable, inetsoft.util.ContentObject, Serializable, inetsoft.uql.asset.internal.VariableProvider, WSAssembly, inetsoft.util.XMLSerializable
All Known Implementing Classes:
AbstractTableAssembly, BoundTableAssembly, ComposedTableAssembly, CompositeTableAssembly, ConcatenatedTableAssembly, CubeTableAssembly, DataTableAssembly, EmbeddedTableAssembly, JoinTableAssembly, MirrorTableAssembly, PhysicalBoundTableAssembly, QueryBoundTableAssembly, RotatedTableAssembly, SnapshotEmbeddedTableAssembly, UnpivotTableAssembly

public interface TableAssembly
extends WSAssembly, inetsoft.util.ContentObject

Table assembly represents a table in Worksheet, which occuies an area in its Worksheet, and show table data as its content.


Field Summary
 
Fields inherited from interface inetsoft.uql.asset.Assembly
CUBE_VS, DETAIL, EMBEDDED, FIELD, SELECTION, TABLE_VS
 
Method Summary
 void clearCache()
          Clear cache.
 void clearProperty(String key)
          Clear property.
 boolean equalsContent(Object obj)
          Check if equals another object in content.
 AggregateInfo getAggregateInfo()
          Get the group info.
 UserVariable[] getAllVariables()
          Get all variables in the condition value list.
 ColumnSelection getColumnSelection()
          Get the inner column selection.
 ColumnSelection getColumnSelection(boolean pub)
          Get the column selection.
 int getContentCode()
          Get the hash code only considering content.
 long getLastModified()
          Get the lastModified.
 int getMaxDisplayRows()
          Get the maximum display rows.
 int getMaxRows()
          Get the maximum rows.
 Dimension getMinimumSize(boolean embedded)
          Get the minimum size.
 ConditionList getMVConditionList()
          Get mv condition, merged mv update and delete conditions.
 ConditionListWrapper getMVDeleteConditionList()
          Get mv delete condition, merged with mv delete pre and post conditions.
 ConditionListWrapper getMVDeletePostConditionList()
          Get mv delete post condition.
 ConditionListWrapper getMVDeletePreConditionList()
          Get mv delete pre condition.
 ConditionList getMVUpdateConditionList()
          Get mv update condition, merged mv update pre and post conditions.
 ConditionListWrapper getMVUpdatePostConditionList()
          Get mv update post condition.
 ConditionListWrapper getMVUpdatePreConditionList()
          Get mv update pre condition.
 ConditionListWrapper getPostConditionList()
          Get the postprocess condition list.
 ConditionListWrapper getPostRuntimeConditionList()
          Get the postprocess runtime condition list.
 ConditionListWrapper getPreConditionList()
          Get the preprocess condition list.
 ConditionListWrapper getPreRuntimeConditionList()
          Get the preprocess runtime condition list.
 Enumeration getProperties()
          Get all the property keys.
 String getProperty(String key)
          Get the value of a property.
 ConditionListWrapper getRankingConditionList()
          Get the ranking condition list.
 ConditionListWrapper getRankingRuntimeConditionList()
          Get the ranking runtime condition list.
 inetsoft.report.composition.mv.RuntimeMV getRuntimeMV()
          Get the runtime MV.
 SortInfo getSortInfo()
          Get the sort info.
 String getSource()
          Get the source of the table assembly.
 inetsoft.uql.asset.internal.TableAssemblyInfo getTableInfo()
          Get the table assembly info.
 inetsoft.uql.asset.internal.TableAssemblyInfo getTableInfo(boolean tables)
          Get the table assembly info.
 boolean isAggregate()
          Check if is an aggregate.
 boolean isDistinct()
          Check if only show distinct values.
 boolean isLiveData()
          Check if show live data.
 boolean isMVForceAppendUpdates()
          Gets the flag that determines if the results of an MV update are always appended to the existing data.
 boolean isPlain()
          Check if is a plain table.
 boolean isRuntime()
          Check if the table is in runtime mode.
 boolean isSQLMergeable()
          Check if the sql query is mergeable.
 boolean isVisibleTable()
          Check if the worksheet is block.
 void print(int level, StringBuffer sb)
          Print the table information.
 void resetColumnSelection()
          Reset column selection.
 void setAggregate(boolean aggregate)
          Set the aggregate flag.
 void setAggregateInfo(AggregateInfo ginfo)
          Set the group info.
 void setColumnPropertyName(String name)
          Set column changed property name.
 void setColumnSelection(ColumnSelection selection)
          Set the column selection.
 void setColumnSelection(ColumnSelection selection, boolean pub)
          Set the column selection.
 void setDistinct(boolean distinct)
          Set the distinct option.
 void setLastModified(long lastModified)
          Set the lastModified.
 void setLiveData(boolean live)
          Set the live data option.
 void setMaxDisplayRows(int row)
          Set the maximum display rows.
 void setMaxRows(int row)
          Set the maximum rows.
 void setMVDeletePostConditionList(ConditionListWrapper conds)
          Set mv delete post condition.
 void setMVDeletePreConditionList(ConditionListWrapper conds)
          Set mv delete pre condition.
 void setMVForceAppendUpdates(boolean mvForceAppendUpdates)
          Sets the flag that determines if the results of an MV update are always appended to the existing data.
 void setMVUpdatePostConditionList(ConditionListWrapper conds)
          Set mv update post condition.
 void setMVUpdatePreConditionList(ConditionListWrapper conds)
          Set mv update pre condition.
 void setPostConditionList(ConditionListWrapper conds)
          Set the postprocess condition list.
 void setPostRuntimeConditionList(ConditionListWrapper conds)
          Set the postprocess runtime condition list.
 void setPreConditionList(ConditionListWrapper conds)
          Set the preprocess condition list.
 void setPreRuntimeConditionList(ConditionListWrapper conds)
          Set the preprocess runtime condition list.
 void setProperty(String key, String value)
          Set the value a property.
 void setRankingConditionList(ConditionListWrapper conds)
          Set the ranking condition list.
 void setRankingRuntimeConditionList(ConditionListWrapper conds)
          Set the ranking runtime condition list.
 void setRuntime(boolean runtime)
          Set the runtime mode.
 void setRuntimeMV(inetsoft.report.composition.mv.RuntimeMV rinfo)
          Set the runtime MV.
 void setSortInfo(SortInfo info)
          Set the sort info.
 void setSQLMergeable(boolean mergeable)
          Set whether the sql query is mergeable.
 void setVisibleTable(boolean visibleTable)
          Set whether the worksheet is block.
 void updateTable(TableAssembly table)
          update properties of table.
 void writeData(JarOutputStream out)
          Write out data content of this table.
 
Methods inherited from interface inetsoft.uql.asset.WSAssembly
checkValidity, copyAssembly, getDescription, getWorksheet, getWSAssemblyInfo, isComposed, isCondition, isDateCondition, isIconized, isNamedGroup, isOuter, isTable, isVariable, replaceVariables, reset, setDescription, setIconized, setOuter, setVisible, setWorksheet, update
 
Methods inherited from interface inetsoft.uql.asset.Assembly
addr, checkDependency, clone, getAbsoluteName, getAssemblyEntry, getAssemblyType, getBounds, getDependeds, getInfo, getMinimumSize, getName, getPosition, getSheet, getSize, isEditable, isVisible, renameDepended, setBounds, setPosition, setSize
 
Methods inherited from interface inetsoft.util.XMLSerializable
parseXML, writeXML
 
Methods inherited from interface inetsoft.util.ContentObject
printKey
 

Method Detail

getTableInfo

inetsoft.uql.asset.internal.TableAssemblyInfo getTableInfo()
Get the table assembly info.

Returns:
the table assembly info of the table assembly.

getTableInfo

inetsoft.uql.asset.internal.TableAssemblyInfo getTableInfo(boolean tables)
Get the table assembly info.

Parameters:
tables - true to include sub tables' infos, false otherwise.
Returns:
the table assembly info of the table assembly.

getMinimumSize

Dimension getMinimumSize(boolean embedded)
Get the minimum size.

Parameters:
embedded - true to embed the table assembly.
Returns:
the minimum size of the assembly.

getColumnSelection

ColumnSelection getColumnSelection()
Get the inner column selection.

Returns:
the inner column selection of the table assembly.

getColumnSelection

ColumnSelection getColumnSelection(boolean pub)
Get the column selection.

Parameters:
pub - true indicates the public column selection, false otherwise.
Returns:
the column selection of the table assembly.

setColumnSelection

void setColumnSelection(ColumnSelection selection)
Set the column selection.

Parameters:
selection - the specified selection.

setColumnSelection

void setColumnSelection(ColumnSelection selection,
                        boolean pub)
Set the column selection.

Parameters:
pub - true indicates the public column selection, false otherwise.
selection - the specified selection.

isPlain

boolean isPlain()
Check if is a plain table.

Returns:
true if yes, false otherwise.

getAllVariables

UserVariable[] getAllVariables()
Get all variables in the condition value list.

Specified by:
getAllVariables in interface inetsoft.uql.asset.internal.VariableProvider

getPreRuntimeConditionList

ConditionListWrapper getPreRuntimeConditionList()
Get the preprocess runtime condition list.

Returns:
the preprocess runtime condition list of the table assembly.

setPreRuntimeConditionList

void setPreRuntimeConditionList(ConditionListWrapper conds)
Set the preprocess runtime condition list.

Parameters:
conds - the specified preprocess runtime condition list.

getPostRuntimeConditionList

ConditionListWrapper getPostRuntimeConditionList()
Get the postprocess runtime condition list.

Returns:
the postprocess runtime condition list of the table assembly.

setPostRuntimeConditionList

void setPostRuntimeConditionList(ConditionListWrapper conds)
Set the postprocess runtime condition list.

Parameters:
conds - the specified postprocess runtime condition list.

getRankingRuntimeConditionList

ConditionListWrapper getRankingRuntimeConditionList()
Get the ranking runtime condition list.

Returns:
the ranking runtime condition list of the table assembly.

setRankingRuntimeConditionList

void setRankingRuntimeConditionList(ConditionListWrapper conds)
Set the ranking runtime condition list.

Parameters:
conds - the specified ranking runtime condition list.

getPreConditionList

ConditionListWrapper getPreConditionList()
Get the preprocess condition list.

Returns:
the preprocess condition list of the table assembly.

setPreConditionList

void setPreConditionList(ConditionListWrapper conds)
Set the preprocess condition list.

Parameters:
conds - the specified preprocess condition list.

getPostConditionList

ConditionListWrapper getPostConditionList()
Get the postprocess condition list.

Returns:
the postprocess condition list of the table assembly..

setPostConditionList

void setPostConditionList(ConditionListWrapper conds)
Set the postprocess condition list.

Parameters:
conds - the specified postprocess condition list.

getRankingConditionList

ConditionListWrapper getRankingConditionList()
Get the ranking condition list.

Returns:
the ranking condition list of the table assembly..

setRankingConditionList

void setRankingConditionList(ConditionListWrapper conds)
Set the ranking condition list.

Parameters:
conds - the specified ranking condition list.

getMVConditionList

ConditionList getMVConditionList()
Get mv condition, merged mv update and delete conditions.


getMVUpdateConditionList

ConditionList getMVUpdateConditionList()
Get mv update condition, merged mv update pre and post conditions.


getMVDeleteConditionList

ConditionListWrapper getMVDeleteConditionList()
Get mv delete condition, merged with mv delete pre and post conditions.


getMVUpdatePreConditionList

ConditionListWrapper getMVUpdatePreConditionList()
Get mv update pre condition.


setMVUpdatePreConditionList

void setMVUpdatePreConditionList(ConditionListWrapper conds)
Set mv update pre condition.


getMVUpdatePostConditionList

ConditionListWrapper getMVUpdatePostConditionList()
Get mv update post condition.


setMVUpdatePostConditionList

void setMVUpdatePostConditionList(ConditionListWrapper conds)
Set mv update post condition.


getMVDeletePreConditionList

ConditionListWrapper getMVDeletePreConditionList()
Get mv delete pre condition.


setMVDeletePreConditionList

void setMVDeletePreConditionList(ConditionListWrapper conds)
Set mv delete pre condition.


getMVDeletePostConditionList

ConditionListWrapper getMVDeletePostConditionList()
Get mv delete post condition.


setMVDeletePostConditionList

void setMVDeletePostConditionList(ConditionListWrapper conds)
Set mv delete post condition.


isMVForceAppendUpdates

boolean isMVForceAppendUpdates()
Gets the flag that determines if the results of an MV update are always appended to the existing data.

Returns:
true to force updates to be appended.

setMVForceAppendUpdates

void setMVForceAppendUpdates(boolean mvForceAppendUpdates)
Sets the flag that determines if the results of an MV update are always appended to the existing data.

Parameters:
mvForceAppendUpdates - true to force updates to be appended.

getAggregateInfo

AggregateInfo getAggregateInfo()
Get the group info.

Returns:
the group info of the table assembly..

setAggregateInfo

void setAggregateInfo(AggregateInfo ginfo)
Set the group info.

Parameters:
info - the specified group info.

getSortInfo

SortInfo getSortInfo()
Get the sort info.

Returns:
the sort info of the table assembly.

setSortInfo

void setSortInfo(SortInfo info)
Set the sort info.

Parameters:
info - the specified sort info.

getMaxRows

int getMaxRows()
Get the maximum rows.

Returns:
the maximum rows of the table assembly.

setMaxRows

void setMaxRows(int row)
Set the maximum rows.

Parameters:
row - the specified maximum rows.

getMaxDisplayRows

int getMaxDisplayRows()
Get the maximum display rows.

Returns:
the maximum display rows of the table assembly.

setMaxDisplayRows

void setMaxDisplayRows(int row)
Set the maximum display rows.

Parameters:
row - the specified maximum display rows.

isDistinct

boolean isDistinct()
Check if only show distinct values.

Returns:
true to show distinct values only, false otherwise.

setDistinct

void setDistinct(boolean distinct)
Set the distinct option.

Parameters:
distinct - true to show distinct values only, false otherwise.

isLiveData

boolean isLiveData()
Check if show live data.

Returns:
true to show live data, false to show metadata.

setLiveData

void setLiveData(boolean live)
Set the live data option.

Parameters:
live - true to show live data, false to show metadata.

isRuntime

boolean isRuntime()
Check if the table is in runtime mode.

Returns:
true if in runtime mode, false otherwise.

setRuntime

void setRuntime(boolean runtime)
Set the runtime mode.

Parameters:
runtime - true if in runtime mode, false otherwise.

isAggregate

boolean isAggregate()
Check if is an aggregate.

Returns:
true if is an aggregate.

setAggregate

void setAggregate(boolean aggregate)
Set the aggregate flag.

Parameters:
aggregate - true if is an aggregate.

isSQLMergeable

boolean isSQLMergeable()
Check if the sql query is mergeable.

Returns:
true if the sql query is mergeable, false otherwise.

setSQLMergeable

void setSQLMergeable(boolean mergeable)
Set whether the sql query is mergeable.

Parameters:
mergeable - true if the sql query is mergeable, false otherwise.

isVisibleTable

boolean isVisibleTable()
Check if the worksheet is block.

Returns:
true if the worksheet is block., false otherwise.

setVisibleTable

void setVisibleTable(boolean visibleTable)
Set whether the worksheet is block.

Parameters:
visible - true if the worksheet is block., false otherwise.

getSource

String getSource()
Get the source of the table assembly.

Returns:
the source of the table assembly.

setRuntimeMV

void setRuntimeMV(inetsoft.report.composition.mv.RuntimeMV rinfo)
Set the runtime MV.


getRuntimeMV

inetsoft.report.composition.mv.RuntimeMV getRuntimeMV()
Get the runtime MV.


equalsContent

boolean equalsContent(Object obj)
Check if equals another object in content.

Specified by:
equalsContent in interface inetsoft.util.ContentObject
Parameters:
obj - the specified object.
Returns:
true if equals the object in content, false otherwise.

getContentCode

int getContentCode()
Get the hash code only considering content.

Returns:
the hash code only considering content.

getProperty

String getProperty(String key)
Get the value of a property.

Parameters:
key - the specified property name.
Returns:
the value of the property.

setProperty

void setProperty(String key,
                 String value)
Set the value a property.

Parameters:
key - the property name.
value - the property value, null to remove the property.

getLastModified

long getLastModified()
Get the lastModified.

Returns:
lastModified.

setLastModified

void setLastModified(long lastModified)
Set the lastModified.

Parameters:
lastModified -

clearProperty

void clearProperty(String key)
Clear property.

Parameters:
key - the property name.

clearCache

void clearCache()
Clear cache.


getProperties

Enumeration getProperties()
Get all the property keys.

Returns:
all the property keys.

print

void print(int level,
           StringBuffer sb)
Print the table information.


resetColumnSelection

void resetColumnSelection()
Reset column selection.


setColumnPropertyName

void setColumnPropertyName(String name)
Set column changed property name.


writeData

void writeData(JarOutputStream out)
Write out data content of this table.


updateTable

void updateTable(TableAssembly table)
update properties of table.


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