Node (gatein-api 1.0.0.Final API)

All Superinterfaces:

Displayable, Iterable<Node>, LocalizedDisplayable, Serializable

All Known Subinterfaces:

FilteredNode
```
public interface Node
extends LocalizedDisplayable, Iterable<Node>, Serializable
```
A node object which represents the current state of a node retrieved from the portal. All changes to the node are not saved until Navigation.saveNode(Node) is called.

Author:

Nick Scavelli, Stian Thorgersen

Method Summary

Methods
Modifier and Type	Method and Description
`Node`	`addChild(int index, String childName)` Inserts a child to this navigation node at the specified index.
`Node`	`addChild(String childName)` Adds a child to this navigation node.
`FilteredNode`	`filter()` Will return a filtered view of this navigation node.
`Node`	`getChild(int index)` Returns the child node of the given index.
`Node`	`getChild(String childName)` Returns the child node.
`int`	`getChildCount()` Returns the number of child nodes.
`String`	`getIconName()` Name of the icon for this navigation node.
`String`	`getName()` The name of the node.
`Node`	`getNode(NodePath nodePath)` Returns the node specified by the node path, relative to this node.
`Node`	`getNode(String... nodePath)` Returns the node specified by the node path, relative to this node.
`NodePath`	`getNodePath()` The path of the node.
`PageId`	`getPageId()` The `PageId` of the page this node points to.
`Node`	`getParent()` Returns the parent of the node, or null if the node is the root node.
`String`	`getURI()` Resolves the URI given the current context.
`Visibility`	`getVisibility()` Returns the visibility object of this navigation node.
`boolean`	`hasChild(String childName)` If this node has a child of the specified childName
`int`	`indexOf(String childName)` The index of the child with the specified name.
`boolean`	`isChildrenLoaded()` If this node's children has been loaded.
`boolean`	`isRoot()` If this node is the root node of the navigation.
`boolean`	`isVisible()` If the node is visible.
`void`	`moveTo(int index)` Moves the node to the specified index.
`void`	`moveTo(int index, Node parent)` Moves this node to another parent inserting it at the specified index.
`void`	`moveTo(Node parent)` Moves this node to another parent.
`boolean`	`removeChild(String childName)` Removes the child from this navigation node.
`void`	`setIconName(String iconName)` Sets the name of the icon name for this navigation node.
`void`	`setName(String name)` Sets the name of the node.
`void`	`setPageId(PageId pageId)` Sets the `PageId` of the page this node should point to.
`void`	`setVisibility(boolean visible)` Sets the visibility of this navigation node either `Visibility.Status.VISIBLE` or `Visibility.Status.HIDDEN`.
`void`	`setVisibility(PublicationDate publicationDate)` Sets the visibility of this navigation node to be `Visibility.Status.PUBLICATION`, in which the dates of the `PublicationDate` are used to calculate the visibility.
`void`	`setVisibility(Visibility visibility)` Sets the visibility for this navigation node.
`void`	`sort(Comparator<Node> comparator)` Will sort the children of this node per the comparator.

Methods inherited from interface org.gatein.api.common.LocalizedDisplayable
getDisplayNames, setDisplayNames

Methods inherited from interface org.gatein.api.common.Displayable
getDisplayName, setDisplayName

Methods inherited from interface java.lang.Iterable
iterator

- Method Detail
  - getName
```
String getName()
```
    The name of the node.
    
    Returns:
    the name of the node. Should never be null.
  - setName
```
void setName(String name)
```
    Sets the name of the node.
    
    Parameters:
    name - the name of the node.
    
    Throws:
    
    IllegalArgumentException - if the name is null.
  - getParent
```
Node getParent()
```
    Returns the parent of the node, or null if the node is the root node.
    
    Returns:
    the parent node
  - getNodePath
```
NodePath getNodePath()
```
    The path of the node.
    
    Returns:
    the node path
  - getURI
```
String getURI()
```
    Resolves the URI given the current context.
    
    Returns:
    the resolved URI for this navigation node.
  - isVisible
```
boolean isVisible()
```
    If the node is visible. Convenience method for doing Node.getVisibility().isVisible()
    
    Returns:
    true if the node is visible, false otherwise
  - getVisibility
```
Visibility getVisibility()
```
    Returns the visibility object of this navigation node. This should never be null.
    
    Returns:
    the visibility of this node. This should never be null.
  - setVisibility
```
void setVisibility(Visibility visibility)
```
    Sets the visibility for this navigation node.
    
    Parameters:
    visibility - the visibility to set
    
    Throws:
    
    IllegalArgumentException - if the publication date is null
  - setVisibility
```
void setVisibility(boolean visible)
```
    Sets the visibility of this navigation node either Visibility.Status.VISIBLE or Visibility.Status.HIDDEN. This does not remove any publication information, just sets the flag.
    
    Parameters:
    visible - if this node should be visible or not
  - setVisibility
```
void setVisibility(PublicationDate publicationDate)
```
    Sets the visibility of this navigation node to be Visibility.Status.PUBLICATION, in which the dates of the PublicationDate are used to calculate the visibility.
    
    Parameters:
    publicationDate - the publication date
    
    Throws:
    
    IllegalArgumentException - if the publication date is null
  - getIconName
```
String getIconName()
```
    Name of the icon for this navigation node. Can be null.
    
    Returns:
    the icon name or null
  - setIconName
```
void setIconName(String iconName)
```
    Sets the name of the icon name for this navigation node. Can be null.
    
    Parameters:
    iconName - the name of the icon, or null.
  - getPageId
```
PageId getPageId()
```
    The PageId of the page this node points to.
    
    Returns:
    the page id or null
  - setPageId
```
void setPageId(PageId pageId)
```
    Sets the PageId of the page this node should point to. Can be null.
    
    Parameters:
    pageId - the page id or null
  - isRoot
```
boolean isRoot()
```
    If this node is the root node of the navigation.
    
    Returns:
    true if it's the root node, false otherwise
  - addChild
```
Node addChild(String childName)
```
    Adds a child to this navigation node.
    
    Parameters:
    childName - the name of the child
    
    Returns:
    the newly created child node
    
    Throws:
    
    IllegalArgumentException - if childName is null
    
    IllegalStateException - if this node's children have not been loaded.
    
    EntityAlreadyExistsException - if a child of the same name already exists.
  - addChild
```
Node addChild(int index,
            String childName)
```
    Inserts a child to this navigation node at the specified index.
    
    Parameters:
    index - the index at which the child is to be inserted
    childName - the name of the child
    
    Returns:
    the newly created child node
    
    Throws:
    
    IllegalArgumentException - if childName is null
    
    IllegalStateException - if this node's children have not been loaded.
    
    IndexOutOfBoundsException - if the index is out of range
    
    EntityAlreadyExistsException - if a child of the same name already exists.
  - getChild
```
Node getChild(String childName)
```
    Returns the child node.
    
    Parameters:
    childName - the name of the child node
    
    Returns:
    the child node or null if the child does not exist.
    
    Throws:
    
    IllegalArgumentException - the childName is null
    
    IllegalStateException - if this node's children have not been loaded
  - getChild
```
Node getChild(int index)
```
    Returns the child node of the given index.
    
    Parameters:
    index - the index of the child
    
    Returns:
    the child at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of range
    
    IllegalStateException - if this node's children have not been loaded
  - getChildCount
```
int getChildCount()
                  throws IllegalStateException
```
    Returns the number of child nodes.
    
    Returns:
    number of child nodes
    
    Throws:
    
    IllegalStateException - if this node's children have not been loaded
  - hasChild
```
boolean hasChild(String childName)
```
    If this node has a child of the specified childName
    
    Parameters:
    childName - the name of the child
    
    Returns:
    true if the child exists, false otherwise
    
    Throws:
    
    IllegalArgumentException - if childName is null
    
    IllegalStateException - if this node's children have not been loaded
  - isChildrenLoaded
```
boolean isChildrenLoaded()
```
    If this node's children has been loaded. This should be called prior to calling any child methods on this node.
    
    Returns:
    true if the children have been loaded, false otherwise
  - getNode
```
Node getNode(String... nodePath)
```
    Returns the node specified by the node path, relative to this node.
    For example: if the current tree is /foo/bar/baz and the current node is foo, then calling foo.getNode("bar", "baz") would return the baz node.
    
    Parameters:
    nodePath - the node path relative to this node.
    
    Returns:
    the node
    
    Throws:
    
    IllegalArgumentException - if nodePath is null
    
    IllegalStateException - if any of the nodes represented by the path do not have their children loaded
  - getNode
```
Node getNode(NodePath nodePath)
```
    Returns the node specified by the node path, relative to this node.
    For example: if the current tree is /foo/bar/baz and the current node is foo, then calling foo.getNode(NodePath.path("bar", "baz")) would return the baz node.
    
    Parameters:
    nodePath - the node path relative to this node
    
    Returns:
    the node
    
    Throws:
    
    IllegalArgumentException - if nodePath is null
    
    IllegalStateException - if any of the nodes represented by the path do not have their children loaded
  - indexOf
```
int indexOf(String childName)
```
    The index of the child with the specified name.
    
    Parameters:
    childName - the name of the child
    
    Returns:
    the index of the child or -1 if the child does not exist.
    
    Throws:
    
    IllegalArgumentException - if childName is null
    
    IllegalStateException - if this node's children have not been loaded
  - removeChild
```
boolean removeChild(String childName)
```
    Removes the child from this navigation node.
    
    Parameters:
    childName - the name of the child
    
    Returns:
    true if the child was removed, false otherwise
    
    Throws:
    
    IllegalArgumentException - if childName was null
    
    IllegalStateException - if this node's children have not been loaded
  - filter
```
FilteredNode filter()
```
    Will return a filtered view of this navigation node. All child operations consider the filter.
    For example if a node has 3 visible and one hidden children nodes and a filter is applied to only accept visible nodes, getChildrenCount would only return 2, iterating over the filtered node would not include the hidden node, etc.
    
    Returns:
    a filtered node
    
    Throws:
    
    IllegalArgumentException - if filter is null
  - sort
```
void sort(Comparator<Node> comparator)
```
    Will sort the children of this node per the comparator.
    
    Parameters:
    comparator - the comparator responsible for comparing nodes for sorting.
    
    Throws:
    
    IllegalArgumentException - if comparator is null
  - moveTo
```
void moveTo(int index)
```
    Moves the node to the specified index. param index the index to move the node to.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of range
  - moveTo
```
void moveTo(Node parent)
```
    Moves this node to another parent.
    
    Parameters:
    parent - the parent to move this node to.
    
    Throws:
    
    IllegalArgumentException - if parent is on a different branch, is a child of the current node, or if it is null
    
    EntityAlreadyExistsException - if a node with the same name already exists at the parent location
    
    IllegalStateException - if the children of the parent to move to have not been loaded
  - moveTo
```
void moveTo(int index,
          Node parent)
```
    Moves this node to another parent inserting it at the specified index.
    
    Parameters:
    index - the index to be inserted at
    parent - the parent to move this node to
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of range
    
    IllegalArgumentException - if parent is null
    
    EntityAlreadyExistsException - if a node with the same name already exists at the parent location
    
    IllegalStateException - if the children of the parent to move to have not been loaded

Interface Node

Method Summary

Methods inherited from interface org.gatein.api.common.LocalizedDisplayable

Methods inherited from interface org.gatein.api.common.Displayable

Methods inherited from interface java.lang.Iterable

Method Detail

getName

setName

getParent

getNodePath

getURI

isVisible

getVisibility

setVisibility

setVisibility

setVisibility

getIconName

setIconName

getPageId

setPageId

isRoot

addChild

addChild

getChild

getChild

getChildCount

hasChild

isChildrenLoaded

getNode

getNode

indexOf

removeChild

filter

sort

moveTo

moveTo

moveTo