com.goldencode.p2j.ui

Class TreeNodeCollectionResource

java.lang.Object

com.goldencode.p2j.util.HandleResource

com.goldencode.p2j.ui.TreeNodeCollectionResource

All Implemented Interfaces:

RemoveNode, TreeNodeCollection, CommonHandle, Deletable, DynamicResource, InstantiatingProcedure, WrappedResource, Printable, java.lang.Iterable<TreeNodeResource>

public class TreeNodeCollectionResource
extends HandleResource
implements TreeNodeCollection, DynamicResource

Implements the TREE-NODE-COLLECTION resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	TreeNodeCollectionResource.Location Node relative location enum.
private static class	TreeNodeCollectionResource.NodesIterator Recursive nodes iterator.

Field Summary

Fields

Modifier and Type	Field and Description
private static int	CHILD_NODE_RELATIONSHIP
private static character	DEFAULT_VALUE Represents the default key and text values for a new created tree node.
private static int	FIRST_NODE_RELATIONSHIP The tree relationship constant used by TreeRelationshipConstants
private static int	LAST_NODE_RELATIONSHIP
protected static CentralLogger	LOG Logger
private static int	NEXT_NODE_RELATIONSHIP
(package private) java.util.LinkedList<TreeNodeResource>	nodes The nodes collection implementation.
private TreeNodeResource	owner The owning tree node.
private static int	PREVIOUS_NODE_RELATIONSHIP
private TreeWidgetBase	tree The owning tree.

Fields inherited from class com.goldencode.p2j.util.HandleResource

instProc, pm

Constructor Summary

Constructors

Constructor and Description
TreeNodeCollectionResource(TreeWidgetBase tree, TreeNodeResource owner) Constructor.

Method Summary

Modifier and Type	Method and Description
(package private) handle	_addNodeImpl(TreeNodeResource relative, TreeNodeCollectionResource.Location location, character key, character text, boolean pushNodes) Allocates new node and inserts it to the collection according to the location argument.
boolean	_dynamic() Returns true if the buffer is dynamic.
(package private) int	_getCount() Returns the count of the items in this collection.
(package private) TreeNodeResource	_getNode(int index) Returns the node at the specified index.
(package private) int	_indexOf(TreeNodeResource node) Returns the index of the supplied node.
(package private) void	_removeNode(TreeNodeResource node, java.util.Iterator<TreeNodeResource> it) Recursively removes the specified node from the collection and the tree.
handle	add() Adds a new tree node as a last node relative to the root tree node.
handle	add(BaseDataType anchor, NumberType relationType, character key, character text) Adds a new tree node as a first, last, next, previous or child node relative to the anchor node given by its index.
handle	add(BaseDataType anchor, NumberType relationType, character key, character text, NumberType nodeIcon, NumberType selectedNodeIcon) Adds a new tree node as a first, last, next, previous or child node relative to the anchor node given by its index.
handle	addChildNode(handle relativeNode, character key, character text) Creates a new node and inserts it as the last child item relative to the supplied node.
handle	addFirstNode(character key, character text) Creates a new node and inserts it as the first item in the collection.
handle	addLastNode(character key, character text) Creates a new node and inserts it as the last item in the collection.
handle	addNextNode(handle relativeNode, character key, character text) Creates a new node and inserts it as the next item relative to the supplied node.
private handle	addNodeRecursively(java.lang.Object anchor, NumberType relationType, character key, character text) Adds a new tree node as a first, last, next, previous or child node relative to the anchor node given by its index.
void	clearNodes() Removes all the nodes from the collection and all the child nodes recursively.
private TreeNodeResource	createNode(java.lang.String key, java.lang.String text, TreeNodeResource parent) Creates a new node and adds it to the end of the collection
void	delete() Perform actual delete of an resource.
logical	dynamic() Checks whether the resource is dynamic or static.
integer	getCount() Returns the count of all the items in this collection except the internal root node.
handle	getItem(NumberType nodeIndex) Returns the node at the specified index.
integer	getNodeCount() Returns the count of all the items in this collection.
handle	getTreeNode(character key) Returns the node of the specified key.
handle	getTreeNode(NumberType index) Returns the node at the specified index.
java.util.Iterator<TreeNodeResource>	iterator() Returns an iterator over elements of type T.
java.util.Iterator<TreeNodeResource>	recursiveIterator(boolean visibleOnly) Returns a recursive iterator.
void	remove(BaseDataType nodeKeyOrIndex) Removes the node with the specified key or index.
void	removeNode(character key) Removes the node at the specified key.
void	removeNode(NumberType index) Removes the node at the specified index.
protected boolean	resourceDelete() Worker to be implemented by each resource.
boolean	valid() Reports if this object is valid for use.

Methods inherited from class com.goldencode.p2j.util.HandleResource

_instantiatingProcedure, addToPool, doDelete, equals, hashCode, id, id, implicitDeletion, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, readOnlyError, readOnlyError, registerResource, resourceType, setInstantiatingProcedure, toString, type, unableToAssignUnknown, unknown

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.goldencode.util.Printable

asString, print

Methods inherited from interface com.goldencode.p2j.util.Deletable

allowDelete

Field Detail

LOG

protected static final CentralLogger LOG

Logger

DEFAULT_VALUE

private static final character DEFAULT_VALUE

Represents the default key and text values for a new created tree node.

FIRST_NODE_RELATIONSHIP

private static final int FIRST_NODE_RELATIONSHIP

The tree relationship constant used by TreeRelationshipConstants

See Also:

Constant Field Values

LAST_NODE_RELATIONSHIP

private static final int LAST_NODE_RELATIONSHIP

See Also:

Constant Field Values

NEXT_NODE_RELATIONSHIP

private static final int NEXT_NODE_RELATIONSHIP

See Also:

Constant Field Values

PREVIOUS_NODE_RELATIONSHIP

private static final int PREVIOUS_NODE_RELATIONSHIP

See Also:

Constant Field Values

CHILD_NODE_RELATIONSHIP

private static final int CHILD_NODE_RELATIONSHIP

See Also:

Constant Field Values

nodes

java.util.LinkedList<TreeNodeResource> nodes

The nodes collection implementation.

tree

private TreeWidgetBase tree

The owning tree.

owner

private TreeNodeResource owner

The owning tree node.

Constructor Detail

TreeNodeCollectionResource

public TreeNodeCollectionResource(TreeWidgetBase tree,
                                  TreeNodeResource owner)

Constructor.

Parameters:

tree - The owning tree view.

owner - The owning node.

Method Detail

iterator

public java.util.Iterator<TreeNodeResource> iterator()

Returns an iterator over elements of type T.

Specified by:

iterator in interface java.lang.Iterable<TreeNodeResource>

Returns:

an Iterator.

recursiveIterator

public java.util.Iterator<TreeNodeResource> recursiveIterator(boolean visibleOnly)

Returns a recursive iterator.

Parameters:

visibleOnly - When true only visible and expanded nodes will be iterated, when false all nodes will be iterated.

Returns:

an Iterator.

addFirstNode

public handle addFirstNode(character key,
                           character text)

Creates a new node and inserts it as the first item in the collection.

Specified by:

addFirstNode in interface TreeNodeCollection

Parameters:

key - The key of the new node.

text - The text of the new node.

Returns:

TreeNode resource if the operation is successful, unknown otherwise.

addLastNode

public handle addLastNode(character key,
                          character text)

Creates a new node and inserts it as the last item in the collection.

Specified by:

addLastNode in interface TreeNodeCollection

Parameters:

key - The key of the new node.

text - The text of the new node.

Returns:

TreeNode resource if the operation is successful, unknown otherwise.

addNextNode

public handle addNextNode(handle relativeNode,
                          character key,
                          character text)

Creates a new node and inserts it as the next item relative to the supplied node.

Specified by:

addNextNode in interface TreeNodeCollection

Parameters:

relativeNode - The relative node, wrapped resource of the type TTreeNode.

key - The key of the new node.

text - The text of the new node.

Returns:

TreeNode resource if the operation is successful, unknown otherwise.

addChildNode

public handle addChildNode(handle relativeNode,
                           character key,
                           character text)

Creates a new node and inserts it as the last child item relative to the supplied node.

Specified by:

addChildNode in interface TreeNodeCollection

Parameters:

relativeNode - The relative node, wrapped resource of the type TTreeNode.

key - The key of the new node.

text - The text of the new node.

Returns:

TreeNode resource if the operation is successful, unknown otherwise.

removeNode

public void removeNode(NumberType index)

Removes the node at the specified index.

Specified by:

removeNode in interface RemoveNode

Parameters:

index - A valid index.

removeNode

public void removeNode(character key)

Removes the node at the specified key.

Specified by:

removeNode in interface TreeNodeCollection

Parameters:

key - A valid node key.

clearNodes

public void clearNodes()

Removes all the nodes from the collection and all the child nodes recursively.

Specified by:

clearNodes in interface TreeNodeCollection

getNodeCount

public integer getNodeCount()

Returns the count of all the items in this collection.

Specified by:

getNodeCount in interface TreeNodeCollection

Returns:

see above.

getTreeNode

public handle getTreeNode(NumberType index)

Returns the node at the specified index.

Specified by:

getTreeNode in interface TreeNodeCollection

Parameters:

index - A valid index, 0-based

Returns:

wrapped tree node or unknown if the node not found.

getTreeNode

public handle getTreeNode(character key)

Returns the node of the specified key.

Specified by:

getTreeNode in interface TreeNodeCollection

Parameters:

key - A valid key.

Returns:

wrapped tree node resource or unknown if the node not found.

getItem

public handle getItem(NumberType nodeIndex)

Returns the node at the specified index.

Specified by:

getItem in interface TreeNodeCollection

Parameters:

nodeIndex - The node index.

Returns:

The node or unknown when the invalid index is provided.

remove

public void remove(BaseDataType nodeKeyOrIndex)

Removes the node with the specified key or index.

Specified by:

remove in interface TreeNodeCollection

Parameters:

nodeKeyOrIndex - either an integer node index, 1-based, or character node key.

valid

public boolean valid()

Reports if this object is valid for use.

Specified by:

valid in interface WrappedResource

Returns:

true if we are valid (can be used).

dynamic

public logical dynamic()

Checks whether the resource is dynamic or static.

Specified by:

dynamic in interface DynamicResource

Returns:

true if the resource is dynamic, false otherwise.

_dynamic

public boolean _dynamic()

Returns true if the buffer is dynamic.

This is not emitted by conversion, is used internally by FWD.

Specified by:

_dynamic in interface DynamicResource

Returns:

true if the resource is dynamic, false otherwise.

add

public handle add()

Adds a new tree node as a last node relative to the root tree node. This node has a default " " value for NODE-VALUE (KEY) and TEXT attributes.

Specified by:

add in interface TreeNodeCollection

Returns:

The handle to the new node.

add

public final handle add(BaseDataType anchor,
                        NumberType relationType,
                        character key,
                        character text)

Adds a new tree node as a first, last, next, previous or child node relative to the anchor node given by its index.

Specified by:

add in interface TreeNodeCollection

Parameters:

anchor - The anchor node or anchor node index or null for no anchor

relationType - The relation type: first(0), last(1), next(2), previous(3) and child(4) or null if does not matter.

key - The key of the new node

text - The label of the new node

Returns:

The handle to the new node or unknown if some arguments are incorrect.

add

public final handle add(BaseDataType anchor,
                        NumberType relationType,
                        character key,
                        character text,
                        NumberType nodeIcon,
                        NumberType selectedNodeIcon)

Adds a new tree node as a first, last, next, previous or child node relative to the anchor node given by its index.

Specified by:

add in interface TreeNodeCollection

Parameters:

anchor - The anchor node or null for no anchor

relationType - The relation type: first(0), last(1), next(2), previous(3) and child(4)

key - The key of the new node

text - The label of the new node

nodeIcon - The node icon 1-based index within its tree images list

selectedNodeIcon - The node icon 1-based index within its tree images list

Returns:

The handle to the new node.

delete

public void delete()

Perform actual delete of an resource. At the time of this call, it is assumed the resource is valid for deletion (the handle and the resource are both valid).

The method first calls resourceDelete(), if the method returns false, the deletion is aborted.

Specified by:

delete in interface Deletable

Overrides:

delete in class HandleResource

getCount

public integer getCount()

Returns the count of all the items in this collection except the internal root node.

Specified by:

getCount in interface TreeNodeCollection

Returns:

The number of all nodes in this collection

resourceDelete

protected boolean resourceDelete()

Worker to be implemented by each resource. Called by delete().

Overrides:

resourceDelete in class HandleResource

Returns:

true if the resource was deleted.

_removeNode

void _removeNode(TreeNodeResource node,
                 java.util.Iterator<TreeNodeResource> it)

Recursively removes the specified node from the collection and the tree. This will also delete the resource.

Parameters:

node - A valid node.

it - Optional iterator. When set, use it to remove the item from its list.

_getCount

int _getCount()

Returns the count of the items in this collection.

Returns:

see above.

_indexOf

int _indexOf(TreeNodeResource node)

Returns the index of the supplied node. If the node is not found in this collection the returned value is -1.

Parameters:

node - A valid node.

Returns:

see above.

_getNode

TreeNodeResource _getNode(int index)

Returns the node at the specified index.

Parameters:

index - 0-based index.

Returns:

see above.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

_addNodeImpl

handle _addNodeImpl(TreeNodeResource relative,
                    TreeNodeCollectionResource.Location location,
                    character key,
                    character text,
                    boolean pushNodes)

Allocates new node and inserts it to the collection according to the location argument.

Parameters:

relative - Relative node, semantics based on the location argument. The expected handle resource type is TreeNodeResource.

location - The location relative to relative argument.

key - The unique node key to be assigned to the node.

text - Node text.

pushNodes - true to push the model change to the client.

Returns:

handle with wrapped TreeNodeResource instance, or unknown if the operation fails.

addNodeRecursively

private final handle addNodeRecursively(java.lang.Object anchor,
                                        NumberType relationType,
                                        character key,
                                        character text)

Adds a new tree node as a first, last, next, previous or child node relative to the anchor node given by its index. The first argument to this method contains information about the anchor node. The following types are accepted: handle, comhandle, POJOComObject, NumberType, TreeViewNodeResource and null.

Parameters:

anchor - The object designating the anchor node

relationType - The relation type: first(0), last(1), next(2), previous(3) and child(4) or null if does not matter.

key - The key of the new node

text - The label of the new node

Returns:

The handle to the new node or unknown if some arguments are incorrect.

createNode

private TreeNodeResource createNode(java.lang.String key,
                                    java.lang.String text,
                                    TreeNodeResource parent)

Creates a new node and adds it to the end of the collection

Parameters:

key - The key to be assigned to the node.

text - Node text.

parent - Node parent, must not be null.

Returns:

new node resource

Throws:

java.lang.IllegalArgumentException - when any of the arguments is null

java.lang.RuntimeException - when the supplied key is not unique