com.technia.tvc.core.structure

Interface CompositeStructureBean

All Superinterfaces:

AttributeSupport, java.lang.Cloneable, ContextMenuSupport, EnvironmentSupport, com.technia.tvc.core.db.inquiry.InquirySupport, com.technia.tvc.core.db.jpo.JPOSupport, MenuBarSupport, PageConfigSupport, StructureBean, TableBean<StructureBeanNode>, TableDataProvider<StructureBeanNode>, ViewSupport

All Known Subinterfaces:

GroupStructureBean, StructureBeanWithModel

All Known Implementing Classes:

AbstractStructureBean, CachedRollUpStructureBean, ConfigurableStructureBean, DefaultStructureBean, ExpanderBasedStructureBean, GroupStructureBeanFromModel, GroupStructureBeanImpl, com.technia.tvc.core.structure.model.StructureBeanWithModelImpl

public interface CompositeStructureBean
extends StructureBean

A structure bean that supports multiple root nodes, i.e., a compsition of serveral structures.

Since:

4.1.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.technia.tvc.core.table.TableDataProvider

TableDataProvider.Displayed<T extends TableData>, TableDataProvider.Empty<T extends TableData>, TableDataProvider.Specific<T extends TableData>, TableDataProvider.Visible<T extends TableData>

Field Summary

Fields inherited from interface com.technia.tvc.core.table.TableDataProvider

EMPTY

Method Summary

Methods

Modifier and Type	Method and Description
void	addRoot(java.lang.String rootObjectId) Add a new root object to the structure.
StructureBeanNode	addRoot(java.lang.String connectionId, java.lang.String rootObjectId) Adds a new root object to the structure.
void	changeRootNode(StructureBeanNode rootNode, int i) Changes the root node at the specified index.
void	clearRootNodes() Removes all root nodes.
java.util.Iterator<StructureBeanNode>	getFilteredRootNodes(TableDataFilter filter) Returns the root nodes that are accepted by the specified filter.
int	getRootCount() Returns the root node count.
com.technia.tvc.core.db.inquiry.InquirySupport	getRootInquirySupport() Get an InquirySupport instance that can be used to load root nodes into the structure.
com.technia.tvc.core.db.jpo.JPOSupport	getRootJPOSupport() Get an JPOSupport instance that can be used to load root nodes into the structure.
StructureBeanNode	getRootNodeAt(int i) Returns the root node at the specified index.
java.util.Iterator<StructureBeanNode>	getRootNodes() Returns the root nodes.
boolean	isRootInquirySupported(com.technia.tvc.core.db.inquiry.Inquiry inquiry) Returns whether the specified inquiry can be used to load root nodes.
boolean	isRootNode(StructureBeanNode node) Returns whether the specified node is a root node in this structure.
boolean	isRootNodesNavigable()
void	loadRootsFromInquiry(com.technia.tvc.core.db.inquiry.Inquiry inquiry, Environment env) Load the root nodes from the specified inquiry.
void	loadRootsFromInquiry(com.technia.tvc.core.db.inquiry.Inquiry inquiry, Environment env, boolean append) Load the root nodes from the specified inquiry.
void	loadRootsFromJPO(JPOName name, Environment env) Load the root nodes from the specified JPO.
void	loadRootsFromJPO(JPOName name, Environment env, boolean append) Load the root nodes from the specified JPO.
boolean	removeRoot(java.lang.String rootObjectId) Removes all root nodes with the specified object ID.
boolean	removeRootNode(StructureBeanNode root) Removes the specified root node.

Methods inherited from interface com.technia.tvc.core.structure.StructureBean

accept, addNode, addStructureListener, changeRootNode, collapse, collapseNode, expand, expand, expandFully, expandNode, expandNode, expandNodeFully, getAllowInconsistentVisibleStructure, getInitialExpandDepth, getInitialExpandMode, getMultiLevelExpandDepth, getNodeAt, getNodeCount, getNodes, getNodes, getNodes, getRootNode, getVisibleChildAt, getVisibleChildCount, getVisibleChildIndex, getVisibleChildNodes, hasNodes, hasVisibleChildren, isAllowHideSingleRootNode, isFiltersCombinable, isFirstVisibleChild, isFullExpandSupported, isLastVisibleChild, isMultiLevelExpandSupported, isToFlatTableSupported, isVisibleChild, removeNode, removeNodes, removeNodes, removeStructureListener, setAllowHideSingleRootNode, setAllowInconsistentVisibleStructure, setInitialExpandDepth, setInitialExpandMode, setMultiLevelExpandDepth, setRoot, setRoot, toFlatTable

Methods inherited from interface com.technia.tvc.core.table.TableBean

accept, addTableClonedListener, addTableContentListener, addTableGroupedListener, addTableListener, addTableNavigateListener, addVisibleTableDataFilter, clearVisibleTableDataFilter, clone, getCalculations, getCellAt, getColumnAt, getColumnByName, getColumnCount, getColumnIndex, getColumnList, getColumns, getDisplayedTableData, getDisplayedTableDataCount, getEvaluationRequiredTableData, getEvaluationRequiredTableDataCount, getFilteredTableData, getFilteredTableDataCount, getHasParent, getHeader, getNavigationHandler, getNavigationHandler, getParent, getSelectedTableData, getSelectedTableDataCount, getSubHeader, getTableClonedListeners, getTableData, getTableData, getTableData, getTableDataAt, getTableDataCount, getTableDataWithId, getTableGroupedListeners, getTableListeners, getTableNavigateListeners, getVisibleColumnAt, getVisibleColumnByName, getVisibleColumnCount, getVisibleColumns, getVisibleTableData, getVisibleTableDataCount, getVisibleTableDataFilters, getVisibleTableDataFilters, hasCellAt, hasTableData, hasVisibleTableDataFilter, invalidate, isHeaderHTML, isNavigateSupported, isOnlyEvaluateVisibleColumns, isSubHeaderHTML, isValid, isVisible, isVisibleColumn, navigate, navigate, reload, removeParent, removeTableClonedListener, removeTableContentListener, removeTableData, removeTableData, removeTableData, removeTableGroupedListener, removeTableListener, removeTableNavigateListener, removeVisibleTableDataFilter, removeVisibleTableDataFilters, setHeader, setHeader, setOnlyEvaluateVisibleColumns, setParent, setSubHeader, setSubHeader, validate

Methods inherited from interface com.technia.tvc.core.gui.view.ViewSupport

getChoosableViews, getView, getViewFactory, isTableChangeable, isViewChangeable, isVisualsChangeable, setChoosableViews, setView, setView, setViewFactory

Methods inherited from interface com.technia.tvc.core.gui.menubar.MenuBarSupport

getMenuBar, setMenuBar

Methods inherited from interface com.technia.tvc.core.gui.menubar.ContextMenuSupport

getContextMenu, setContextMenu

Methods inherited from interface com.technia.tvc.core.db.inquiry.InquirySupport

isInquirySupported, loadFromInquiry, loadFromInquiry

Methods inherited from interface com.technia.tvc.core.db.jpo.JPOSupport

loadFromJPO, loadFromJPO

Methods inherited from interface com.technia.tvc.core.db.aef.env.EnvironmentSupport

getEnv, getEnv, setEnv

Methods inherited from interface com.technia.tvc.core.util.AttributeSupport

getAttribute, getAttributeNames, removeAttribute, setAttribute

Methods inherited from interface com.technia.tvc.core.gui.page.PageConfigSupport

getPageConfig, setPageConfig

Method Detail

addRoot

void addRoot(java.lang.String rootObjectId)
             throws TVCException

Add a new root object to the structure.

Parameters:

rootObjectId - The object ID of the root object.

Throws:

TVCException - If unable to add a root object.

addRoot

StructureBeanNode addRoot(java.lang.String connectionId,
                        java.lang.String rootObjectId)
                          throws TVCException

Adds a new root object to the structure. The root object can be associated with a connection-id.

Parameters:

connectionId - The id of the connection

rootObjectId - The id of the root object.

Returns:

The new created node.

Throws:

TVCException - If unable to add the root object.

Since:

6.4.0

changeRootNode

void changeRootNode(StructureBeanNode rootNode,
                  int i)
                    throws TVCException

Changes the root node at the specified index.

Throws:

java.lang.IndexOutOfBoundsException - If the structure doesn't have a root node at the specified index.

TVCException

removeRoot

boolean removeRoot(java.lang.String rootObjectId)

Removes all root nodes with the specified object ID.

removeRootNode

boolean removeRootNode(StructureBeanNode root)

Removes the specified root node.

clearRootNodes

void clearRootNodes()

Removes all root nodes.

getRootCount

int getRootCount()

Returns the root node count.

getRootNodes

java.util.Iterator<StructureBeanNode> getRootNodes()

Returns the root nodes.

getFilteredRootNodes

java.util.Iterator<StructureBeanNode> getFilteredRootNodes(TableDataFilter filter)

Returns the root nodes that are accepted by the specified filter.

getRootNodeAt

StructureBeanNode getRootNodeAt(int i)

Returns the root node at the specified index.

isRootNode

boolean isRootNode(StructureBeanNode node)

Returns whether the specified node is a root node in this structure.

isRootInquirySupported

boolean isRootInquirySupported(com.technia.tvc.core.db.inquiry.Inquiry inquiry)

Returns whether the specified inquiry can be used to load root nodes.

loadRootsFromInquiry

void loadRootsFromInquiry(com.technia.tvc.core.db.inquiry.Inquiry inquiry,
                        Environment env)
                          throws TVCException

Load the root nodes from the specified inquiry. Current root nodes will be removed.

Throws:

TVCException

loadRootsFromInquiry

void loadRootsFromInquiry(com.technia.tvc.core.db.inquiry.Inquiry inquiry,
                        Environment env,
                        boolean append)
                          throws TVCException

Load the root nodes from the specified inquiry.

Throws:

TVCException

getRootInquirySupport

com.technia.tvc.core.db.inquiry.InquirySupport getRootInquirySupport()

Get an InquirySupport instance that can be used to load root nodes into the structure.

loadRootsFromJPO

void loadRootsFromJPO(JPOName name,
                    Environment env)
                      throws TVCException

Load the root nodes from the specified JPO. Current root nodes will be removed.

Throws:

TVCException

loadRootsFromJPO

void loadRootsFromJPO(JPOName name,
                    Environment env,
                    boolean append)
                      throws TVCException

Load the root nodes from the specified JPO.

Throws:

TVCException

getRootJPOSupport

com.technia.tvc.core.db.jpo.JPOSupport getRootJPOSupport()

Get an JPOSupport instance that can be used to load root nodes into the structure.

isRootNodesNavigable

boolean isRootNodesNavigable()

Returns:

Returns whether root nodes should be navigable.

Since:

6.0.0