com.technia.tvc.core.structure

Class AbstractStructureBean

java.lang.Object

com.technia.tvc.core.util.BasicAttributeSupport

com.technia.tvc.core.table.AbstractTableBean<T>

com.technia.tvc.core.table.AbstractPaginatedTableBean<T>

com.technia.tvc.core.table.AbstractSelectionTableBean<T>

com.technia.tvc.core.table.AbstractEditableTableBean<T>

com.technia.tvc.core.table.AbstractSortableTableBean<StructureBeanNode>

com.technia.tvc.core.structure.AbstractStructureBean

All Implemented Interfaces:

EnvironmentSupport, com.technia.tvc.core.db.inquiry.InquirySupport, com.technia.tvc.core.db.jpo.JPOSupport, ContextMenuSupport, MenuBarSupport, PageConfigSupport, ViewSupport, CompositeStructureBean, StructureBean, EditableTableBean<StructureBeanNode>, EntryProcessable, com.technia.tvc.core.table.EvaluatedTableBean<StructureBeanNode>, GroupableTableBean<StructureBeanNode>, PaginatedTableBean<StructureBeanNode>, SelectionTableBean<StructureBeanNode>, SortableTableBean<StructureBeanNode>, StructureModifiableTableBean<StructureBeanNode>, TableBean<StructureBeanNode>, TableBeanProxy, TableDataProvider<StructureBeanNode>, AttributeSupport, java.lang.Cloneable

Direct Known Subclasses:

ExpanderBasedStructureBean

public abstract class AbstractStructureBean
extends AbstractSortableTableBean<StructureBeanNode>
implements CompositeStructureBean, StructureBean

Abstract implementation of the CompositeStructureBean (and StructureBean) interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractStructureBean.ConsistentNodeIterator An iterator that iterates through nodes in a consistent manner, i.e., if a certain node rejected by the filter it's children will also be rejected automatically.
protected class	AbstractStructureBean.StructureBeanNodeIterator Iterator implementation that iterates through the nodes in the structure.

Nested classes/interfaces inherited from class com.technia.tvc.core.table.AbstractSortableTableBean

AbstractSortableTableBean.ForcedColumnsParams, AbstractSortableTableBean.SortInfo

Nested classes/interfaces inherited from class com.technia.tvc.core.table.AbstractEditableTableBean

AbstractEditableTableBean.CellUpdaterTableClient, AbstractEditableTableBean.CommitResultImpl, AbstractEditableTableBean.ConnectResultImpl, AbstractEditableTableBean.DeleteResultImpl, AbstractEditableTableBean.DisconnectResultImpl, AbstractEditableTableBean.ObjectResultImpl, AbstractEditableTableBean.RemoveResultImpl, AbstractEditableTableBean.ReplaceResultImpl, AbstractEditableTableBean.UpdateResultImpl

Nested classes/interfaces inherited from class com.technia.tvc.core.table.AbstractPaginatedTableBean

AbstractPaginatedTableBean.CurrentPageEvaluationParams, AbstractPaginatedTableBean.TablePage

Nested classes/interfaces inherited from class com.technia.tvc.core.table.AbstractTableBean

AbstractTableBean.DefaultNavigationHandler, AbstractTableBean.TableClientImpl, AbstractTableBean.TableDataIterator, AbstractTableBean.ViewListenerProxy

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>

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

StructureModifiableTableBean.CallBack, StructureModifiableTableBean.CommitResult, StructureModifiableTableBean.CommitResults, StructureModifiableTableBean.ConnectResult, StructureModifiableTableBean.ConnectSpec, StructureModifiableTableBean.DeleteResult, StructureModifiableTableBean.DisconnectResult, StructureModifiableTableBean.ReplaceResult, StructureModifiableTableBean.ReplaceSpec, StructureModifiableTableBean.UpdateResult

Field Summary

Fields

Modifier and Type	Field and Description
static TableDataFilter	STRUCTURE_INVALID_TABLE_DATA_FILTER Filter that will accept all nodes whose structure is considered to be invalid.

Fields inherited from class com.technia.tvc.core.table.AbstractEditableTableBean

editable, editSupported, structureModificationSupported

Fields inherited from class com.technia.tvc.core.table.AbstractTableBean

DEFAULT_VISIBLE_TABLE_DATA_FILTER, EVALUATION_REQUIRED_TABLE_DATA_FILTER, SELECTED_TABLE_DATA_FILTER

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

EMPTY

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

MODE_ASCENDING, MODE_DESCENDING, MODE_NOT_SORTED

Constructor Summary

Constructors

Constructor and Description
AbstractStructureBean() Default constructor.

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	addRoot(java.lang.String rootObjectId) Add a new root object to the structure.
StructureBeanNode	addRoot(java.lang.String relId, java.lang.String objectId) Add a new root object to the structure.
void	addStructureListener(StructureListener listener) Adds a StructureListener to the structure.
void	changeRootNode(StructureBeanNode rootNode) Changes the root node.
void	changeRootNode(StructureBeanNode rootNode, int i) Changes the root node at the specified index.
void	clearRootNodes() Removes all root nodes.
void	collapse() Collapse the root nodes.
void	collapseNode(StructureBeanNode node) Collapse the node.
protected int	countVisibleChildNodes(StructureBeanNode node) Counts the visible nodes benieth the given node.
protected abstract StructureBeanNode	createRootNode(java.lang.String rootObjectId) Creates a root node with the specified object ID.
protected abstract StructureBeanNode	createStructureNode(java.lang.String relationshipId, java.lang.String objectId, boolean from) Creates a node with the specified relationship ID, object ID and direction.
protected java.util.Comparator<StructureBeanNode>	createTableDataComparator()
protected abstract void	doCollapseNode(StructureBeanNode node) Override this method to collapse a node.
protected abstract void	doExpandNode(StructureBeanNode node, int levels) Override this method to expand a node.
int	expand() Expands the root nodes one level.
int	expand(int level) Expands the root nodes.
int	expandFully() Fully expands the root nodes.
int	expandNode(StructureBeanNode node) Expands the specified node one level.
int	expandNode(StructureBeanNode node, int levels) Expands the specified node.
int	expandNodeFully(StructureBeanNode node) Fully expands the node.
protected void	fireStructureCollapseEvent(StructureBeanNode node) Fires a node collapsed event.
protected void	fireStructureExpandEvent(StructureBeanNode node) Fires a node expanded event.
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.
boolean	getCollapseOnFilterChange()
protected java.util.Iterator<StructureBeanNode>	getConsistentVisibleTableData() This method will always return a consistent visible structure, i.e., nodes will not be visible unless their parent is visible.
java.util.Iterator<StructureBeanNode>	getFilteredRootNodes(TableDataFilter filter) Returns the root nodes that are accepted by the specified filter.
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.
protected java.lang.String	getObjectIdForHeaders()
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	getRootNode() Returns the first root node.
StructureBeanNode	getRootNodeAt(int i) Returns the root node at the specified index.
java.util.Iterator<StructureBeanNode>	getRootNodes() Returns the root nodes.
protected StructureListener[]	getStructureListeners()
java.util.Iterator<StructureBeanNode>	getTableData() Returns all StructureBeanNode instances currently in the structure.
TableData	getTableDataAt(int index) Returns the TableData instance at the specified index.
int	getTableDataCount() Returns the count of all StructureBeanNode instances in the table.
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.
java.util.Iterator<StructureBeanNode>	getVisibleRootNodes()
java.util.Iterator<StructureBeanNode>	getVisibleTableData() Returns the visible nodes in the structure.
boolean	hasNodes() Returns whether the structure has any nodes at all.
boolean	hasTableData() Returns true if the structure contains any StructureBeanNode instances.
boolean	hasVisibleChildren(StructureBeanNode node) Returns true if the node has any visible children.
protected void	invalidateRootNodes() Invalidates the structure on all root nodes.
boolean	isAllowHideSingleRootNode()
static boolean	isDefaultCollapseOnFilterChange()
boolean	isFiltersCombinable() This method returns true.
boolean	isFirstVisibleChild(StructureBeanNode node, StructureBeanNode child) Returns true if the child is the specified node's first visible child.
boolean	isInquirySupported(com.technia.tvc.core.db.inquiry.Inquiry inquiry) Returns whether the inquiry is supported or not.
boolean	isLastVisibleChild(StructureBeanNode node, StructureBeanNode child) Returns true if the child is the specified node's last visible child.
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()
boolean	isToFlatTableSupported() Check whether this StructureBean can be converted to a FlatTableBean.
boolean	isValid() Returns whether the structure is valid or not (i.e., whether it requires a validation or not).
boolean	isVisibleChild(StructureBeanNode node, StructureBeanNode child) Returns true if the specified node is a visible child to the specified node.
void	loadFromInquiry(com.technia.tvc.core.db.inquiry.Inquiry inquiry, Environment env, boolean append) Evaluates the inquiry into the structure.
void	loadFromJPO(JPOName name, Environment env, boolean append) It's currently not supported to load the structure from a JPO.
protected void	loadIntoNode(StructureBeanNode into, com.technia.tvc.core.db.inquiry.StructureResult.Node source) Loads the result of the inquiry into the structure.
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.
protected void	onClone(TableBean<StructureBeanNode> c) Create a deep copy of this object.
protected void	onNavigate(TableBean<? extends TableData> table, java.lang.String objectId) Initialize the StructureBean when navigating.
protected void	onViewChanged() Invoked when the table's view changes.
protected void	onVisualsChanged() Invoked when the view's filters changes.
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.
boolean	removeRoot(java.lang.String rootObjectId) Removes all root nodes with the specified object ID.
boolean	removeRootNode(StructureBeanNode root) Removes the specified root node.
void	removeStructureListener(StructureListener listener) Removes a StructureListener from the structure.
void	removeTableData(TableData data) Removed the specified TableData 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	setCollapseOnFilterChange(boolean collapseOnFilterChange) Defines the behavior of this structure when the visuals is being changed.
static void	setExpanded(StructureBeanNode node, int level) Sets the expanded flag on all nodes below the specified until the specified level has been reached.
void	setInitialExpandDepth(int initialExpandDepth) 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 multiLevelExpandDepth) 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) Sets the root object in the structure.
void	sort(Environment env) Sorts the structure according to the current sort modes.
protected void	sortImpl(StructureBeanNode node, java.util.Comparator<StructureBeanNode> comparator) Implementation of sort.
FlatTableBean	toFlatTable() Converts the StructureBean to a FlatTableBean.
void	validate(Environment env) Validates the structure.

Methods inherited from class com.technia.tvc.core.table.AbstractSortableTableBean

addSortMode, addSortMode, clearSortModes, createEvaluationChain, fireColumnsUpdatedEvent, getModeForString, getSortMode, getSortMode, getSortOrder, getSortOrderByName, hasSortModes, initDefault, invalidateSort, isAnySorted, isEvaluationForcedFor, isSorted, isSorted, isSorted, isSortSupported, isValidSort, onColumnsUpdated, onTableChanged, onTableSorted, setSortMode, setSortMode, setSortSupported, sortIfRequired, validateSort

Methods inherited from class com.technia.tvc.core.table.AbstractEditableTableBean

addTableEditListenerListener, afterConnect, afterDisconnect, afterEdit, afterEdit, connect, createConnectResult, createDisconnectResult, createReplaceResult, disconnect, editCell, editCells, fireWasEditedEvent, fireWasEditedEvent, getReuseCellsForEditEvaluation, getTableEditListeners, isEditable, isEditSupported, isStructureModificationSupported, performConnect, performDisconnect, performReplace, removeTableEditListener, replace, setEditable, setEditSupported, setStructureModificationSupported, validate, validateSpec

Methods inherited from class com.technia.tvc.core.table.AbstractSelectionTableBean

addSelectionListener, createDefaultSelectionModel, getSelectionModel, removeSelectionListener, selectableChanged, selectionChanged, setSelectionModel

Methods inherited from class com.technia.tvc.core.table.AbstractPaginatedTableBean

addPaginationChangeListener, asNonPaginatedTable, evaluateColumns, firePaginationChanged, getCurrentPage, getDisplayedTableData, getPageCount, getPageTableData, getPageTableDataRange, getPaginationThreshold, getUnpaginatedTableData, getUnpaginatedTableDataCount, isOnlyEvaluateCurrentPage, isPaginated, isPaginationForced, isPaginationSupported, isProxyInvokation, removePaginationChangeListener, setCurrentPage, setOnlyEvaluateCurrentPage, setPageTableDataRange, setPaginated, setPaginationSupported, setPaginationThreshold

Methods inherited from class com.technia.tvc.core.table.AbstractTableBean

accept, addEntryProcessor, addTableClonedListener, addTableContentListener, addTableGroupedListener, addTableListener, addTableNavigateListener, addVisibleTableDataFilter, clearEntryProcessor, clearRows, clearRowsBeforeEvaluation, clearVisibleTableDataFilter, clone, createNavigationHandler, createNavigationHandler, createTableClient, createTableHeaders, ensureTable, ensureView, evaluate, evaluateColumns, fireDidNavigateEvent, fireTableChangedEvent, fireTableContentAdded, fireTableContentCleared, fireTableContentRemoved, fireTableEvaluatedEvent, fireTableInvalidatedEvent, fireTableSortedEvent, fireViewChangedEvent, fireVisualsChangedEvent, fireWasClonedEvent, fireWasGroupedEvent, getCalculations, getCellAt, getChoosableViews, getColumnAt, getColumnByName, getColumnCount, getColumnIndex, getColumnList, getColumns, getContextMenu, getDisplayedTableDataCount, getEntryProcessor, getEntryProcessors, getEnv, getEnv, getEvaluationChain, getEvaluationRequiredTableData, getEvaluationRequiredTableDataCount, getFilteredTableData, getFilteredTableDataCount, getHasParent, getHeader, getLocaleForHeaders, getMenuBar, getMode, getNavigationHandler, getNavigationHandler, getPageConfig, getParent, getSelectedTableData, getSelectedTableDataCount, getSubHeader, getTableClonedListeners, getTableContentListeners, getTableData, getTableData, getTableDataWithId, getTableGroupedListeners, getTableListeners, getTableNavigateListeners, getView, getViewFactory, getVisibleColumnAt, getVisibleColumnByName, getVisibleColumnCount, getVisibleColumns, getVisibleTableDataCount, getVisibleTableDataFilters, getVisibleTableDataFilters, group, hasCellAt, hasEvaluationForcedColumns, hasVisibleTableDataFilter, invalidate, invalidateTableData, isColumnsLoaded, isEvaluateReadOnly, isEvaluationRequired, isHeaderHTML, isNavigateSupported, isOnlyEvaluateVisibleColumns, isSubHeaderHTML, isTableChangeable, isViewChangeable, isVisible, isVisibleColumn, isVisibleColumnImpl, isVisualsChangeable, loadFromInquiry, loadFromJPO, navigate, navigate, onGroup, onTableEvaluated, onTableInvalidated, paramString, reload, removeEntryProcessor, removeParent, removeTableClonedListener, removeTableContentListener, removeTableData, removeTableData, removeTableGroupedListener, removeTableListener, removeTableNavigateListener, removeVisibleTableDataFilter, removeVisibleTableDataFilters, setChoosableViews, setContextMenu, setEntryProcessor, setEntryProcessors, setEnv, setEvaluateReadOnly, setHeader, setHeader, setMenuBar, setNavigateSupported, setOnlyEvaluateVisibleColumns, setPageConfig, setParent, setSubHeader, setSubHeader, setTableChangeable, setView, setView, setViewChangeable, setViewFactory, setVisualsChangeable, toString

Methods inherited from class com.technia.tvc.core.util.BasicAttributeSupport

getAttribute, getAttributeMap, getAttributeNames, removeAttribute, setAttribute

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

isFullExpandSupported, isMultiLevelExpandSupported

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, getTableDataWithId, getTableGroupedListeners, getTableListeners, getTableNavigateListeners, getVisibleColumnAt, getVisibleColumnByName, getVisibleColumnCount, getVisibleColumns, getVisibleTableDataCount, getVisibleTableDataFilters, getVisibleTableDataFilters, hasCellAt, hasVisibleTableDataFilter, invalidate, isHeaderHTML, isNavigateSupported, isOnlyEvaluateVisibleColumns, isSubHeaderHTML, isVisible, isVisibleColumn, navigate, navigate, reload, removeParent, removeTableClonedListener, removeTableContentListener, removeTableData, removeTableData, removeTableGroupedListener, removeTableListener, removeTableNavigateListener, removeVisibleTableDataFilter, removeVisibleTableDataFilters, setHeader, setHeader, setOnlyEvaluateVisibleColumns, setParent, setSubHeader, setSubHeader

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

loadFromInquiry

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

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

Field Detail

STRUCTURE_INVALID_TABLE_DATA_FILTER

public static final TableDataFilter STRUCTURE_INVALID_TABLE_DATA_FILTER

Filter that will accept all nodes whose structure is considered to be invalid.

Constructor Detail

AbstractStructureBean

public AbstractStructureBean()

Default constructor.

Method Detail

isAllowHideSingleRootNode

public boolean isAllowHideSingleRootNode()

Specified by:

isAllowHideSingleRootNode in interface StructureBean

setAllowHideSingleRootNode

public void setAllowHideSingleRootNode(boolean value)

Specified by:

setAllowHideSingleRootNode in interface StructureBean

getObjectIdForHeaders

protected java.lang.String getObjectIdForHeaders()

Overrides:

getObjectIdForHeaders in class AbstractTableBean<StructureBeanNode>

Returns:

Returns the object id used when parsing headers.

setCollapseOnFilterChange

public void setCollapseOnFilterChange(boolean collapseOnFilterChange)

Defines the behavior of this structure when the visuals is being changed. The default value of this property, is taken from the system parameter ( TVCSystemProperties#STRUCTURE_COLLAPSE_ROOTNODES_ON_FILTERCHANGE.

Parameters:

collapseOnFilterChange - A boolean indicating if the nodes should be collapsed when the visuals/filters are changed.

Since:

5.2.1

getCollapseOnFilterChange

public boolean getCollapseOnFilterChange()

Returns:

Whether or not the structure should be collapsed when the visuals is being changed

Since:

5.2.1

isDefaultCollapseOnFilterChange

public static boolean isDefaultCollapseOnFilterChange()

getAllowInconsistentVisibleStructure

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

Specified by:

getAllowInconsistentVisibleStructure in interface StructureBean

Since:

4.1.0

See Also:

setAllowInconsistentVisibleStructure(boolean), getVisibleTableData(), getConsistentVisibleTableData()

setAllowInconsistentVisibleStructure

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

Specified by:

setAllowInconsistentVisibleStructure in interface StructureBean

Parameters:

b - Allow inconsistency.

Since:

4.1.0

See Also:

getAllowInconsistentVisibleStructure(), getVisibleTableData(), getConsistentVisibleTableData()

getVisibleTableData

public java.util.Iterator<StructureBeanNode> getVisibleTableData()

Returns the visible nodes in the structure. Use setAllowInconsistentVisibleStructure(boolean) to configure whether the structure should allow inconsistency among the returned nodes.

Specified by:

getVisibleTableData in interface TableBean<StructureBeanNode>

Overrides:

getVisibleTableData in class AbstractTableBean<StructureBeanNode>

Returns:

all visible TableData instances.

Since:

4.1.0

See Also:

getAllowInconsistentVisibleStructure(), setAllowInconsistentVisibleStructure(boolean), getConsistentVisibleTableData()

getConsistentVisibleTableData

protected java.util.Iterator<StructureBeanNode> getConsistentVisibleTableData()

This method will always return a consistent visible structure, i.e., nodes will not be visible unless their parent is visible.

Since:

4.1.0

See Also:

getVisibleTableData()

getVisibleRootNodes

public java.util.Iterator<StructureBeanNode> getVisibleRootNodes()

onClone

protected void onClone(TableBean<StructureBeanNode> c)

Create a deep copy of this object.

Overrides:

onClone in class AbstractSortableTableBean<StructureBeanNode>

Since:

4.1.0

validate

public void validate(Environment env)
              throws TVCException

Validates the structure. This implementation will validate the StructureBeanNode instances that requires a validation.

Specified by:

validate in interface TableBean<StructureBeanNode>

Overrides:

validate in class AbstractSortableTableBean<StructureBeanNode>

Parameters:

env - The environment to use.

Throws:

TVCException - If unable to validate the structure.

isValid

public boolean isValid()

Returns whether the structure is valid or not (i.e., whether it requires a validation or not).

Specified by:

isValid in interface TableBean<StructureBeanNode>

Overrides:

isValid in class AbstractSortableTableBean<StructureBeanNode>

Returns:

true if the table is valid.

addNode

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

Specified by:

addNode in interface StructureBean

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

setRoot

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

Sets the root object in the structure.

Specified by:

setRoot in interface StructureBean

Parameters:

rootObjectId - The object ID of the root object.

Returns:

The created root node

Throws:

TVCException - If unable to set the root object.

setRoot

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

Sets the root object in the structure.

Specified by:

setRoot in interface StructureBean

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.

addRoot

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

Add a new root object to the structure.

Specified by:

addRoot in interface CompositeStructureBean

Parameters:

rootObjectId - The object ID of the root object.

Throws:

TVCException - If unable to add a root object.

Since:

4.1.0

addRoot

public StructureBeanNode addRoot(java.lang.String relId,
                                 java.lang.String objectId)
                          throws TVCException

Add a new root object to the structure.

Specified by:

addRoot in interface CompositeStructureBean

Parameters:

relId - The relationship id

objectId - The object ID of the root object.

Returns:

The new created node.

Throws:

TVCException - If unable to add a root object.

Since:

6.4.0

changeRootNode

public void changeRootNode(StructureBeanNode rootNode)
                    throws TVCException

Changes the root node.

Specified by:

changeRootNode in interface StructureBean

Throws:

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

TVCException

Since:

4.0

changeRootNode

public void changeRootNode(StructureBeanNode rootNode,
                           int i)
                    throws TVCException

Changes the root node at the specified index.

Specified by:

changeRootNode in interface CompositeStructureBean

Throws:

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

TVCException

Since:

4.1.0

removeRoot

public boolean removeRoot(java.lang.String rootObjectId)

Removes all root nodes with the specified object ID.

Specified by:

removeRoot in interface CompositeStructureBean

Since:

4.1.0

removeRootNode

public boolean removeRootNode(StructureBeanNode root)

Removes the specified root node.

Specified by:

removeRootNode in interface CompositeStructureBean

Since:

4.1.0

clearRootNodes

public void clearRootNodes()

Removes all root nodes.

Specified by:

clearRootNodes in interface CompositeStructureBean

Since:

4.1.0

getRootCount

public int getRootCount()

Returns the root node count.

Specified by:

getRootCount in interface CompositeStructureBean

Since:

4.1.0

getRootNodes

public java.util.Iterator<StructureBeanNode> getRootNodes()

Returns the root nodes.

Specified by:

getRootNodes in interface CompositeStructureBean

Since:

4.1.0

getFilteredRootNodes

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

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

Specified by:

getFilteredRootNodes in interface CompositeStructureBean

getRootNodeAt

public StructureBeanNode getRootNodeAt(int i)

Returns the root node at the specified index.

Specified by:

getRootNodeAt in interface CompositeStructureBean

Since:

4.1.0

isRootNode

public boolean isRootNode(StructureBeanNode node)

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

Specified by:

isRootNode in interface CompositeStructureBean

Since:

4.1.0

isRootNodesNavigable

public boolean isRootNodesNavigable()

Specified by:

isRootNodesNavigable in interface CompositeStructureBean

Returns:

Returns whether root nodes should be navigable.

setInitialExpandDepth

public void setInitialExpandDepth(int initialExpandDepth)

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

Specified by:

setInitialExpandDepth in interface StructureBean

See Also:

getInitialExpandDepth()

getInitialExpandDepth

public int getInitialExpandDepth()

Returns the initial expand depth.

Specified by:

getInitialExpandDepth in interface StructureBean

See Also:

setInitialExpandDepth(int)

setInitialExpandMode

public void setInitialExpandMode(ExpansionMode mode)

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

Specified by:

setInitialExpandMode in interface StructureBean

Since:

4.1.0

getInitialExpandMode

public ExpansionMode getInitialExpandMode()

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

Specified by:

getInitialExpandMode in interface StructureBean

Since:

4.1.0

setMultiLevelExpandDepth

public void setMultiLevelExpandDepth(int multiLevelExpandDepth)

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

Specified by:

setMultiLevelExpandDepth in interface StructureBean

See Also:

StructureBean.isMultiLevelExpandSupported(), getMultiLevelExpandDepth()

getMultiLevelExpandDepth

public int getMultiLevelExpandDepth()

Returns the multi-level expand depth.

Specified by:

getMultiLevelExpandDepth in interface StructureBean

See Also:

StructureBean.isMultiLevelExpandSupported(), setMultiLevelExpandDepth(int)

expand

public int expand()
           throws TVCException

Expands the root nodes one level.

Specified by:

expand in interface StructureBean

Returns:

The number of nodes added to the structure.

Throws:

TVCException

expand

public int expand(int level)
           throws TVCException

Expands the root nodes.

Specified by:

expand in interface StructureBean

Parameters:

level - The number of levels to expand.

Returns:

The number of nodes added to the structure.

Throws:

TVCException

expandFully

public int expandFully()
                throws TVCException

Fully expands the root nodes.

Specified by:

expandFully in interface StructureBean

Returns:

The number of nodes added to the structure.

Throws:

TVCException

See Also:

StructureBean.isFullExpandSupported(), expandNodeFully(StructureBeanNode)

collapse

public void collapse()
              throws TVCException

Collapse the root nodes.

Specified by:

collapse in interface StructureBean

Throws:

TVCException

expandNode

public int expandNode(StructureBeanNode node)
               throws TVCException

Expands the specified node one level.

Specified by:

expandNode in interface StructureBean

Parameters:

node - The node to expand.

Returns:

The number of nodes added to the structure.

Throws:

TVCException

See Also:

expandNode(StructureBeanNode,int), expandNodeFully(StructureBeanNode)

expandNodeFully

public int expandNodeFully(StructureBeanNode node)
                    throws TVCException

Fully expands the node.

Specified by:

expandNodeFully in interface StructureBean

Parameters:

node - The node to expand.

Returns:

The number of nodes added to the structure.

Throws:

TVCException

See Also:

expandNode(StructureBeanNode), expandNode(StructureBeanNode,int)

setExpanded

public static void setExpanded(StructureBeanNode node,
                               int level)

Sets the expanded flag on all nodes below the specified until the specified level has been reached.

getRootNode

public StructureBeanNode getRootNode()

Returns the first root node.

Specified by:

getRootNode in interface StructureBean

getTableData

public java.util.Iterator<StructureBeanNode> getTableData()

Returns all StructureBeanNode instances currently in the structure.

Specified by:

getTableData in interface TableBean<StructureBeanNode>

Specified by:

getTableData in interface TableDataProvider<StructureBeanNode>

Returns:

all TableData instances currently in the table.

removeTableData

public void removeTableData(TableData data)

Removed the specified TableData from the structure.

Specified by:

removeTableData in interface TableBean<StructureBeanNode>

Parameters:

data - The TableData that should be removed from the table.

getTableDataAt

public TableData getTableDataAt(int index)

Returns the TableData instance at the specified index.

Specified by:

getTableDataAt in interface TableBean<StructureBeanNode>

Overrides:

getTableDataAt in class AbstractTableBean<StructureBeanNode>

Parameters:

index - The index.

Returns:

The TableData instance at the specified index.

Throws:

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

See Also:

getNodeAt(int)

getTableDataCount

public int getTableDataCount()

Returns the count of all StructureBeanNode instances in the table.

Specified by:

getTableDataCount in interface TableBean<StructureBeanNode>

Overrides:

getTableDataCount in class AbstractTableBean<StructureBeanNode>

Returns:

The count of all StructureBeanNode instances in the table.

See Also:

getTableData(), getNodes(), getNodeCount()

hasTableData

public boolean hasTableData()

Returns true if the structure contains any StructureBeanNode instances.

Specified by:

hasTableData in interface TableBean<StructureBeanNode>

Overrides:

hasTableData in class AbstractTableBean<StructureBeanNode>

Returns:

true if the structure contains any StructureBeanNode instances.

getNodes

public java.util.Iterator<StructureBeanNode> getNodes()

Returns the nodes in the structure.

Specified by:

getNodes in interface StructureBean

getNodes

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

Specified by:

getNodes in interface StructureBean

getNodes

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

Specified by:

getNodes in interface StructureBean

removeNode

public boolean removeNode(StructureBeanNode node)

Removes the node from the structure.

Specified by:

removeNode in interface StructureBean

Returns:

Whether the node was removed or not.

removeNodes

public void removeNodes(java.lang.String objectId)

Removes all nodes with the specified object ID.

Specified by:

removeNodes in interface StructureBean

removeNodes

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

Removes all nodes with the specified object and relationship ID.

Specified by:

removeNodes in interface StructureBean

getNodeAt

public StructureBeanNode getNodeAt(int index)

Returns the node at the specified index.

Specified by:

getNodeAt in interface StructureBean

Throws:

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

getNodeCount

public int getNodeCount()

Returns the node count.

Specified by:

getNodeCount in interface StructureBean

hasNodes

public boolean hasNodes()

Returns whether the structure has any nodes at all.

Specified by:

hasNodes in interface StructureBean

isInquirySupported

public boolean isInquirySupported(com.technia.tvc.core.db.inquiry.Inquiry inquiry)

Returns whether the inquiry is supported or not.

Specified by:

isInquirySupported in interface com.technia.tvc.core.db.inquiry.InquirySupport

isRootInquirySupported

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

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

Specified by:

isRootInquirySupported in interface CompositeStructureBean

Since:

4.1.0

loadRootsFromInquiry

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

Specified by:

loadRootsFromInquiry in interface CompositeStructureBean

Throws:

TVCException

Since:

4.1.0

loadRootsFromInquiry

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

Load the root nodes from the specified inquiry.

Specified by:

loadRootsFromInquiry in interface CompositeStructureBean

Throws:

TVCException

Since:

4.1.0

getRootInquirySupport

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

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

Specified by:

getRootInquirySupport in interface CompositeStructureBean

Since:

4.1.0

loadFromInquiry

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

Evaluates the inquiry into the structure.

Specified by:

loadFromInquiry in interface com.technia.tvc.core.db.inquiry.InquirySupport

Throws:

TVCException

loadIntoNode

protected void loadIntoNode(StructureBeanNode into,
                            com.technia.tvc.core.db.inquiry.StructureResult.Node source)
                     throws TVCException

Loads the result of the inquiry into the structure.

Throws:

TVCException

loadRootsFromJPO

public void loadRootsFromJPO(JPOName name,
                             Environment env)
                      throws TVCException

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

Specified by:

loadRootsFromJPO in interface CompositeStructureBean

Throws:

TVCException

Since:

4.1.0

loadRootsFromJPO

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

Load the root nodes from the specified JPO.

Specified by:

loadRootsFromJPO in interface CompositeStructureBean

Throws:

TVCException

Since:

4.1.0

getRootJPOSupport

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

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

Specified by:

getRootJPOSupport in interface CompositeStructureBean

Since:

4.1.0

loadFromJPO

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

It's currently not supported to load the structure from a JPO.

Specified by:

loadFromJPO in interface com.technia.tvc.core.db.jpo.JPOSupport

Throws:

java.lang.UnsupportedOperationException - This operation is currently not supported.

TVCException

addStructureListener

public void addStructureListener(StructureListener listener)

Adds a StructureListener to the structure.

Specified by:

addStructureListener in interface StructureBean

Parameters:

listener - The StructureListener to add.

removeStructureListener

public void removeStructureListener(StructureListener listener)

Removes a StructureListener from the structure.

Specified by:

removeStructureListener in interface StructureBean

Parameters:

listener - The StructureListener to remove

getStructureListeners

protected StructureListener[] getStructureListeners()

Returns:

Returns all StructureListener.

Since:

2009.3

fireStructureExpandEvent

protected void fireStructureExpandEvent(StructureBeanNode node)

Fires a node expanded event.

fireStructureCollapseEvent

protected void fireStructureCollapseEvent(StructureBeanNode node)

Fires a node collapsed event.

sort

public void sort(Environment env)
          throws TVCException

Sorts the structure according to the current sort modes.

Specified by:

sort in class AbstractSortableTableBean<StructureBeanNode>

Parameters:

env - the environment.

Throws:

TVCException - if unable to sort.

createTableDataComparator

protected java.util.Comparator<StructureBeanNode> createTableDataComparator()

sortImpl

protected void sortImpl(StructureBeanNode node,
                        java.util.Comparator<StructureBeanNode> comparator)

Implementation of sort. Calls itself recursively for every node to sort it's children.

createRootNode

protected abstract StructureBeanNode createRootNode(java.lang.String rootObjectId)
                                             throws TVCException

Creates a root node with the specified object ID.

Throws:

TVCException

createStructureNode

protected abstract StructureBeanNode createStructureNode(java.lang.String relationshipId,
                                                         java.lang.String objectId,
                                                         boolean from)
                                                  throws TVCException

Creates a node with the specified relationship ID, object ID and direction.

Throws:

TVCException

onNavigate

protected void onNavigate(TableBean<? extends TableData> table,
                          java.lang.String objectId)
                   throws TVCException

Initialize the StructureBean when navigating.

Overrides:

onNavigate in class AbstractSortableTableBean<StructureBeanNode>

Throws:

TVCException

Since:

4.1.0

isVisibleChild

public boolean isVisibleChild(StructureBeanNode node,
                              StructureBeanNode child)

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

Specified by:

isVisibleChild in interface StructureBean

Since:

4.1.0

isFirstVisibleChild

public boolean isFirstVisibleChild(StructureBeanNode node,
                                   StructureBeanNode child)

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

Specified by:

isFirstVisibleChild in interface StructureBean

Since:

4.1.0

isLastVisibleChild

public boolean isLastVisibleChild(StructureBeanNode node,
                                  StructureBeanNode child)

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

Specified by:

isLastVisibleChild in interface StructureBean

Since:

4.1.0

getVisibleChildAt

public StructureBeanNode getVisibleChildAt(StructureBeanNode node,
                                           int index)

Returns the visible child node at the specified index.

Specified by:

getVisibleChildAt in interface StructureBean

Since:

4.1.0

getVisibleChildIndex

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

Specified by:

getVisibleChildIndex in interface StructureBean

Since:

4.1.0

getVisibleChildNodes

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

Returns all visible child nodes.

Specified by:

getVisibleChildNodes in interface StructureBean

Since:

4.1.0

getVisibleChildCount

public int getVisibleChildCount(StructureBeanNode node)

Returns the visible child count.

Specified by:

getVisibleChildCount in interface StructureBean

Since:

4.1.0

hasVisibleChildren

public boolean hasVisibleChildren(StructureBeanNode node)

Returns true if the node has any visible children.

Specified by:

hasVisibleChildren in interface StructureBean

Since:

4.1.0

onViewChanged

protected void onViewChanged()

Invoked when the table's view changes. Invalidates the structure.

Overrides:

onViewChanged in class AbstractSortableTableBean<StructureBeanNode>

Since:

4.1.0

onVisualsChanged

protected void onVisualsChanged()

Invoked when the view's filters changes. Invalidates the structure.

Overrides:

onVisualsChanged in class AbstractTableBean<StructureBeanNode>

Since:

4.1.0

invalidateRootNodes

protected void invalidateRootNodes()

Invalidates the structure on all root nodes.

Since:

5.2.2

isToFlatTableSupported

public boolean isToFlatTableSupported()

Description copied from interface: StructureBean

Check whether this StructureBean can be converted to a FlatTableBean.

Specified by:

isToFlatTableSupported in interface StructureBean

Returns:

Returns true if StructureBean.toFlatTable() is supported.

See Also:

StructureBean.toFlatTable()

toFlatTable

public FlatTableBean toFlatTable()
                          throws TVCException

Description copied from interface: StructureBean

Converts the StructureBean to a FlatTableBean.

Specified by:

toFlatTable in interface StructureBean

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.

See Also:

StructureBean.isToFlatTableSupported()

accept

public void accept(StructureBeanNodeVisitor visitor)

Description copied from interface: StructureBean

Visit all nodes on this StructureBean.

Specified by:

accept in interface StructureBean

Parameters:

visitor - The visitor.

isFiltersCombinable

public boolean isFiltersCombinable()

This method returns true. Subclasses can override and return desired value if needed.

Specified by:

isFiltersCombinable in interface StructureBean

Returns:

a boolean value indicating whether the filters could be combined.

expandNode

public int expandNode(StructureBeanNode node,
                      int levels)
               throws TVCException

Expands the specified node.

Specified by:

expandNode in interface StructureBean

Parameters:

node - The node to expand.

levels - The number of levels to expand the node.

Returns:

The number of visible nodes added to the structure.

Throws:

TVCException

See Also:

expandNode(StructureBeanNode), expandNodeFully(StructureBeanNode)

countVisibleChildNodes

protected int countVisibleChildNodes(StructureBeanNode node)

Counts the visible nodes benieth the given node.

Parameters:

node - A node.

Returns:

The number of visible subnodes.

Since:

2009.3

doExpandNode

protected abstract void doExpandNode(StructureBeanNode node,
                                     int levels)
                              throws TVCException

Override this method to expand a node.

Parameters:

node - The node to expand.

levels - The number of levels to expand.

Throws:

TVCException - If unable to expand.

Since:

2009.3

collapseNode

public void collapseNode(StructureBeanNode node)
                  throws TVCException

Collapse the node.

Specified by:

collapseNode in interface StructureBean

Parameters:

node - The node to collapse.

Throws:

TVCException

doCollapseNode

protected abstract void doCollapseNode(StructureBeanNode node)
                                throws TVCException

Override this method to collapse a node.

Parameters:

node - The node to collapse.

Throws:

TVCException - If unable to collapse the node.

Since:

2009.3