org.jboss.dna.graph
Class Graph

java.lang.Object
  org.jboss.dna.graph.Graph

@NotThreadSafe
public class Graph
extends Object

A graph representation of the content within a RepositorySource, including mechanisms to interact and manipulate that content. The graph is designed to be an embedded domain specific language, meaning calls to it are designed to read like sentences even though they are really just Java methods. And to be more readable, methods can be chained together.

Author:

Randall Hauch

Nested Class Summary

static interface	Graph.And<Next> A interface that is used to add more locations that are to be copied/moved.
static interface	Graph.At<Next> The interface for defining the node upon which which a request operates.
class	Graph.Batch Interface for creating multiple requests to perform various operations.
static interface	Graph.BatchConjunction
static interface	Graph.Conjunction<Next> A interface that can be used to finish the current request and start another.
static interface	Graph.Copy<Next> The interface for defining additional nodes to be copied and the parent into which the node(s) are to be copied. where the node(s) are to be moved.
static interface	Graph.Create<Next> The interface for defining additional properties on a new node.
static interface	Graph.Executable A interface used to execute the accumulated requests.
static interface	Graph.ImportInto<Next> A component that defines the location into which a node should be copied or moved.
static interface	Graph.Into<Next> A component that defines the location into which a node should be copied or moved.
static interface	Graph.Move<Next> The interface for defining additional nodes to be moved and the parent into which the node(s) are to be moved.
static interface	Graph.Of<Next> The interface for defining the node upon which a request operates.
static interface	Graph.On<Next> The interface for defining the node upon which a request operates.

Method Summary

Graph.Batch	batch() Begin a batch of requests to perform various operations.
Graph.Copy<Graph>	copy(Location from) Begin the request to copy a node at the specified location into a parent node at a different location, which is specified via the into(...)
Graph.Copy<Graph>	copy(Node from) Begin the request to copy the specified node into a parent node at a different location, which is specified via the into(...)
Graph.Copy<Graph>	copy(Path from) Begin the request to copy a node located at the supplied path into a parent node at a different location, which is specified via the into(...)
Graph.Copy<Graph>	copy(Property idProperty) Begin the request to copy a node with the specified unique identification property into a parent node at a different location, which is specified via the into(...)
Graph.Copy<Graph>	copy(Property firstIdProperty, Property... additionalIdProperties) Begin the request to copy a node with the specified identification properties into a parent node at a different location, which is specified via the into(...)
Graph.Copy<Graph>	copy(String fromPath) Begin the request to copy a node located at the supplied path into a parent node at a different location, which is specified via the into(...)
Graph.Copy<Graph>	copy(UUID from) Begin the request to copy a node with the specified unique identifier into a parent node at a different location, which is specified via the into(...)
Graph.Conjunction<Graph>	create(Path at) Begin the request to create a node located at the supplied path.
Graph.Conjunction<Graph>	create(Path at, Iterable<Property> properties) Begin the request to create a node located at the supplied path.
Graph.Conjunction<Graph>	create(Path at, Property... properties) Begin the request to create a node located at the supplied path.
Graph.Conjunction<Graph>	create(String atPath) Begin the request to create a node located at the supplied path.
Graph.Conjunction<Graph>	create(String atPath, Property... properties) Begin the request to create a node located at the supplied path.
static Graph	create(String sourceName, RepositoryConnectionFactory connectionFactory, ExecutionContext context) Create a graph instance that uses the supplied repository and context.
Graph.Conjunction<Graph>	delete(Location at) Request to delete the node at the given location.
Graph.Conjunction<Graph>	delete(Node at) Request to delete the specified node.
Graph.Conjunction<Graph>	delete(Path at) Request to delete the node at the given path.
Graph.Conjunction<Graph>	delete(Property idProperty) Request to delete the node with the given unique identification property.
Graph.Conjunction<Graph>	delete(Property firstIdProperty, Property... additionalIdProperties) Request to delete the node with the given identification properties.
Graph.Conjunction<Graph>	delete(String atPath) Request to delete the node at the given path.
Graph.Conjunction<Graph>	delete(UUID at) Request to delete the node with the given UUID.
Graph.Of<List<Location>>	getChildren() Request that the children be read on the node defined via the of(...)
Graph.Of<List<Location>>	getChildrenInBlock(int startingIndex, int blockSize) Request that the children in the specified block be read on the node defined via the of(...)
Graph.Of<List<Location>>	getChildrenInRange(int startingIndex, int endingIndex) Request that the children in the specified index range be read on the node defined via the of(...)
RepositoryConnectionFactory	getConnectionFactory() Get the RepositoryConnectionFactory that this graph uses to create repository connections.
ExecutionContext	getContext() Get the context of execution within which operations on this graph are performed.
CachePolicy	getDefaultCachePolicy() Get the default cache policy for this graph.
Node	getNodeAt(Location location) Request to read the node at the supplied location.
Node	getNodeAt(Path path) Request to read the node at the supplied path.
Node	getNodeAt(Property idProperty) Request to read the node with the supplied unique identifier property.
Node	getNodeAt(Property firstIdProperty, Property... additionalIdProperties) Request to read the node with the supplied unique identifier properties.
Node	getNodeAt(String path) Request to read the node at the supplied path.
Node	getNodeAt(UUID uuid) Request to read the node with the supplied UUID.
Graph.On<Collection<Property>>	getProperties() Request that the properties be read on the node defined via the on(...)
Graph.On<Map<Name,Property>>	getPropertiesByName() Request that the properties be read on the node defined via the on(...)
Graph.On<Property>	getProperty(Name name) Request that the property with the given name be read on the node defined via the on(...)
Graph.On<Property>	getProperty(String name) Request that the property with the given name be read on the node defined via the on(...)
String	getSourceName() The name of the repository that will be used by this graph.
Graph.At<Subgraph>	getSubgraphOfDepth(int depth) Request to read a subgraph of the specified depth, rooted at a location that will be specified via at(...)
Graph.ImportInto<Graph.Conjunction<Graph>>	importXmlFrom(File file) Import the content from the XML file at the supplied file, specifying via the returned object where the content is to be imported.
Graph.ImportInto<Graph.Conjunction<Graph>>	importXmlFrom(String pathToFile) Import the content from the XML file at the supplied file location, specifying via the returned object where the content is to be imported.
Graph.ImportInto<Graph.Conjunction<Graph>>	importXmlFrom(URI uri) Import the content from the XML file at the supplied URI, specifying via the returned object where the content is to be imported.
Graph.Move<Graph.Conjunction<Graph>>	move(Location from) Begin the request to move a node at the specified location into a parent node at a different location, which is specified via the into(...)
Graph.Move<Graph.Conjunction<Graph>>	move(Node from) Begin the request to move the specified node into a parent node at a different location, which is specified via the into(...)
Graph.Move<Graph.Conjunction<Graph>>	move(Path from) Begin the request to move a node located at the supplied path into a parent node at a different location, which is specified via the into(...)
Graph.Move<Graph.Conjunction<Graph>>	move(Property idProperty) Begin the request to move a node with the specified unique identification property into a parent node at a different location, which is specified via the into(...)
Graph.Move<Graph.Conjunction<Graph>>	move(Property firstIdProperty, Property... additionalIdProperties) Begin the request to move a node with the specified identification properties into a parent node at a different location, which is specified via the into(...)
Graph.Move<Graph.Conjunction<Graph>>	move(String fromPath) Begin the request to move a node located at the supplied path into a parent node at a different location, which is specified via the into(...)
Graph.Move<Graph.Conjunction<Graph>>	move(UUID from) Begin the request to move a node with the specified unique identifier into a parent node at a different location, which is specified via the into(...)
Graph.On<Graph.Conjunction<Graph>>	remove(Name... propertyNames) Remove properties from the node at the given location.
Graph.On<Graph.Conjunction<Graph>>	remove(String... propertyNames) Remove properties from the node at the given location.
Graph.On<Graph.Conjunction<Graph>>	set(Property... properties) Set the properties on a node.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Graph create(String sourceName,
                           RepositoryConnectionFactory connectionFactory,
                           ExecutionContext context)

Create a graph instance that uses the supplied repository and context.

Parameters:

sourceName - the name of the source that should be used

connectionFactory - the factory of repository connections

context - the context in which all executions should be performed

Returns:

the new graph

Throws:

IllegalArgumentException - if the source or context parameters are null

getConnectionFactory

public RepositoryConnectionFactory getConnectionFactory()

Get the RepositoryConnectionFactory that this graph uses to create repository connections.

Returns:

the factory repository connections used by this graph; never null

getSourceName

public String getSourceName()

The name of the repository that will be used by this graph. This name is passed to the connection factory when this graph needs to obtain a repository connection.

Returns:

the name of the source

getContext

public ExecutionContext getContext()

Get the context of execution within which operations on this graph are performed.

Returns:

the execution context; never null

getDefaultCachePolicy

public CachePolicy getDefaultCachePolicy()

Get the default cache policy for this graph. May be null if such a policy has not been defined for thie source.

Returns:

the default cache policy, or null if no such policy has been defined for the source

Throws:

RepositorySourceException - if no repository source with the name could be found

move

public Graph.Move<Graph.Conjunction<Graph>> move(Node from)

Begin the request to move the specified node into a parent node at a different location, which is specified via the into(...) method on the returned Graph.Move object.

Like all other methods on the Graph, the move request will be performed immediately when the into(...) method is called.

Parameters:

from - the node that is to be moved.

Returns:

the object that can be used to specify addition nodes to be moved or the location of the node where the node is to be moved

move

public Graph.Move<Graph.Conjunction<Graph>> move(Location from)

Begin the request to move a node at the specified location into a parent node at a different location, which is specified via the into(...) method on the returned Graph.Move object.

Like all other methods on the Graph, the move request will be performed immediately when the into(...) method is called.

Parameters:

from - the location of the node that is to be moved.

Returns:

the object that can be used to specify addition nodes to be moved or the location of the node where the node is to be moved

move

public Graph.Move<Graph.Conjunction<Graph>> move(String fromPath)

Begin the request to move a node located at the supplied path into a parent node at a different location, which is specified via the into(...) method on the returned Graph.Move object.

Like all other methods on the Graph, the move request will be performed immediately when the into(...) method is called.

Parameters:

fromPath - the path to the node that is to be moved.

Returns:

the object that can be used to specify addition nodes to be moved or the location of the node where the node is to be moved

move

public Graph.Move<Graph.Conjunction<Graph>> move(Path from)

Begin the request to move a node located at the supplied path into a parent node at a different location, which is specified via the into(...) method on the returned Graph.Move object.

Like all other methods on the Graph, the move request will be performed immediately when the into(...) method is called.

Parameters:

from - the path to the node that is to be moved.

Returns:

the object that can be used to specify addition nodes to be moved or the location of the node where the node is to be moved

move

public Graph.Move<Graph.Conjunction<Graph>> move(UUID from)

Begin the request to move a node with the specified unique identifier into a parent node at a different location, which is specified via the into(...) method on the returned Graph.Move object.

Like all other methods on the Graph, the move request will be performed immediately when the into(...) method is called.

Parameters:

from - the UUID of the node that is to be moved.

Returns:

the object that can be used to specify addition nodes to be moved or the location of the node where the node is to be moved

move

public Graph.Move<Graph.Conjunction<Graph>> move(Property idProperty)

Begin the request to move a node with the specified unique identification property into a parent node at a different location, which is specified via the into(...) method on the returned Graph.Move object. The identification property should uniquely identify a single node.

Like all other methods on the Graph, the move request will be performed immediately when the into(...) method is called.

Parameters:

idProperty - the unique identification property of the node that is to be moved.

Returns:

the object that can be used to specify addition nodes to be moved or the location of the node where the node is to be moved

move

public Graph.Move<Graph.Conjunction<Graph>> move(Property firstIdProperty,
                                                 Property... additionalIdProperties)

Begin the request to move a node with the specified identification properties into a parent node at a different location, which is specified via the into(...) method on the returned Graph.Move object. The identification properties should uniquely identify a single node.

Like all other methods on the Graph, the move request will be performed immediately when the into(...) method is called.

Parameters:

firstIdProperty - the first identification property of the node that is to be moved

additionalIdProperties - the remaining idenficiation properties of the node that is to be moved

Returns:

the object that can be used to specify addition nodes to be moved or the location of the node where the node is to be moved

copy

public Graph.Copy<Graph> copy(Node from)

Begin the request to copy the specified node into a parent node at a different location, which is specified via the into(...) method on the returned Graph.Copy object.

Like all other methods on the Graph, the copy request will be performed immediately when the into(...) method is called.

Parameters:

from - the node that is to be copied.

Returns:

the object that can be used to specify addition nodes to be copied or the location of the node where the node is to be copied

copy

public Graph.Copy<Graph> copy(Location from)

Begin the request to copy a node at the specified location into a parent node at a different location, which is specified via the into(...) method on the returned Graph.Copy object.

Like all other methods on the Graph, the copy request will be performed immediately when the into(...) method is called.

Parameters:

from - the location of the node that is to be copied.

Returns:

the object that can be used to specify addition nodes to be copied or the location of the node where the node is to be copied

copy

public Graph.Copy<Graph> copy(String fromPath)

Begin the request to copy a node located at the supplied path into a parent node at a different location, which is specified via the into(...) method on the returned Graph.Copy object.

Like all other methods on the Graph, the copy request will be performed immediately when the into(...) method is called.

Parameters:

fromPath - the path to the node that is to be copied.

Returns:

the object that can be used to specify addition nodes to be copied or the location of the node where the node is to be copied

copy

public Graph.Copy<Graph> copy(Path from)

Begin the request to copy a node located at the supplied path into a parent node at a different location, which is specified via the into(...) method on the returned Graph.Copy object.

Like all other methods on the Graph, the copy request will be performed immediately when the into(...) method is called.

Parameters:

from - the path to the node that is to be copied.

Returns:

the object that can be used to specify addition nodes to be copied or the location of the node where the node is to be copied

copy

public Graph.Copy<Graph> copy(UUID from)

Begin the request to copy a node with the specified unique identifier into a parent node at a different location, which is specified via the into(...) method on the returned Graph.Copy object.

Like all other methods on the Graph, the copy request will be performed immediately when the into(...) method is called.

Parameters:

from - the UUID of the node that is to be copied.

Returns:

the object that can be used to specify addition nodes to be copied or the location of the node where the node is to be copied

copy

public Graph.Copy<Graph> copy(Property idProperty)

Begin the request to copy a node with the specified unique identification property into a parent node at a different location, which is specified via the into(...) method on the returned Graph.Copy object. The identification property should uniquely identify a single node.

Like all other methods on the Graph, the copy request will be performed immediately when the into(...) method is called.

Parameters:

idProperty - the unique identification property of the node that is to be copied.

Returns:

the object that can be used to specify addition nodes to be copied or the location of the node where the node is to be copied

copy

public Graph.Copy<Graph> copy(Property firstIdProperty,
                              Property... additionalIdProperties)

Begin the request to copy a node with the specified identification properties into a parent node at a different location, which is specified via the into(...) method on the returned Graph.Copy object. The identification properties should uniquely identify a single node.

Like all other methods on the Graph, the copy request will be performed immediately when the into(...) method is called.

Parameters:

firstIdProperty - the first identification property of the node that is to be copied

additionalIdProperties - the remaining idenficiation properties of the node that is to be copied

Returns:

the object that can be used to specify addition nodes to be copied or the location of the node where the node is to be copied

delete

public Graph.Conjunction<Graph> delete(Node at)

Request to delete the specified node. This request is submitted to the repository immediately.

Parameters:

at - the node that is to be deleted

Returns:

an object that may be used to start another request

delete

public Graph.Conjunction<Graph> delete(Location at)

Request to delete the node at the given location. This request is submitted to the repository immediately.

Parameters:

at - the location of the node that is to be deleted

Returns:

an object that may be used to start another request

delete

public Graph.Conjunction<Graph> delete(String atPath)

Request to delete the node at the given path. This request is submitted to the repository immediately.

Parameters:

atPath - the path of the node that is to be deleted

Returns:

an object that may be used to start another request

delete

public Graph.Conjunction<Graph> delete(Path at)

Request to delete the node at the given path. This request is submitted to the repository immediately.

Parameters:

at - the path of the node that is to be deleted

Returns:

an object that may be used to start another request

delete

public Graph.Conjunction<Graph> delete(UUID at)

Request to delete the node with the given UUID. This request is submitted to the repository immediately.

Parameters:

at - the UUID of the node that is to be deleted

Returns:

an object that may be used to start another request

delete

public Graph.Conjunction<Graph> delete(Property idProperty)

Request to delete the node with the given unique identification property. This request is submitted to the repository immediately.

Parameters:

idProperty - the unique identifying property of the node that is to be deleted

Returns:

an object that may be used to start another request

delete

public Graph.Conjunction<Graph> delete(Property firstIdProperty,
                                       Property... additionalIdProperties)

Request to delete the node with the given identification properties. The identification properties should uniquely identify a single node. This request is submitted to the repository immediately.

Parameters:

firstIdProperty - the first identification property of the node that is to be copied

additionalIdProperties - the remaining idenficiation properties of the node that is to be copied

Returns:

an object that may be used to start another request

create

public Graph.Conjunction<Graph> create(String atPath)

Begin the request to create a node located at the supplied path. This request is submitted to the repository immediately.

Parameters:

atPath - the path to the node that is to be created.

Returns:

an object that may be used to start another request

create

public Graph.Conjunction<Graph> create(String atPath,
                                       Property... properties)

Begin the request to create a node located at the supplied path. This request is submitted to the repository immediately.

Parameters:

atPath - the path to the node that is to be created.

properties - the properties for the new node

Returns:

an object that may be used to start another request

create

public Graph.Conjunction<Graph> create(Path at)

Begin the request to create a node located at the supplied path. This request is submitted to the repository immediately.

Parameters:

at - the path to the node that is to be created.

Returns:

an object that may be used to start another request

create

public Graph.Conjunction<Graph> create(Path at,
                                       Property... properties)

Begin the request to create a node located at the supplied path. This request is submitted to the repository immediately.

Parameters:

at - the path to the node that is to be created.

properties - the properties for the new node

Returns:

an object that may be used to start another request

create

public Graph.Conjunction<Graph> create(Path at,
                                       Iterable<Property> properties)

Begin the request to create a node located at the supplied path. This request is submitted to the repository immediately.

Parameters:

at - the path to the node that is to be created.

properties - the properties for the new node

Returns:

an object that may be used to start another request

set

public Graph.On<Graph.Conjunction<Graph>> set(Property... properties)

Set the properties on a node.

Parameters:

properties - the properties to set

Returns:

the remove request object that should be used to specify the node on which the properties are to be set.

remove

public Graph.On<Graph.Conjunction<Graph>> remove(Name... propertyNames)

Remove properties from the node at the given location.

Parameters:

propertyNames - the names of the properties to be removed

Returns:

the remove request object that should be used to specify the node from which the properties are to be removed.

remove

public Graph.On<Graph.Conjunction<Graph>> remove(String... propertyNames)

Remove properties from the node at the given location.

Parameters:

propertyNames - the names of the properties to be removed

Returns:

the remove request object that should be used to specify the node from which the properties are to be removed.

getProperties

public Graph.On<Collection<Property>> getProperties()

Request that the properties be read on the node defined via the on(...) method on the returned Graph.On object. Once the location is specified, the collection of properties are read and then returned.

Returns:

the object that is used to specified the node whose properties are to be read, and which will return the properties

getPropertiesByName

public Graph.On<Map<Name,Property>> getPropertiesByName()

Request that the properties be read on the node defined via the on(...) method on the returned Graph.On object. Once the location is specified, the map of properties are read and then returned.

Returns:

the object that is used to specified the node whose properties are to be read, and which will return the properties as a map keyed by their name

getChildren

public Graph.Of<List<Location>> getChildren()

Request that the children be read on the node defined via the of(...) method on the returned Graph.Of object. Once the location is specified, the list of children are read and then returned.

Returns:

the object that is used to specified the node whose children are to be read, and which will return the children

getChildrenInRange

public Graph.Of<List<Location>> getChildrenInRange(int startingIndex,
                                                   int endingIndex)

Request that the children in the specified index range be read on the node defined via the of(...) method on the returned Graph.Of object. Once the location is specified, the list of children are read and then returned.

Parameters:

startingIndex - the index of the first child to be read

endingIndex - the index past the last the first child to be read

Returns:

the object that is used to specified the node whose children are to be read, and which will return the children

getChildrenInBlock

public Graph.Of<List<Location>> getChildrenInBlock(int startingIndex,
                                                   int blockSize)

Request that the children in the specified block be read on the node defined via the of(...) method on the returned Graph.Of object. Once the location is specified, the list of children are read and then returned.

Parameters:

startingIndex - the index of the first child to be read

blockSize - the maximum number of children that should be read

Returns:

the object that is used to specified the node whose children are to be read, and which will return the children

getProperty

public Graph.On<Property> getProperty(String name)

Request that the property with the given name be read on the node defined via the on(...) method on the returned Graph.On object. Once the location is specified, the property is read and then returned.

Parameters:

name - the name of the property that is to be read

Returns:

the object that is used to specified the node whose property is to be read, and which will return the property

getProperty

public Graph.On<Property> getProperty(Name name)

Request that the property with the given name be read on the node defined via the on(...) method on the returned Graph.On object. Once the location is specified, the property is read and then returned.

Parameters:

name - the name of the property that is to be read

Returns:

the object that is used to specified the node whose property is to be read, and which will return the property

getNodeAt

public Node getNodeAt(UUID uuid)

Request to read the node with the supplied UUID.

Parameters:

uuid - the UUID of the node that is to be read

Returns:

the node that is read from the repository

getNodeAt

public Node getNodeAt(Location location)

Request to read the node at the supplied location.

Parameters:

location - the location of the node that is to be read

Returns:

the node that is read from the repository

getNodeAt

public Node getNodeAt(String path)

Request to read the node at the supplied path.

Parameters:

path - the path of the node that is to be read

Returns:

the node that is read from the repository

getNodeAt

public Node getNodeAt(Path path)

Request to read the node at the supplied path.

Parameters:

path - the path of the node that is to be read

Returns:

the node that is read from the repository

getNodeAt

public Node getNodeAt(Property idProperty)

Request to read the node with the supplied unique identifier property.

Parameters:

idProperty - the identification property that is unique to the node that is to be read

Returns:

the node that is read from the repository

getNodeAt

public Node getNodeAt(Property firstIdProperty,
                      Property... additionalIdProperties)

Request to read the node with the supplied unique identifier properties.

Parameters:

firstIdProperty - the first of the identification properties that uniquely identify the node that is to be read

additionalIdProperties - the remaining identification properties that uniquely identify the node that is to be read

Returns:

the node that is read from the repository

getSubgraphOfDepth

public Graph.At<Subgraph> getSubgraphOfDepth(int depth)

Request to read a subgraph of the specified depth, rooted at a location that will be specified via at(...) in the resulting Graph.At object. All properties and children of every node in the subgraph will be read and returned in the Subgraph object returned from the at(...) methods.

Parameters:

depth - the maximum depth of the subgraph that should be read

Returns:

the component that should be used to specify the location of the node that is the top of the subgraph, and which will return the Subgraph containing the results

importXmlFrom

public Graph.ImportInto<Graph.Conjunction<Graph>> importXmlFrom(URI uri)

Import the content from the XML file at the supplied URI, specifying via the returned object where the content is to be imported.

Parameters:

uri - the URI where the importer can read the content that is to be imported

Returns:

the object that should be used to specify into which the content is to be imported

Throws:

IllegalArgumentException - if the uri or destination path are null

importXmlFrom

public Graph.ImportInto<Graph.Conjunction<Graph>> importXmlFrom(String pathToFile)

Import the content from the XML file at the supplied file location, specifying via the returned object where the content is to be imported.

Parameters:

pathToFile - the path to the XML file that should be imported.

Returns:

the object that should be used to specify into which the content is to be imported

Throws:

IllegalArgumentException - if the uri or destination path are null

importXmlFrom

public Graph.ImportInto<Graph.Conjunction<Graph>> importXmlFrom(File file)

Import the content from the XML file at the supplied file, specifying via the returned object where the content is to be imported.

Parameters:

file - the XML file that should be imported.

Returns:

the object that should be used to specify into which the content is to be imported

Throws:

IllegalArgumentException - if the uri or destination path are null

batch

public Graph.Batch batch()

Begin a batch of requests to perform various operations. Use this approach when multiple operations are to be built and then executed with one submission to the underlying repository source. The results are not available until the Graph.Batch.execute() method is invoked.

Returns:

the batch object used to build and accumulate multiple requests and to submit them all for processing at once.

See Also:

Graph.Batch.execute(), Results