Package org.exoplatform.portal.mop.navigation

Class NodeContext<N>

java.lang.Object

org.exoplatform.portal.tree.list.ListTree<NodeContext<N>>

org.exoplatform.portal.mop.navigation.NodeContext<N>

public final class NodeContext<N>
extends ListTree<NodeContext<N>>

The context of a node.

Method Summary

Modifier and Type	Method	Description
boolean	accept(NodeFilter filter)	Apply the filter logic on this node only.
NodeContext<N>	add(Integer index, String name)	Add a child node at the specified index with the specified name.
void	add(Integer index, NodeContext<N> context)	Move a context as a child context of this context at the specified index.
protected void	afterInsert(NodeContext<N> context)	Callback to signal insertion occured.
protected void	afterRemove(NodeContext<N> context)	Callback to signal insertion occured.
protected void	beforeInsert(NodeContext<N> context)	Callback to signal insertion occured.
protected void	beforeRemove(NodeContext<N> context)	Callback to signal insertion occured.
void	filter(NodeFilter filter)	Applies a filter recursively, the filter will update the hiddent status of the fragment.
NodeContext<N>	get(String name)
List<NodeChange<NodeContext<N>>>	getChanges()	Returns an unmodifiable list of uncommitted changes applied to this node context.
int	getDepth(NodeContext<N> ancestor)	Returns the relative depth of this node with respect to the ancestor argument.
NodeContext<N>	getDescendant(String handle)
N	getDescendantNode(String handle)
String	getId()	Returns the context id or null if the context is not associated with a persistent navigation node.
int	getIndex()	Returns the context index among its parent.
String	getName()
N	getNode()	Returns the associated node with this context
N	getNode(int index)
N	getNode(String name)
int	getNodeCount()	Returns the node count defined by: when the node has a children relationship, the number of non hidden nodes when the node has not a children relationship, the total number of nodes
Collection<N>	getNodes()
int	getNodeSize()	Returns the total number of nodes.
N	getParentNode()
NodeState	getState()
boolean	hasChanges()	Returns true if the tree containing this node has pending transient changes.
NodeContext<N>	insertAfter(NodeData data)
NodeContext<N>	insertAt(Integer index, NodeData data)
NodeContext<N>	insertLast(NodeData data)
boolean	isExpanded()
boolean	isHidden()	Returns true if the context is currently hidden.
Iterator<N>	iterator()
boolean	removeNode()	Removes this current context when it is not hidden.
boolean	removeNode(String name)	Remove a specified context when it is not hidden.
void	setHidden(boolean hidden)	Updates the hiddent value.
void	setName(String name)	Rename this context.
void	setState(NodeState state)	Update the context state
String	toString()
StringBuilder	toString(int depth, StringBuilder sb)

Methods inherited from class org.exoplatform.portal.tree.list.ListTree

get, getDepth, getFirst, getLast, getNext, getParent, getPrevious, getSize, insertAfter, insertAt, insertBefore, insertFirst, insertLast, listIterator, remove

Methods inherited from class java.lang.Object

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

Method Details

hasChanges

public boolean hasChanges()

Returns true if the tree containing this node has pending transient changes.

Returns:

true if there are uncommited changes

getChanges

public List<NodeChange<NodeContext<N>>> getChanges()

Returns an unmodifiable list of uncommitted changes applied to this node context.

Returns:

the list of uncommitted changes

getNode

public N getNode()

Returns the associated node with this context

Returns:

the node

getId

public String getId()

Returns the context id or null if the context is not associated with a persistent navigation node.

Returns:

the id

getIndex

public int getIndex()

Returns the context index among its parent.

Returns:

the index value

isExpanded

public boolean isExpanded()

isHidden

public boolean isHidden()

Returns true if the context is currently hidden.

Returns:

the hidden value

setHidden

public void setHidden(boolean hidden)

Updates the hiddent value.

Parameters:

hidden - the hidden value

getState

public NodeState getState()

setState

public void setState(NodeState state)
              throws NullPointerException

Update the context state

Parameters:

state - the new state

Throws:

NullPointerException - if the state is null

getName

public String getName()

setName

public void setName(String name)
             throws NullPointerException,
IllegalStateException,
IllegalArgumentException

Rename this context.

Parameters:

name - the new name

Throws:

NullPointerException - if the name is null

IllegalStateException - if the parent is null

IllegalArgumentException - if the parent already have a child with the specified name

filter

public void filter(NodeFilter filter)

Applies a filter recursively, the filter will update the hiddent status of the fragment.

Parameters:

filter - the filter to apply

accept

public boolean accept(NodeFilter filter)

Apply the filter logic on this node only. This method will not modify the state of this node.

Parameters:

filter - the filter to apply

Returns:

true if the filter accepts this node

getDepth

public int getDepth(NodeContext<N> ancestor)
             throws IllegalArgumentException,
NullPointerException

Returns the relative depth of this node with respect to the ancestor argument.

Parameters:

ancestor - the ancestor

Returns:

the depth

Throws:

IllegalArgumentException - if the ancestor argument is not an ancestor

NullPointerException - if the ancestor argument is null

getDescendant

public NodeContext<N> getDescendant(String handle)
                             throws NullPointerException

Throws:

NullPointerException

get

public NodeContext<N> get(String name)
                   throws NullPointerException,
IllegalStateException

Throws:

NullPointerException

IllegalStateException

add

public NodeContext<N> add(Integer index,
 String name)
                   throws NullPointerException,
IndexOutOfBoundsException,
IllegalStateException

Add a child node at the specified index with the specified name. If the index argument is null then the node is added at the last position among the children otherwise the node is added at the specified index.

Parameters:

index - the index

name - the node name

Returns:

the created node

Throws:

NullPointerException - if the model or the name is null

IndexOutOfBoundsException - if the index is negative or greater than the children size

IllegalStateException - if the children relationship does not exist

add

public void add(Integer index,
 NodeContext<N> context)
         throws NullPointerException,
IndexOutOfBoundsException,
IllegalStateException

Move a context as a child context of this context at the specified index. If the index argument is null then the context is added at the last position among the children otherwise the context is added at the specified index.

Parameters:

index - the index

context - the context to move

Throws:

NullPointerException - if the model or the context is null

IndexOutOfBoundsException - if the index is negative or greater than the children size

IllegalStateException - if the children relationship does not exist

insertLast

public NodeContext<N> insertLast(NodeData data)

insertAt

public NodeContext<N> insertAt(Integer index,
 NodeData data)

insertAfter

public NodeContext<N> insertAfter(NodeData data)

getNodeSize

public int getNodeSize()

Returns the total number of nodes.

Returns:

the total number of nodes

getNodeCount

public int getNodeCount()

Returns the node count defined by:

• when the node has a children relationship, the number of non hidden nodes
• when the node has not a children relationship, the total number of nodes

Returns:

the node count

getParentNode

public N getParentNode()

getNode

public N getNode(String name)
          throws NullPointerException

Throws:

NullPointerException

getNode

public N getNode(int index)

getDescendantNode

public N getDescendantNode(String handle)
                    throws NullPointerException

Throws:

NullPointerException

iterator

public Iterator<N> iterator()

getNodes

public Collection<N> getNodes()

removeNode

public boolean removeNode(String name)
                   throws NullPointerException,
IllegalArgumentException,
IllegalStateException

Remove a specified context when it is not hidden.

Parameters:

name - the name of the context to remove

Returns:

true if the context was removed

Throws:

NullPointerException - if the name argument is null

IllegalArgumentException - if the named context does not exist

IllegalStateException - if the children relationship does not exist

removeNode

public boolean removeNode()
                   throws IllegalStateException

Removes this current context when it is not hidden.

Returns:

if the context was removed

Throws:

IllegalStateException - if the children relationship does not exist

beforeRemove

protected void beforeRemove(NodeContext<N> context)

Description copied from class: ListTree

Callback to signal insertion occured.

Overrides:

beforeRemove in class ListTree<NodeContext<N>>

Parameters:

context - the child inserted

beforeInsert

protected void beforeInsert(NodeContext<N> context)

Description copied from class: ListTree

Callback to signal insertion occured.

Overrides:

beforeInsert in class ListTree<NodeContext<N>>

Parameters:

context - the child inserted

afterInsert

protected void afterInsert(NodeContext<N> context)

Description copied from class: ListTree

Callback to signal insertion occured.

Overrides:

afterInsert in class ListTree<NodeContext<N>>

Parameters:

context - the child inserted

afterRemove

protected void afterRemove(NodeContext<N> context)

Description copied from class: ListTree

Callback to signal insertion occured.

Overrides:

afterRemove in class ListTree<NodeContext<N>>

Parameters:

context - the child inserted

toString

public String toString()

Overrides:

toString in class Object

toString

public StringBuilder toString(int depth,
 StringBuilder sb)