GraphNode (Clerezza - Reactor build (root) 0.3-SNAPSHOT API)

java.lang.Object
- org.apache.clerezza.rdf.utils.GraphNode

```
public class GraphNode
extends Object
```
This class represents a node in the context of a graph. It provides utility methods to explore and modify its neighbourhood. The method modifying the graph will throw an UnsupportedOperationException it the underlying TripleCollection in immutable (i.e. is a Graph.

Since:

0.2

Author:

reto, mir

Constructor Summary

Constructors
Constructor and Description

GraphNode(Resource resource, TripleCollection graph)
Create a GraphNode representing resource within graph.

Constructors
Constructor and Description
`GraphNode(Resource resource, TripleCollection graph)` Create a GraphNode representing resource within graph.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addInverseProperty(UriRef predicate, Resource subject)` Adds a property to the node with the inverse of the specified predicate and object In other words `subject` will be related via the property `relation` to this node.
`void`	`addProperty(UriRef predicate, Resource object)` Adds a property to the node with the specified predicate and object
`void`	`addPropertyValue(UriRef property, Object value)` Coverts the value into a typed literals and sets it as object of the specified property
`List<Resource>`	`asList()` creates and returns an `RdfList` for the node and TripleCollection represented by this object.
`int`	`countObjects(UriRef property)` Count the number of triples in the underlying triple-collection with this node as subject and a specified property as predicate.
`int`	`countSubjects(UriRef property)` Count the number of triples in the underlying triple-collection with this node as object and a specified property as predicate.
`void`	`deleteNodeContext()` Deletes the context of a node
`void`	`deleteProperties(UriRef predicate)` Deletes all statement with the current node as subject and the specified predicate
`void`	`deleteProperty(UriRef predicate, Resource object)` Delete property to the node with the specified predicate and object
`boolean`	`equals(Object obj)`
`TripleCollection`	`getGraph()` Gets the graph the node represented by this instance is in
`Iterator<UriRef>`	`getInverseProperties()` Get all inverse properties as an `Iterator`<`UriRef`>.
`Iterator<Literal>`	`getLiterals(UriRef property)`
`Resource`	`getNode()` Gets the unwrapped node
`Graph`	`getNodeContext()` The context of a node are the triples containing a node as subject or object and recursively the context of the b-nodes in any of these statements.
`Iterator<GraphNode>`	`getObjectNodes(UriRef property)` Returns a iterator containing all objects of the triples where this graph node is the subject and has the specified property.
`Iterator<Resource>`	`getObjects(UriRef property)` Get the objects of statements with this node as subject and a specified property as predicate.
`Iterator<UriRef>`	`getProperties()` Get all available properties as an `Iterator`<`UriRef`>.
`Iterator<GraphNode>`	`getSubjectNodes(UriRef property)` Returns a iterator containing all subjects of the triples where this graph node is the object and has the specified property.
`Iterator<NonLiteral>`	`getSubjects(UriRef property)` Get the subjects of statements with this node as object and a specified property as predicate.
`Iterator<UriRef>`	`getUriRefObjects(UriRef property)`
`int`	`hashCode()`
`boolean`	`hasProperty(UriRef property, Resource object)` Checks wether this node has the given property with the given value.
`java.util.concurrent.locks.Lock`	`readLock()`
`GraphNode`	`replaceWith(NonLiteral replacement)` Replaces the graph node resouce with the specified `NonLiteral`.
`GraphNode`	`replaceWith(NonLiteral replacement, boolean checkPredicates)` Replaces the graph node resouce with the specified `NonLiteral`.
`String`	`toString()`
`java.util.concurrent.locks.Lock`	`writeLock()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GraphNode
```
public GraphNode(Resource resource,
         TripleCollection graph)
```
    Create a GraphNode representing resource within graph.
    
    Parameters:
    resource - the resource this GraphNode represents
    graph - the TripleCollection that describes the resource
- Method Detail
  - getGraph
```
public TripleCollection getGraph()
```
    Gets the graph the node represented by this instance is in
    
    Returns:
    the graph of this GraphNode
  - getNode
```
public Resource getNode()
```
    Gets the unwrapped node
    
    Returns:
    the node represented by this GraphNode
  - deleteNodeContext
```
public void deleteNodeContext()
```
    Deletes the context of a node
    
    See Also:
    getNodeContext()
  - getNodeContext
```
public Graph getNodeContext()
```
    The context of a node are the triples containing a node as subject or object and recursively the context of the b-nodes in any of these statements. The triples in the Graph returned by this method contain the same bnode instances as in the original graph.
    
    Returns:
    the context of the node represented by the instance
  - getLiterals
```
public Iterator<Literal> getLiterals(UriRef property)
```
  - countObjects
```
public int countObjects(UriRef property)
```
    Count the number of triples in the underlying triple-collection with this node as subject and a specified property as predicate.
    
    Parameters:
    property - the property to be examined
    
    Returns:
    the number of triples in the underlying triple-collection which meet the specified condition
  - getObjects
```
public Iterator<Resource> getObjects(UriRef property)
```
    Get the objects of statements with this node as subject and a specified property as predicate.
    
    Parameters:
    property - the property
    
    Returns:
  - hasProperty
```
public boolean hasProperty(UriRef property,
                  Resource object)
```
    Checks wether this node has the given property with the given value. If the given value is null, then it is checked if this node has the specified property regardless of its value.
    
    Parameters:
    property -
    object -
    
    Returns:
    true if the node represented by this object is the subject of a statement with the given prediate and object, false otherwise
  - countSubjects
```
public int countSubjects(UriRef property)
```
    Count the number of triples in the underlying triple-collection with this node as object and a specified property as predicate.
    
    Parameters:
    property - the property to be examined
    
    Returns:
    the number of triples in the underlying triple-collection which meet the specified condition
  - getSubjects
```
public Iterator<NonLiteral> getSubjects(UriRef property)
```
    Get the subjects of statements with this node as object and a specified property as predicate.
    
    Parameters:
    property - the property
    
    Returns:
  - getUriRefObjects
```
public Iterator<UriRef> getUriRefObjects(UriRef property)
```
  - getProperties
```
public Iterator<UriRef> getProperties()
```
    Get all available properties as an Iterator<UriRef>. You can use getObjects(UriRef property) to get the values of each property
    
    Returns:
    an iterator over properties of this node
  - getInverseProperties
```
public Iterator<UriRef> getInverseProperties()
```
    Get all inverse properties as an Iterator<UriRef>. You can use getSubject(UriRef property) to get the values of each inverse property
    
    Returns:
    an iterator over properties pointing to this node
  - addProperty
```
public void addProperty(UriRef predicate,
               Resource object)
```
    Adds a property to the node with the specified predicate and object
    
    Parameters:
    predicate -
    object -
  - addPropertyValue
```
public void addPropertyValue(UriRef property,
                    Object value)
```
    Coverts the value into a typed literals and sets it as object of the specified property
    
    Parameters:
    property - the predicate of the triple to be created
    value - the value of the typed literal object
  - addInverseProperty
```
public void addInverseProperty(UriRef predicate,
                      Resource subject)
```
    Adds a property to the node with the inverse of the specified predicate and object In other words subject will be related via the property relation to this node.
    
    Parameters:
    predicate -
    subject -
  - asList
```
public List<Resource> asList()
```
    creates and returns an RdfList for the node and TripleCollection represented by this object.
    
    Returns:
    a List to easy access the rdf:List represented by this node
  - deleteProperties
```
public void deleteProperties(UriRef predicate)
```
    Deletes all statement with the current node as subject and the specified predicate
    
    Parameters:
    predicate -
  - deleteProperty
```
public void deleteProperty(UriRef predicate,
                  Resource object)
```
    Delete property to the node with the specified predicate and object
    
    Parameters:
    predicate -
    object -
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - replaceWith
```
public GraphNode replaceWith(NonLiteral replacement)
```
    Replaces the graph node resouce with the specified NonLiteral. The resource is only replaced where it is either subject or object.
    
    Parameters:
    replacement -
    
    Returns:
    a GraphNode representing the replecement node
  - replaceWith
```
public GraphNode replaceWith(NonLiteral replacement,
                    boolean checkPredicates)
```
    Replaces the graph node resouce with the specified NonLiteral. Over the boolean checkPredicate it can be specified if the resource should also be replaced where it is used as predicate.
    
    Parameters:
    replacement -
    checkPredicates -
    
    Returns:
    a GraphNode representing the replecement node
  - getObjectNodes
```
public Iterator<GraphNode> getObjectNodes(UriRef property)
```
    Returns a iterator containing all objects of the triples where this graph node is the subject and has the specified property. The objects are returned as GraphNodes.
    
    Parameters:
    property -
    
    Returns:
  - getSubjectNodes
```
public Iterator<GraphNode> getSubjectNodes(UriRef property)
```
    Returns a iterator containing all subjects of the triples where this graph node is the object and has the specified property. The subjects are returned as GraphNodes.
    
    Parameters:
    property -
    
    Returns:
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj -
    
    Returns:
    true if obj is an instance of the same class represening the same node in the same graph, subclasses may have different identity criteria.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - readLock
```
public java.util.concurrent.locks.Lock readLock()
```
    Returns:
    a ReadLock if the underlying Graph is a LockableMGraph it returns its lock, otherwise null
  - writeLock
```
public java.util.concurrent.locks.Lock writeLock()
```
    Returns:

Class GraphNode

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GraphNode

Method Detail

getGraph

getNode

deleteNodeContext

getNodeContext

getLiterals

countObjects

getObjects

hasProperty

countSubjects

getSubjects

getUriRefObjects

getProperties

getInverseProperties

addProperty

addPropertyValue

addInverseProperty

asList

deleteProperties

deleteProperty

toString

replaceWith

replaceWith

getObjectNodes

getSubjectNodes

equals

hashCode

readLock

writeLock