com.technia.tvc.core.structure

Interface StructureBeanNode

All Superinterfaces:

java.util.Map<java.lang.Object,java.lang.Object>, TableClient.Entry, TableData

All Known Subinterfaces:

GroupNode

All Known Implementing Classes:

com.technia.tvc.core.structure.DefaultStructureBeanNode, GroupStructureBeanImpl.DefaultGroupNode, GroupStructureBeanImpl.DefaultGroupNodeContent

public interface StructureBeanNode
extends TableData

Represents a node in a StructureBean.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARENT_OBJECT_ID_KEY The parent node's object ID is bound to this key (parent::id).
static java.lang.String	PARENT_RELATIONSHIP_ID_KEY The parent node's relationship ID is bound to this key ( parent::id[connection]).

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

OBJECT_ID_KEY, RELATIONSHIP_ID_KEY

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(StructureBeanNodeVisitor visitor) Visits this node and all children.
void	addChild(StructureBeanNode child) Adds a child node.
void	addChild(StructureBeanNode child, int index) Adds a child node at the given index within the child array
StructureBeanNode	copy(StructureBeanNode parent, TableBeanProxy table) Create a copy of this node and its decendants.
void	expunge() This method is called by the structure implementation to expunge a node that isn't being used by the structure no more.
StructureBeanNode	getChildAt(int index) Returns the child node at the specified index.
int	getChildCount() Returns the child count.
int	getChildIndex(StructureBeanNode child) Returns the index of the specified child, or -1 if the child in fact isn't a child to this node.
java.util.Iterator<StructureBeanNode>	getChildNodes() Returns all child nodes.
java.util.Iterator<StructureBeanNode>	getChildNodes(java.lang.String relationshipId, java.lang.String objectId, boolean from) Returns all child nodes that match the given relationship ID, object ID and direction.
StructureBeanNode	getDescendantAt(int index) Returns the descendant at the specified index.
int	getDescendantCount() Returns the count of descendant nodes.
java.util.Iterator<StructureBeanNode>	getDescendantNodes() Returns all descendant nodes.
int	getIndex() Returns the index of this node within the structure
int	getLevel() Returns the level of this node
StructureBeanNode	getParent() Returns the node's parent node.
boolean	hasChildren() Returns true if the node has any children.
boolean	hasDescendant() Returns whether the node has any descendant nodes or not.
boolean	hasParent() Returns true if the node has a parent node.
boolean	isAncestor(StructureBeanNode node) Returns true if the specified node is an ancestor of the node.
boolean	isChild(StructureBeanNode child) Returns true if the specified node is a child to this node.
boolean	isDescendant(StructureBeanNode descendant) Returns true if the specified node is a descendant of this node.
boolean	isExpandable()
boolean	isExpanded() Returns true if the node is expanded.
boolean	isExpunged() Returns whether the node has been expunged or not.
boolean	isFirstChild(StructureBeanNode child) Returns true if the specified node is this node's first child.
boolean	isFrom() Returns true if the relationship between the node and it's parent is in the from direction (i.e., the relationship is going from the parent to the child node).
boolean	isLastChild(StructureBeanNode child) Returns true if the specified node is this node's last child.
boolean	isParent(StructureBeanNode node) Returns true if the specified node is the node's parent node.
boolean	isStructureValid() Returns true if the structure below the node is valid or not.
boolean	removeChild(StructureBeanNode child) Removes a child node.
boolean	removeChildNodes() Removes all child nodes.
boolean	removeChildNodes(boolean expunge) Removes all child nodes.
void	setExpandable(boolean expandable) Sets whether this node is expandable or not.
void	setExpanded(boolean expanded) Sets whether the node is expanded or not.
void	setFrom(boolean from) Sets whether the relationship between the node and it's parent is in the from direction or not.
void	setParent(StructureBeanNode parent) Sets the node's parent node.
void	setStructureValid(boolean structureValid) Sets whether the structure below the node is valid or not.
void	sortChildNodes(java.util.Comparator<? super StructureBeanNode> comparator) Sorts the child nodes using the specified java.util.Comparator.

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

accept, copy, getCell, getCell, getCell, getData, getId, getObjectId, getRelationshipId, getRow, isEvaluationRequired, putData, setEvaluationRequired, setObjectId, setRelationshipId

Methods inherited from interface com.technia.tvc.core.gui.table.TableClient.Entry

isHighlighted, isNavigable, isSelectable, isSelected, isVisible, setHighlighted, setNavigable, setRow, setSelectable, setSelected, setVisible

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Field Detail

PARENT_OBJECT_ID_KEY

static final java.lang.String PARENT_OBJECT_ID_KEY

The parent node's object ID is bound to this key (parent::id).

See Also:

Constant Field Values

PARENT_RELATIONSHIP_ID_KEY

static final java.lang.String PARENT_RELATIONSHIP_ID_KEY

The parent node's relationship ID is bound to this key ( parent::id[connection]).

See Also:

Constant Field Values

Method Detail

isFrom

boolean isFrom()

Returns true if the relationship between the node and it's parent is in the from direction (i.e., the relationship is going from the parent to the child node).

See Also:

setFrom(boolean)

setFrom

void setFrom(boolean from)

Sets whether the relationship between the node and it's parent is in the from direction or not.

See Also:

isFrom()

isExpanded

boolean isExpanded()

Returns true if the node is expanded.

See Also:

setExpanded(boolean)

isExpandable

boolean isExpandable()

Returns:

If the node is expandable or not; e.g. it can be collapsed/expanded A node is by default expandable, unless it has explicitly been told not to be

Since:

6.3.0

setExpandable

void setExpandable(boolean expandable)

Sets whether this node is expandable or not.

Parameters:

expandable - False if the node isn't expandable nor collapsable

Since:

6.3.0

setExpanded

void setExpanded(boolean expanded)

Sets whether the node is expanded or not.

See Also:

setExpanded(boolean)

isStructureValid

boolean isStructureValid()

Returns true if the structure below the node is valid or not. Note that nodes with invalid structures will be validated by the structure when it's validate(Map) method is invoked.

See Also:

setStructureValid(boolean)

setStructureValid

void setStructureValid(boolean structureValid)

Sets whether the structure below the node is valid or not.

See Also:

isStructureValid()

setParent

void setParent(StructureBeanNode parent)

Sets the node's parent node.

See Also:

getParent(), hasParent(), isParent(StructureBeanNode), isAncestor(StructureBeanNode)

getParent

StructureBeanNode getParent()

Returns the node's parent node.

See Also:

setParent(StructureBeanNode), hasParent(), isParent(StructureBeanNode), isAncestor(StructureBeanNode)

hasParent

boolean hasParent()

Returns true if the node has a parent node.

See Also:

setParent(StructureBeanNode), getParent(), isParent(StructureBeanNode), isAncestor(StructureBeanNode)

isParent

boolean isParent(StructureBeanNode node)

Returns true if the specified node is the node's parent node.

See Also:

setParent(StructureBeanNode), getParent(), hasParent(), isAncestor(StructureBeanNode)

isAncestor

boolean isAncestor(StructureBeanNode node)

Returns true if the specified node is an ancestor of the node.

See Also:

setParent(StructureBeanNode), getParent(), hasParent(), isParent(StructureBeanNode)

addChild

void addChild(StructureBeanNode child)

Adds a child node.

See Also:

removeChild(StructureBeanNode), removeChildNodes(), isChild(StructureBeanNode), isFirstChild(StructureBeanNode), isLastChild(StructureBeanNode), getChildAt(int), getChildIndex(StructureBeanNode), getChildNodes(), getChildCount(), hasChildren()

addChild

void addChild(StructureBeanNode child,
            int index)

Adds a child node at the given index within the child array

Since:

4.0

See Also:

removeChild(StructureBeanNode), removeChildNodes(), isChild(StructureBeanNode), isFirstChild(StructureBeanNode), isLastChild(StructureBeanNode), getChildAt(int), getChildIndex(StructureBeanNode), getChildNodes(), getChildCount(), hasChildren()

removeChild

boolean removeChild(StructureBeanNode child)

Removes a child node.

See Also:

addChild(StructureBeanNode), removeChildNodes(), isChild(StructureBeanNode), isFirstChild(StructureBeanNode), isLastChild(StructureBeanNode), getChildAt(int), getChildIndex(StructureBeanNode), getChildNodes(), getChildCount(), hasChildren()

removeChildNodes

boolean removeChildNodes()

Removes all child nodes.

See Also:

addChild(StructureBeanNode), removeChild(StructureBeanNode), isChild(StructureBeanNode), isFirstChild(StructureBeanNode), isLastChild(StructureBeanNode), getChildAt(int), getChildIndex(StructureBeanNode), getChildNodes(), getChildCount(), hasChildren()

removeChildNodes

boolean removeChildNodes(boolean expunge)

Removes all child nodes.

Parameters:

expunge - Whether to expunge the child nodes being removed.

isChild

boolean isChild(StructureBeanNode child)

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

See Also:

addChild(StructureBeanNode), removeChild(StructureBeanNode), removeChildNodes(), isFirstChild(StructureBeanNode), isLastChild(StructureBeanNode), getChildAt(int), getChildIndex(StructureBeanNode), getChildNodes(), getChildCount(), hasChildren()

isFirstChild

boolean isFirstChild(StructureBeanNode child)

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

See Also:

addChild(StructureBeanNode), removeChild(StructureBeanNode), removeChildNodes(), isChild(StructureBeanNode), isLastChild(StructureBeanNode), getChildAt(int), getChildIndex(StructureBeanNode), getChildNodes(), getChildCount(), hasChildren()

isLastChild

boolean isLastChild(StructureBeanNode child)

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

See Also:

addChild(StructureBeanNode), removeChild(StructureBeanNode), removeChildNodes(), isChild(StructureBeanNode), isFirstChild(StructureBeanNode), getChildAt(int), getChildIndex(StructureBeanNode), getChildNodes(), getChildCount(), hasChildren()

getChildAt

StructureBeanNode getChildAt(int index)

Returns the child node at the specified index.

See Also:

addChild(StructureBeanNode), removeChild(StructureBeanNode), removeChildNodes(), isChild(StructureBeanNode), isFirstChild(StructureBeanNode), isLastChild(StructureBeanNode), getChildIndex(StructureBeanNode), getChildNodes(), getChildCount(), hasChildren()

getChildIndex

int getChildIndex(StructureBeanNode child)

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

See Also:

addChild(StructureBeanNode), removeChild(StructureBeanNode), removeChildNodes(), isChild(StructureBeanNode), isFirstChild(StructureBeanNode), isLastChild(StructureBeanNode), getChildAt(int), getChildNodes(), getChildCount(), hasChildren()

getChildNodes

java.util.Iterator<StructureBeanNode> getChildNodes()

Returns all child nodes.

See Also:

addChild(StructureBeanNode), removeChild(StructureBeanNode), removeChildNodes(), isChild(StructureBeanNode), isFirstChild(StructureBeanNode), isLastChild(StructureBeanNode), getChildAt(int), getChildIndex(StructureBeanNode), getChildCount(), hasChildren()

getChildNodes

java.util.Iterator<StructureBeanNode> getChildNodes(java.lang.String relationshipId,
                                                  java.lang.String objectId,
                                                  boolean from)

Returns all child nodes that match the given relationship ID, object ID and direction.

Parameters:

relationshipId - The relationship ID.

objectId - The object ID.

from - Whether the direction is from this node to the children.

Returns:

Returns all nodes that match the criteria.

Since:

5.2.1

getChildCount

int getChildCount()

Returns the child count.

See Also:

addChild(StructureBeanNode), removeChild(StructureBeanNode), removeChildNodes(), isChild(StructureBeanNode), isFirstChild(StructureBeanNode), isLastChild(StructureBeanNode), getChildAt(int), getChildIndex(StructureBeanNode), getChildNodes(), hasChildren()

getLevel

int getLevel()

Returns the level of this node

getIndex

int getIndex()

Returns the index of this node within the structure

hasChildren

boolean hasChildren()

Returns true if the node has any children.

See Also:

addChild(StructureBeanNode), removeChild(StructureBeanNode), removeChildNodes(), isChild(StructureBeanNode), isFirstChild(StructureBeanNode), isLastChild(StructureBeanNode), getChildAt(int), getChildIndex(StructureBeanNode), getChildNodes(), getChildCount()

sortChildNodes

void sortChildNodes(java.util.Comparator<? super StructureBeanNode> comparator)

Sorts the child nodes using the specified java.util.Comparator.

isDescendant

boolean isDescendant(StructureBeanNode descendant)

Returns true if the specified node is a descendant of this node.

See Also:

isChild(StructureBeanNode)

getDescendantAt

StructureBeanNode getDescendantAt(int index)

Returns the descendant at the specified index. Note how the index of a descendant node is calculated:

     NODE
       |
       |---- DESCENDANT[index=0]
       |       |
       |       |---- DESCENDANT[1]
       |
       |---- DESCENDANT[2]
       |       |
       |       |---- DESCENDANT[3]
       |       |
       |       |---- DESCENDANT[4]
       |               |
       |               |---- DESCENDANT[5]
       |
       |---- DESCENDANT[6]
 

See Also:

getChildAt(int)

getDescendantNodes

java.util.Iterator<StructureBeanNode> getDescendantNodes()

Returns all descendant nodes.

See Also:

getChildNodes()

getDescendantCount

int getDescendantCount()

Returns the count of descendant nodes.

See Also:

getChildCount()

hasDescendant

boolean hasDescendant()

Returns whether the node has any descendant nodes or not. Note that this method will always return the same value as the hasChildren() method.

See Also:

hasChildren()

expunge

void expunge()

This method is called by the structure implementation to expunge a node that isn't being used by the structure no more. The purpose of this method is to make any resources held by the node (including any resources held by descendant nodes) available for garbage collection.

See Also:

isExpunged()

isExpunged

boolean isExpunged()

Returns whether the node has been expunged or not.

See Also:

expunge()

copy

StructureBeanNode copy(StructureBeanNode parent,
                     TableBeanProxy table)

Create a copy of this node and its decendants.

Parameters:

parent - The parent node.

table - The table.

Returns:

Returns the copy of the node.

Since:

5.2.1

accept

void accept(StructureBeanNodeVisitor visitor)

Visits this node and all children.

Parameters:

visitor - The visitor.

Since:

6.3.3