org.apache.jackrabbit.core.version

Class NodeStateEx

java.lang.Object

org.apache.jackrabbit.core.version.NodeStateEx

public class NodeStateEx
extends Object

This Class provides some basic node operations directly on the node state.

Constructor Summary

Constructors

Constructor and Description
NodeStateEx(UpdatableItemStateManager stateMgr, NodeTypeRegistry ntReg, NodeId nodeId) Creates a new persistent node
NodeStateEx(UpdatableItemStateManager stateMgr, NodeTypeRegistry ntReg, NodeState nodeState, Name name) Creates a new persistent node

Method Summary

Methods

Modifier and Type	Method and Description
NodeStateEx	addNode(Name nodeName, Name nodeTypeName, NodeId id) Adds a new child node with the given name
NodeStateEx	addNode(Name nodeName, Name nodeTypeName, NodeId id, boolean referenceable) Adds a new child node with the given name
void	copyFrom(PropertyImpl prop) copies a property
void	copyFrom(PropertyState prop) copies a property
NodeStateEx[]	getChildNodes() returns all child nodes
QNodeDefinition	getDefinition() Returns the QNodeDefinition for this state
QPropertyDefinition	getDefinition(PropertyState prop) Returns the property definition for the property state
EffectiveNodeType	getEffectiveNodeType() Returns the effective (i.e.
Name	getName() returns the name of this node
NodeStateEx	getNode(Name name, int index) retrieves the child node with the given name and 1-base index or null if the node does not exist.
NodeStateEx	getNode(NodeId id) Returns the node with the given id.
NodeId	getNodeId() Returns the id of this node.
NodeStateEx	getParent() Returns the parent node of this node
NodeId	getParentId() Returns the parent id of this node
PropertyState[]	getProperties() Returns the properties of this node
InternalValue	getPropertyValue(Name name) Returns the value of the given property or null
InternalValue[]	getPropertyValues(Name name) Returns the values of the given property or null
NodeState	getState() Returns the underlaying node state.
boolean	hasAncestor(NodeId nodeId) Checks if this state has the indicated ancestor
boolean	hasNode(Name name) checks if the given child node exists.
boolean	hasNode(NodeId id) Checks if the given node state exists
boolean	hasProperty(Name name) Checks if the given property exists
boolean	hasProperty(PropertyId id) Checks if the given property state exists
NodeStateEx	moveFrom(NodeStateEx src, Name name, boolean createShare) Moves the source node to this node using the given name.
void	reload() reloads the persistent state recursively
boolean	removeNode(ChildNodeEntry entry) removes the child node with the given child node entry
boolean	removeNode(Name name) removes the (first) child node with the given name.
boolean	removeNode(Name name, int index) removes the child node with the given name and 1-based index
boolean	removeNode(NodeStateEx node) removes the given child node
boolean	removeProperty(Name name) removes the property with the given name
void	setMixins(Set<Name> mixinTypeNames) Sets the given mixin types
void	setPropertyValue(Name name, InternalValue value) Sets the property value
void	setPropertyValues(Name name, int type, InternalValue[] values) Sets the property values
PropertyState	setPropertyValues(Name name, int type, InternalValue[] values, boolean multiple) Sets the property values
void	store() stores the persistent state recursively
void	store(boolean recursively) Stores the persistent state and depending on the recursively flag also stores the modified child nodes recursively.

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeStateEx

public NodeStateEx(UpdatableItemStateManager stateMgr,
           NodeTypeRegistry ntReg,
           NodeState nodeState,
           Name name)

Creates a new persistent node

Parameters:

stateMgr - state manager

ntReg - node type registry

nodeState - underlying node state

name - name (can be null)

NodeStateEx

public NodeStateEx(UpdatableItemStateManager stateMgr,
           NodeTypeRegistry ntReg,
           NodeId nodeId)
            throws javax.jcr.RepositoryException

Creates a new persistent node

Parameters:

stateMgr - state manager

ntReg - node type registry

nodeId - node id

Throws:

javax.jcr.RepositoryException - if the node state can't be loaded

Method Detail

getName

public Name getName()

returns the name of this node

Returns:

the name of this node

getNodeId

public NodeId getNodeId()

Returns the id of this node.

Returns:

the id of this node.

getParentId

public NodeId getParentId()

Returns the parent id of this node

Returns:

the parent id of this node

getParent

public NodeStateEx getParent()
                      throws javax.jcr.RepositoryException

Returns the parent node of this node

Returns:

the parent node of this node or null if root node

Throws:

javax.jcr.RepositoryException - if an error occurs

getState

public NodeState getState()

Returns the underlaying node state.

Returns:

the underlaying node state.

getProperties

public PropertyState[] getProperties()
                              throws ItemStateException

Returns the properties of this node

Returns:

the properties of this node

Throws:

ItemStateException - if an error occurs

hasProperty

public boolean hasProperty(Name name)

Checks if the given property exists

Parameters:

name - name of the property

Returns:

true if the given property exists.

getPropertyValues

public InternalValue[] getPropertyValues(Name name)

Returns the values of the given property or null

Parameters:

name - name of the property

Returns:

the values of the given property.

getPropertyValue

public InternalValue getPropertyValue(Name name)

Returns the value of the given property or null

Parameters:

name - name of the property

Returns:

the value of the given property.

setPropertyValue

public void setPropertyValue(Name name,
                    InternalValue value)
                      throws javax.jcr.RepositoryException

Sets the property value

Parameters:

name - name of the property

value - value to set

Throws:

javax.jcr.RepositoryException - if an error occurs

setPropertyValues

public void setPropertyValues(Name name,
                     int type,
                     InternalValue[] values)
                       throws javax.jcr.RepositoryException

Sets the property values

Parameters:

name - name of the property

type - property type

values - values to set

Throws:

javax.jcr.RepositoryException - if an error occurs

setPropertyValues

public PropertyState setPropertyValues(Name name,
                              int type,
                              InternalValue[] values,
                              boolean multiple)
                                throws javax.jcr.RepositoryException

Sets the property values

Parameters:

name - name of the property

type - type of the values

values - values to set

multiple - truefor MV properties

Returns:

the modified property state

Throws:

javax.jcr.RepositoryException - if an error occurs

getEffectiveNodeType

public EffectiveNodeType getEffectiveNodeType()
                                       throws javax.jcr.RepositoryException

Returns the effective (i.e. merged and resolved) node type representation of this node's primary and mixin node types.

Returns:

the effective node type

Throws:

javax.jcr.RepositoryException - if an error occurs

hasNode

public boolean hasNode(Name name)

checks if the given child node exists.

Parameters:

name - name of the node

Returns:

true if the given child exists.

removeNode

public boolean removeNode(Name name)
                   throws javax.jcr.RepositoryException

removes the (first) child node with the given name.

Parameters:

name - name of the node

Returns:

true if the child was removed

Throws:

javax.jcr.RepositoryException - if an error occurs

removeNode

public boolean removeNode(NodeStateEx node)
                   throws javax.jcr.RepositoryException

removes the given child node

Parameters:

node - child node to remove

Returns:

true if the child was removed

Throws:

javax.jcr.RepositoryException - if an error occurs

removeNode

public boolean removeNode(Name name,
                 int index)
                   throws javax.jcr.RepositoryException

removes the child node with the given name and 1-based index

Parameters:

name - name of the child node

index - index of the child node

Returns:

true if the child was removed.

Throws:

javax.jcr.RepositoryException - if an error occurs

removeNode

public boolean removeNode(ChildNodeEntry entry)
                   throws javax.jcr.RepositoryException

removes the child node with the given child node entry

Parameters:

entry - entry to remove

Returns:

true if the child was removed.

Throws:

javax.jcr.RepositoryException - if an error occurs

removeProperty

public boolean removeProperty(Name name)
                       throws javax.jcr.RepositoryException

removes the property with the given name

Parameters:

name - name of the property

Returns:

true if the property was removed.

Throws:

javax.jcr.RepositoryException - if an error occurs

getNode

public NodeStateEx getNode(Name name,
                  int index)
                    throws javax.jcr.RepositoryException

retrieves the child node with the given name and 1-base index or null if the node does not exist.

Parameters:

name - name of the child node

index - index of the child node

Returns:

the node state.

Throws:

javax.jcr.RepositoryException - if an error occurs

getNode

public NodeStateEx getNode(NodeId id)
                    throws javax.jcr.RepositoryException

Returns the node with the given id.

Parameters:

id - node id

Returns:

the new node state

Throws:

javax.jcr.RepositoryException - if an error occurs

hasNode

public boolean hasNode(NodeId id)

Checks if the given node state exists

Parameters:

id - node id

Returns:

true if the node state exists

hasProperty

public boolean hasProperty(PropertyId id)

Checks if the given property state exists

Parameters:

id - property id

Returns:

true if the property state exists

addNode

public NodeStateEx addNode(Name nodeName,
                  Name nodeTypeName,
                  NodeId id)
                    throws javax.jcr.nodetype.NoSuchNodeTypeException,
                           javax.jcr.nodetype.ConstraintViolationException,
                           javax.jcr.RepositoryException

Adds a new child node with the given name

Parameters:

nodeName - name of the new node

nodeTypeName - node type name

id - id of the new node

Returns:

the node state

Throws:

javax.jcr.nodetype.NoSuchNodeTypeException - if the node type does not exist

javax.jcr.nodetype.ConstraintViolationException - if there is a constraint violation

javax.jcr.RepositoryException - if an error occurs

addNode

public NodeStateEx addNode(Name nodeName,
                  Name nodeTypeName,
                  NodeId id,
                  boolean referenceable)
                    throws javax.jcr.nodetype.NoSuchNodeTypeException,
                           javax.jcr.nodetype.ConstraintViolationException,
                           javax.jcr.RepositoryException

Adds a new child node with the given name

Parameters:

nodeName - name of the new node

nodeTypeName - node type name

id - id of the new node

referenceable - if true, a UUID property is created

Returns:

the node state

Throws:

javax.jcr.nodetype.NoSuchNodeTypeException - if the node type does not exist

javax.jcr.nodetype.ConstraintViolationException - if there is a constraint violation

javax.jcr.RepositoryException - if an error occurs

setMixins

public void setMixins(Set<Name> mixinTypeNames)
               throws javax.jcr.RepositoryException

Sets the given mixin types

Parameters:

mixinTypeNames - the mixin type names

Throws:

javax.jcr.RepositoryException - if an error occurs

moveFrom

public NodeStateEx moveFrom(NodeStateEx src,
                   Name name,
                   boolean createShare)
                     throws javax.jcr.RepositoryException

Moves the source node to this node using the given name.

Parameters:

src - shareable source node

name - name of new node

createShare - if true a share is created instead.

Returns:

child node

Throws:

javax.jcr.RepositoryException - if an error occurs

getChildNodes

public NodeStateEx[] getChildNodes()
                            throws javax.jcr.RepositoryException

returns all child nodes

Returns:

the child nodes.

Throws:

javax.jcr.RepositoryException - if an error occurs

store

public void store()
           throws javax.jcr.RepositoryException

stores the persistent state recursively

Throws:

javax.jcr.RepositoryException - if an error occurs

store

public void store(boolean recursively)
           throws javax.jcr.RepositoryException

Stores the persistent state and depending on the recursively flag also stores the modified child nodes recursively.

Parameters:

recursively - whether to store the nodes recursively or just this single node.

Throws:

javax.jcr.RepositoryException - if an error occurs

reload

public void reload()
            throws javax.jcr.RepositoryException

reloads the persistent state recursively

Throws:

javax.jcr.RepositoryException - if an error occurs

copyFrom

public void copyFrom(PropertyImpl prop)
              throws javax.jcr.RepositoryException

copies a property

Parameters:

prop - source property

Throws:

javax.jcr.RepositoryException - if an error occurs

copyFrom

public void copyFrom(PropertyState prop)
              throws javax.jcr.RepositoryException

copies a property

Parameters:

prop - source property

Throws:

javax.jcr.RepositoryException - if an error occurs

getDefinition

public QNodeDefinition getDefinition()
                              throws javax.jcr.RepositoryException

Returns the QNodeDefinition for this state

Returns:

the node def

Throws:

javax.jcr.RepositoryException - if an error occurs

getDefinition

public QPropertyDefinition getDefinition(PropertyState prop)
                                  throws javax.jcr.RepositoryException

Returns the property definition for the property state

Parameters:

prop - the property state

Returns:

the prop def

Throws:

javax.jcr.RepositoryException - if an error occurs

hasAncestor

public boolean hasAncestor(NodeId nodeId)
                    throws javax.jcr.RepositoryException

Checks if this state has the indicated ancestor

Parameters:

nodeId - the node id of the ancestor

Returns:

true if it has the indicated ancestor

Throws:

javax.jcr.RepositoryException - if an error occurs