com.technia.tvc.core.structure

Interface StructureBean

All Superinterfaces:

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

All Known Subinterfaces:

CompositeStructureBean, GroupStructureBean, StructureBeanWithModel

All Known Implementing Classes:

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

public interface StructureBean
extends TableBean<StructureBeanNode>

This interface defines a table where TableData instances are stored in a structure.

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

Modifier and Type	Method and Description
void	accept(StructureBeanNodeVisitor visitor) Visit all nodes on this StructureBean.
StructureBeanNode	addNode(StructureBeanNode parentNode, java.lang.String relationshipId, java.lang.String objectId, boolean from, int index) Adds a new node as a child to the given node.
void	addStructureListener(StructureListener listener) Adds a listener to the structure.
void	changeRootNode(StructureBeanNode rootNode) Changes the root node.
void	collapse() Collapse the root node.
void	collapseNode(StructureBeanNode node) Collapse the node.
int	expand() Expands the root node one level.
int	expand(int depth) Expands the root node.
int	expandFully() Fully expands the root node.
int	expandNode(StructureBeanNode node) Expands the specified node one level.
int	expandNode(StructureBeanNode node, int level) Expands the specified node.
int	expandNodeFully(StructureBeanNode node) Fully expands the node.
boolean	getAllowInconsistentVisibleStructure() Returns whether the structure should allow inconsistency among it's visible nodes, i.e., if a node can be visible even though it's parent is not.
int	getInitialExpandDepth() Returns the initial expand depth.
ExpansionMode	getInitialExpandMode() Returns the mode used when performing an initial expand on the structure.
int	getMultiLevelExpandDepth() Returns the multi-level expand depth.
StructureBeanNode	getNodeAt(int index) Returns the node at the specified index.
int	getNodeCount() Returns the node count.
java.util.Iterator<StructureBeanNode>	getNodes() Returns the nodes in the structure.
java.util.Iterator<StructureBeanNode>	getNodes(java.lang.String objectId) Returns all nodes in the structure with the specified object ID.
java.util.Iterator<StructureBeanNode>	getNodes(java.lang.String relationshipId, java.lang.String objectId) Returns all nodes in the structure with the specified object and relationship ID.
StructureBeanNode	getRootNode() Returns the root node.
StructureBeanNode	getVisibleChildAt(StructureBeanNode node, int index) Returns the visible child node at the specified index.
int	getVisibleChildCount(StructureBeanNode node) Returns the visible child count.
int	getVisibleChildIndex(StructureBeanNode node, StructureBeanNode child) Returns the index of the specified visible child, or -1 if the child in fact isn't a visible child to the specified node.
java.util.Iterator<StructureBeanNode>	getVisibleChildNodes(StructureBeanNode node) Returns all visible child nodes.
boolean	hasNodes() Returns whether the structure has any nodes at all.
boolean	hasVisibleChildren(StructureBeanNode node) Returns true if the node has any visible children.
boolean	isAllowHideSingleRootNode()
boolean	isFiltersCombinable() Returns a boolean value indicating whether the filters can be combined, e.g.
boolean	isFirstVisibleChild(StructureBeanNode node, StructureBeanNode child) Returns true if the child is the specified node's first visible child.
boolean	isFullExpandSupported() Returns whether a full expand is supported by the structure in it's current state.
boolean	isLastVisibleChild(StructureBeanNode node, StructureBeanNode child) Returns true if the child is the specified node's last visible child.
boolean	isMultiLevelExpandSupported() Returns whether multi-level expand is supported by the structure in it's current state, or not.
boolean	isToFlatTableSupported() Check whether this StructureBean can be converted to a FlatTableBean.
boolean	isVisibleChild(StructureBeanNode node, StructureBeanNode child) Returns true if the specified node is a visible child to the specified node.
boolean	removeNode(StructureBeanNode node) Removes the node from the structure.
void	removeNodes(java.lang.String objectId) Removes all nodes with the specified object ID.
void	removeNodes(java.lang.String relationshipId, java.lang.String objectId) Removes all nodes with the specified object and relationship ID.
void	removeStructureListener(StructureListener listener) Removes a listener from the structure.
void	setAllowHideSingleRootNode(boolean value)
void	setAllowInconsistentVisibleStructure(boolean b) Sets whether the structure should allow inconsistency among it's visible nodes, i.e., if a node can be visible even though it's parent is not.
void	setInitialExpandDepth(int depth) Sets the initial expand depth (i.e., the number of levels to expand the root node the first time).
void	setInitialExpandMode(ExpansionMode mode) Sets the mode used when performing an initial expand on the structure.
void	setMultiLevelExpandDepth(int depth) Sets the multi-level expand depth (i.e., the number of levels to expand a node when the used requests that a multi-level expansion is performed on a particular node).
StructureBeanNode	setRoot(java.lang.String rootObjectId) Sets the root object in the structure.
StructureBeanNode	setRoot(java.lang.String rootRelationshipId, java.lang.String rootObjectId)
FlatTableBean	toFlatTable() Converts the StructureBean to a FlatTableBean.

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

setRoot

StructureBeanNode setRoot(java.lang.String rootObjectId)
                   throws TVCException

Sets the root object in the structure.

Parameters:

rootObjectId - The object ID of the root object.

Returns:

The created root node

Throws:

TVCException - If unable to set the root object.

setRoot

StructureBeanNode setRoot(java.lang.String rootRelationshipId,
                          java.lang.String rootObjectId)
                   throws TVCException

Parameters:

rootRelationshipId - - The relationship ID of the root object.

rootObjectId - - The object ID of the root object.

Returns:

The created root node

Throws:

TVCException - If unable to set the root object.

Since:

2014.1.0

changeRootNode

void changeRootNode(StructureBeanNode rootNode)
             throws TVCException

Changes the root node.

Throws:

java.lang.IllegalStateException - If the structure doesn't have a root node.

TVCException

Since:

4.0

setInitialExpandDepth

void setInitialExpandDepth(int depth)

Sets the initial expand depth (i.e., the number of levels to expand the root node the first time).

See Also:

getInitialExpandDepth()

getInitialExpandDepth

int getInitialExpandDepth()

Returns the initial expand depth.

See Also:

setInitialExpandDepth(int)

setInitialExpandMode

void setInitialExpandMode(ExpansionMode mode)

Sets the mode used when performing an initial expand on the structure.

Since:

4.1.0

getInitialExpandMode

ExpansionMode getInitialExpandMode()

Returns the mode used when performing an initial expand on the structure.

Since:

4.1.0

isMultiLevelExpandSupported

boolean isMultiLevelExpandSupported()

Returns whether multi-level expand is supported by the structure in it's current state, or not.

See Also:

setMultiLevelExpandDepth(int), getMultiLevelExpandDepth()

setMultiLevelExpandDepth

void setMultiLevelExpandDepth(int depth)

Sets the multi-level expand depth (i.e., the number of levels to expand a node when the used requests that a multi-level expansion is performed on a particular node).

See Also:

isMultiLevelExpandSupported(), getMultiLevelExpandDepth()

getMultiLevelExpandDepth

int getMultiLevelExpandDepth()

Returns the multi-level expand depth.

See Also:

isMultiLevelExpandSupported(), setMultiLevelExpandDepth(int)

isFullExpandSupported

boolean isFullExpandSupported()

Returns whether a full expand is supported by the structure in it's current state.

See Also:

expandFully(), expandNodeFully(StructureBeanNode)

addNode

StructureBeanNode addNode(StructureBeanNode parentNode,
                          java.lang.String relationshipId,
                          java.lang.String objectId,
                          boolean from,
                          int index)
                   throws TVCException

Adds a new node as a child to the given node.

Parameters:

parentNode - The parent node, to which the new node is added

relationshipId - The relationship id

objectId - The object id of the new node

from - True for from direction (e.g. parentNode -> newNode)

index - The index within the child array (0 for first)

Returns:

The new added node

Throws:

TVCException - Upon errors

Since:

4.1.0

expand

int expand()
    throws TVCException

Expands the root node one level.

Returns:

The number of nodes added to the structure.

Throws:

TVCException

expand

int expand(int depth)
    throws TVCException

Expands the root node.

Parameters:

depth - The number of levels to expand.

Returns:

The number of nodes added to the structure.

Throws:

TVCException

expandFully

int expandFully()
         throws TVCException

Fully expands the root node.

Returns:

The number of nodes added to the structure.

Throws:

TVCException

See Also:

isFullExpandSupported(), expandNodeFully(StructureBeanNode)

collapse

void collapse()
       throws TVCException

Collapse the root node.

Throws:

TVCException

expandNode

int expandNode(StructureBeanNode node)
        throws TVCException

Expands the specified node one level.

Parameters:

node - The node to expand.

Returns:

The number of nodes added to the structure.

Throws:

TVCException

See Also:

expandNode(StructureBeanNode,int), expandNodeFully(StructureBeanNode)

expandNode

int expandNode(StructureBeanNode node,
               int level)
        throws TVCException

Expands the specified node.

Parameters:

node - The node to expand.

level - The number of levels to expand the node.

Returns:

The number of nodes added to the structure.

Throws:

TVCException

See Also:

expandNode(StructureBeanNode), expandNodeFully(StructureBeanNode)

expandNodeFully

int expandNodeFully(StructureBeanNode node)
             throws TVCException

Fully expands the node.

Parameters:

node - The node to expand.

Returns:

The number of nodes added to the structure.

Throws:

TVCException

See Also:

expandNode(StructureBeanNode), expandNode(StructureBeanNode,int)

collapseNode

void collapseNode(StructureBeanNode node)
           throws TVCException

Collapse the node.

Parameters:

node - The node to collapse.

Throws:

TVCException

getRootNode

StructureBeanNode getRootNode()

Returns the root node.

getNodes

java.util.Iterator<StructureBeanNode> getNodes()

Returns the nodes in the structure.

getNodes

java.util.Iterator<StructureBeanNode> getNodes(java.lang.String objectId)

Returns all nodes in the structure with the specified object ID. Note that ALL nodes will be returned if the argument is null.

getNodes

java.util.Iterator<StructureBeanNode> getNodes(java.lang.String relationshipId,
                                               java.lang.String objectId)

Returns all nodes in the structure with the specified object and relationship ID. Note that ALL nodes will be returned if both arguments are null.

removeNode

boolean removeNode(StructureBeanNode node)

Removes the node from the structure. Note that it is impossible to remove the root node this way.

Returns:

Whether the node was removed or not.

removeNodes

void removeNodes(java.lang.String objectId)

Removes all nodes with the specified object ID. Note that ALL nodes except the root will be removed is the argument is null.

removeNodes

void removeNodes(java.lang.String relationshipId,
                 java.lang.String objectId)

Removes all nodes with the specified object and relationship ID. Note that ALL except the root nodes will be removed if both arguments are null.

getNodeAt

StructureBeanNode getNodeAt(int index)

Returns the node at the specified index.

Throws:

java.lang.IndexOutOfBoundsException - If the index is invalid.

getNodeCount

int getNodeCount()

Returns the node count.

hasNodes

boolean hasNodes()

Returns whether the structure has any nodes at all.

isVisibleChild

boolean isVisibleChild(StructureBeanNode node,
                       StructureBeanNode child)

Returns true if the specified node is a visible child to the specified node.

Since:

4.1.0

isFirstVisibleChild

boolean isFirstVisibleChild(StructureBeanNode node,
                            StructureBeanNode child)

Returns true if the child is the specified node's first visible child.

Since:

4.1.0

isLastVisibleChild

boolean isLastVisibleChild(StructureBeanNode node,
                           StructureBeanNode child)

Returns true if the child is the specified node's last visible child.

Since:

4.1.0

getVisibleChildAt

StructureBeanNode getVisibleChildAt(StructureBeanNode node,
                                    int index)

Returns the visible child node at the specified index.

Since:

4.1.0

getVisibleChildIndex

int getVisibleChildIndex(StructureBeanNode node,
                         StructureBeanNode child)

Returns the index of the specified visible child, or -1 if the child in fact isn't a visible child to the specified node.

Since:

4.1.0

getVisibleChildNodes

java.util.Iterator<StructureBeanNode> getVisibleChildNodes(StructureBeanNode node)

Returns all visible child nodes.

Since:

4.1.0

getVisibleChildCount

int getVisibleChildCount(StructureBeanNode node)

Returns the visible child count.

Since:

4.1.0

hasVisibleChildren

boolean hasVisibleChildren(StructureBeanNode node)

Returns true if the node has any visible children.

Since:

4.1.0

addStructureListener

void addStructureListener(StructureListener listener)

Adds a listener to the structure.

removeStructureListener

void removeStructureListener(StructureListener listener)

Removes a listener from the structure.

getAllowInconsistentVisibleStructure

boolean getAllowInconsistentVisibleStructure()

Returns whether the structure should allow inconsistency among it's visible nodes, i.e., if a node can be visible even though it's parent is not. Inconsistency is NOT allowed by default.

Since:

4.1.0

See Also:

setAllowInconsistentVisibleStructure(boolean), TableBean.getVisibleTableData()

setAllowInconsistentVisibleStructure

void setAllowInconsistentVisibleStructure(boolean b)

Sets whether the structure should allow inconsistency among it's visible nodes, i.e., if a node can be visible even though it's parent is not. Inconsistency is NOT allowed by default.

Parameters:

b - Allow inconsistency.

Since:

4.1.0

See Also:

getAllowInconsistentVisibleStructure(), TableBean.getVisibleTableData()

toFlatTable

FlatTableBean toFlatTable()
                   throws TVCException

Converts the StructureBean to a FlatTableBean.

Returns:

Returns the StructureBean as a flat table, i.e., containing the same rows but with the structure information erased.

Throws:

TVCException - If unable to convert the StructureBean into a flat table.

java.lang.UnsupportedOperationException - If this method is not supported.

Since:

6.1.5

See Also:

isToFlatTableSupported()

isToFlatTableSupported

boolean isToFlatTableSupported()

Check whether this StructureBean can be converted to a FlatTableBean.

Returns:

Returns true if toFlatTable() is supported.

Since:

6.1.5

See Also:

toFlatTable()

accept

void accept(StructureBeanNodeVisitor visitor)

Visit all nodes on this StructureBean.

Parameters:

visitor - The visitor.

Since:

6.3.3

isFiltersCombinable

boolean isFiltersCombinable()

Returns a boolean value indicating whether the filters can be combined, e.g. multiple filters could be selected. Consider this property to be a hint to the interface

Returns:

a boolean value indicating whether the filters could be combined.

setAllowHideSingleRootNode

void setAllowHideSingleRootNode(boolean value)

isAllowHideSingleRootNode

boolean isAllowHideSingleRootNode()