org.jboss.dna.graph.requests
Class ReadNodeRequest

java.lang.Object
  org.jboss.dna.graph.requests.Request
      org.jboss.dna.graph.requests.CacheableRequest
          org.jboss.dna.graph.requests.ReadNodeRequest

All Implemented Interfaces:

Serializable, Iterable<Location>, Cacheable

Direct Known Subclasses:

FederatedNode

public class ReadNodeRequest
extends CacheableRequest
implements Iterable<Location>

Instruction to read the properties and children of the node at the specifed location.

Author:

Randall Hauch

See Also:

Serialized Form

Constructor Summary

ReadNodeRequest(Location at)
Create a request to read the properties and number of children of a node at the supplied location.

Method Summary

void	addChild(Location child) Add to the list of children that has been read the child with the given path and identification properties.
void	addChild(Path pathToChild, Property idProperty) Add to the list of children that has been read the child with the given path and identification property.
void	addChild(Path pathToChild, Property firstIdProperty, Property... remainingIdProperties) Add to the list of children that has been read the child with the given path and identification properties.
void	addProperties(Property... properties) Add a property that was read from the RepositoryConnection
Property	addProperty(Property property) Add a property that was read from the RepositoryConnection
Location	at() Get the location defining the node that is to be read.
boolean	equals(Object obj)
Location	getActualLocationOfNode() Get the actual location of the node whose children and properties were read.
List<Location>	getChildren() Get the children that were read from the RepositoryConnection after the request was processed.
Collection<Property>	getProperties() Get the properties that were read from the RepositoryConnection.
Map<Name,Property>	getPropertiesByName() Get the properties that were read from the RepositoryConnection.
boolean	isReadOnly() Return whether this request only reads information.
Iterator<Location>	iterator()
void	setActualLocationOfNode(Location actual) Sets the actual and complete location of the node whose children and properties have been read.
String	toString()

Methods inherited from class org.jboss.dna.graph.requests.CacheableRequest

getCachePolicy, getTimeLoaded, setCachePolicy, setTimeLoaded

Methods inherited from class org.jboss.dna.graph.requests.Request

cancel, getError, hasError, isCancelled, setError

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReadNodeRequest

public ReadNodeRequest(Location at)

Create a request to read the properties and number of children of a node at the supplied location.

Parameters:

at - the location of the node to be read

Throws:

IllegalArgumentException - if the location is null

Method Detail

isReadOnly

public boolean isReadOnly()

Return whether this request only reads information.

Specified by:

isReadOnly in class Request

Returns:

true if this request reads information, or false if it requests that the repository content be changed in some way

See Also:

Request.isReadOnly()

at

public Location at()

Get the location defining the node that is to be read.

Returns:

the location of the node; never null

getPropertiesByName

public Map<Name,Property> getPropertiesByName()

Get the properties that were read from the RepositoryConnection.

Returns:

the properties, as a map of property name to property; never null

getProperties

public Collection<Property> getProperties()

Get the properties that were read from the RepositoryConnection.

Returns:

the collection of properties; never null

addProperty

public Property addProperty(Property property)

Add a property that was read from the RepositoryConnection

Parameters:

property - the property that was read

Returns:

the previous property that had the same name, or null if there was no previously-recorded property with the same name

Throws:

IllegalArgumentException - if the property is null

addProperties

public void addProperties(Property... properties)

Add a property that was read from the RepositoryConnection

Parameters:

properties - the properties that were read

Throws:

IllegalArgumentException - if the property is null

getChildren

public List<Location> getChildren()

Get the children that were read from the RepositoryConnection after the request was processed. Each child is represented by a location.

Returns:

the children that were read; never null

iterator

public Iterator<Location> iterator()

Specified by:

iterator in interface Iterable<Location>

See Also:

Iterable.iterator()

addChild

public void addChild(Location child)

Add to the list of children that has been read the child with the given path and identification properties. The children should be added in order.

Parameters:

child - the location of the child that was read

Throws:

IllegalArgumentException - if the location is null

See Also:

addChild(Path, Property), addChild(Path, Property, Property...)

addChild

public void addChild(Path pathToChild,
                     Property firstIdProperty,
                     Property... remainingIdProperties)

Add to the list of children that has been read the child with the given path and identification properties. The children should be added in order.

Parameters:

pathToChild - the path of the child that was just read

firstIdProperty - the first identification property of the child that was just read

remainingIdProperties - the remaining identification properties of the child that was just read

Throws:

IllegalArgumentException - if the path or identification properties are null

See Also:

addChild(Location), addChild(Path, Property)

addChild

public void addChild(Path pathToChild,
                     Property idProperty)

Add to the list of children that has been read the child with the given path and identification property. The children should be added in order.

Parameters:

pathToChild - the path of the child that was just read

idProperty - the identification property of the child that was just read

Throws:

IllegalArgumentException - if the path or identification properties are null

See Also:

addChild(Location), addChild(Path, Property, Property...)

setActualLocationOfNode

public void setActualLocationOfNode(Location actual)

Sets the actual and complete location of the node whose children and properties have been read. This method must be called when processing the request, and the actual location must have a path.

Parameters:

actual - the actual location of the node being read, or null if the current location should be used

Throws:

IllegalArgumentException - if the actual location does not represent the same location as the current location, or if the actual location does not have a path.

getActualLocationOfNode

public Location getActualLocationOfNode()

Get the actual location of the node whose children and properties were read.

Returns:

the actual location, or null if the actual location was not set

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()