org.jrdf.graph
Interface Resource

All Superinterfaces:
BlankNode, Node, ObjectNode, PredicateNode, Serializable, SubjectNode, TypedNodeVisitable, URIReference
All Known Implementing Classes:
AbstractResource, BlankNodeResourceImpl, URIReferenceResourceImpl

public interface Resource
extends URIReference, BlankNode, Serializable

A resource stands for either a Blank Node or a URI Reference. This is a convienence interface designed to make it easier to create triples programmatically.


Method Summary
 void addValue(PredicateNode predicate, ObjectNode object)
          Add a new triple with this as the subject, with the given predicate and object.
 void addValue(URI predicate, Object object)
          Add a new triple with this as the subject, with the given predicate and object.
 void addValue(URI predicate, Resource object)
          Add a new triple with this as the subject, with the given predicate and object.
 void addValue(URI predicate, String lexicalValue)
          Add a new triple with this as the subject, with the given predicate and object.
 void addValue(URI predicate, String lexicalValue, String language)
          Add a new triple with this as the subject, with the given predicate and object.
 void addValue(URI predicate, String lexicalValue, URI dataType)
          Add a new triple with this as the subject, with the given predicate and object.
 void addValue(URI predicate, URI object)
          Add a new triple with this as the subject, with the given predicate and object.
 Triple asTriple(PredicateNode predicate, ObjectNode object)
           
 Triple asTriple(URI predicate, Object object)
           
 Triple asTriple(URI predicate, Resource object)
           
 Triple asTriple(URI predicate, String lexicalValue)
           
 Triple asTriple(URI predicate, String lexicalValue, String language)
           
 Triple asTriple(URI predicate, String lexicalValue, URI dataType)
           
 Triple asTriple(URI predicate, URI object)
           
 boolean containsTriple(PredicateNode predicate, ObjectNode object)
           
 ClosableIterator<ObjectNode> getObjects(PredicateNode predicate)
          With this as the subject and using the given predicate return all the objects.
 ClosableIterator<ObjectNode> getObjects(URI predicate)
           
 ClosableIterator<SubjectNode> getSubjects(PredicateNode predicate)
          With this as the object and using the given predicate return all the subjects.
 ClosableIterator<SubjectNode> getSubjects(URI predicate)
           
 Node getUnderlyingNode()
          Returns the node that the resource represents - either a BlankNode or a URIReference.
 boolean isURIReference()
          Returns true if this is a URIReference, otherwise it's a BlankNode.
 void removeSubject(SubjectNode subject, PredicateNode predicate)
          Remove the triple with this as the object, the given subject and predicate.
 void removeSubject(URI subject, URI predicate)
           
 void removeValue(PredicateNode predicate, ObjectNode object)
          Remove the triple with this as the subject, the given predicate and object.
 void removeValue(URI predicate, Object object)
           
 void removeValue(URI predicate, Resource object)
           
 void removeValue(URI predicate, String lexicalValue)
           
 void removeValue(URI predicate, String lexicalValue, String language)
           
 void removeValue(URI predicate, String lexicalValue, URI dataType)
           
 void removeValue(URI predicate, URI object)
           
 void removeValues(PredicateNode predicate)
          Remove all the triples with this as the subject and the given predicate.
 void removeValues(URI predicate)
           
 void setValue(PredicateNode predicate, ObjectNode object)
          Remove any other triples with this as the subject, the given predicate and any object and add a new triple with this as the subject and the given predicate and object.
 void setValue(URI predicate, Object object)
          Removes any other triples with this as the subject, the given predicate and any object and add a new triple with this as the subject and the given predicate and object.
 void setValue(URI predicate, Resource object)
          Removes any other triples with this as the subject, the given predicate and any object and add a new triple with this as the subject and the given predicate and object.
 void setValue(URI predicate, String lexicalValue)
          Removes any other triples with this as the subject, the given predicate and any object and add a new triple with this as the subject and the given predicate and object.
 void setValue(URI predicate, String lexicalValue, String language)
          Removes any other triples with this as the subject, the given predicate and any object and add a new triple with this as the subject and the given predicate and object.
 void setValue(URI predicate, String lexicalValue, URI dataType)
          Removes any other triples with this as the subject, the given predicate and any object and add a new triple with this as the subject and the given predicate and object.
 void setValue(URI predicate, URI object)
          Removes any other triples with this as the subject, the given predicate and any object and add a new triple with this as the subject and the given predicate and object.
 
Methods inherited from interface org.jrdf.graph.URIReference
equals, getURI, hashCode
 
Methods inherited from interface org.jrdf.graph.BlankNode
equals, hashCode
 
Methods inherited from interface org.jrdf.graph.TypedNodeVisitable
accept
 

Method Detail

isURIReference

boolean isURIReference()
Returns true if this is a URIReference, otherwise it's a BlankNode.

Returns:
true if this is a URIReference, otherwise it's a BlankNode.

addValue

void addValue(PredicateNode predicate,
              ObjectNode object)
              throws GraphException
Add a new triple with this as the subject, with the given predicate and object.

Parameters:
predicate - the existing predicate in the graph to use to create the triple.
object - the existing object in the graph to use to create the triple.
Throws:
GraphException - if the predicate or object do not exist in the graph.

addValue

void addValue(URI predicate,
              URI object)
              throws GraphException
Add a new triple with this as the subject, with the given predicate and object.

Parameters:
predicate - a new or existing predicate to use to create the triple.
object - a new or existing object to use to create the triple.
Throws:
GraphException - if there was an error adding the triple (for example localising the nodes).

addValue

void addValue(URI predicate,
              String lexicalValue)
              throws GraphException
Add a new triple with this as the subject, with the given predicate and object. The last parameter is equivalent to calling GraphValueFactory.createLiteral(String)

Parameters:
predicate - a new or existing predicate to use to create the triple.
lexicalValue - a new or existing literal value to use to create the triple.
Throws:
GraphException - if there was an error adding the triple (for example localising the nodes).

addValue

void addValue(URI predicate,
              Resource object)
              throws GraphException
Add a new triple with this as the subject, with the given predicate and object.

Parameters:
predicate - a new or existing predicate to use to create the triple.
object - an existing resource from the graph used to create the triple.
Throws:
GraphException - if there was an error adding the triple (for example localising the nodes) or the Resource was not from this Graph.

addValue

void addValue(URI predicate,
              Object object)
              throws GraphException
Add a new triple with this as the subject, with the given predicate and object. The last parameter is equivalent to calling GraphValueFactory.createLiteral(Object)

Parameters:
predicate - a new or existing predicate to use to create the triple.
object - a new or existing object to use to create the triple.
Throws:
GraphException - if there was an error adding the triple (for example localising the nodes).

addValue

void addValue(URI predicate,
              String lexicalValue,
              String language)
              throws GraphException
Add a new triple with this as the subject, with the given predicate and object. The last two parameters are equivalent to calling GraphValueFactory.createLiteral(String, String)

Parameters:
predicate - a new or existing predicate to use to create the triple.
lexicalValue - a new or existing literal value to use to create the triple.
language - the language used to create the literal.
Throws:
GraphException - if there was an error adding the triple (for example localising the nodes).

addValue

void addValue(URI predicate,
              String lexicalValue,
              URI dataType)
              throws GraphException
Add a new triple with this as the subject, with the given predicate and object. The last parameter is equivalent to calling GraphValueFactory.createLiteral(String, URI)

Parameters:
predicate - a new or existing predicate to use to create the triple.
lexicalValue - a new or existing literal value to use to create the triple.
dataType - the datatype URI used to create the literal.
Throws:
GraphException - if there was an error adding the triple (for example localising the nodes).

setValue

void setValue(PredicateNode predicate,
              ObjectNode object)
              throws GraphException
Remove any other triples with this as the subject, the given predicate and any object and add a new triple with this as the subject and the given predicate and object. This means that multiple object values will be replaced by a single object value.

Parameters:
predicate - the existing predicate in the graph to set.
object - the existing object in the graph to set.
Throws:
GraphException - if the predicate or object do not exist in the graph.

setValue

void setValue(URI predicate,
              URI object)
              throws GraphException
Removes any other triples with this as the subject, the given predicate and any object and add a new triple with this as the subject and the given predicate and object. This means that multiple object values will be replaced by a single object value.

Parameters:
predicate - the existing predicate in the graph to set.
object - a new or existing object to use to create the triple.
Throws:
GraphException - if the predicate or object do not exist in the graph.

setValue

void setValue(URI predicate,
              String lexicalValue)
              throws GraphException
Removes any other triples with this as the subject, the given predicate and any object and add a new triple with this as the subject and the given predicate and object. This means that multiple object values will be replaced by a single object value.

Parameters:
predicate - a new or existing predicate to set.
lexicalValue - a new or existing literal value to use to create the triple.
Throws:
GraphException - if there was an error adding the triple (for example localising the nodes).

setValue

void setValue(URI predicate,
              Resource object)
              throws GraphException
Removes any other triples with this as the subject, the given predicate and any object and add a new triple with this as the subject and the given predicate and object. This means that multiple object values will be replaced by a single object value.

Parameters:
predicate - a new or existing predicate to set.
object - an existing resource from the graph to set.
Throws:
GraphException - if there was an error adding the triple (for example localising the nodes) or the Resource was not from this Graph.

setValue

void setValue(URI predicate,
              Object object)
              throws GraphException
Removes any other triples with this as the subject, the given predicate and any object and add a new triple with this as the subject and the given predicate and object. This means that multiple object values will be replaced by a single object value.

Parameters:
predicate - a new or existing predicate to set.
object - a new or existing object to set.
Throws:
GraphException - if there was an error adding the triple (for example localising the nodes).

setValue

void setValue(URI predicate,
              String lexicalValue,
              String language)
              throws GraphException
Removes any other triples with this as the subject, the given predicate and any object and add a new triple with this as the subject and the given predicate and object. This means that multiple object values will be replaced by a single object value.

Parameters:
predicate - a new or existing predicate to set.
lexicalValue - a new or existing literal value to use to create the triple.
language - the language used to create the literal.
Throws:
GraphException - if there was an error adding the triple (for example localising the nodes).

setValue

void setValue(URI predicate,
              String lexicalValue,
              URI dataType)
              throws GraphException
Removes any other triples with this as the subject, the given predicate and any object and add a new triple with this as the subject and the given predicate and object. This means that multiple object values will be replaced by a single object value.

Parameters:
predicate - a new or existing predicate to set.
lexicalValue - a new or existing literal value to use to create the triple.
dataType - the datatype URI used to create the literal.
Throws:
GraphException - if there was an error adding the triple (for example localising the nodes).

removeValue

void removeValue(PredicateNode predicate,
                 ObjectNode object)
                 throws GraphException
Remove the triple with this as the subject, the given predicate and object.

Parameters:
predicate - the existing predicate in the graph to remove.
object - the existing object in the graph to remove.
Throws:
GraphException - if the predicate or object does not exist in the graph.

removeValue

void removeValue(URI predicate,
                 URI object)
                 throws GraphException
Throws:
GraphException

removeValue

void removeValue(URI predicate,
                 String lexicalValue)
                 throws GraphException
Throws:
GraphException

removeValue

void removeValue(URI predicate,
                 Resource object)
                 throws GraphException
Throws:
GraphException

removeValue

void removeValue(URI predicate,
                 Object object)
                 throws GraphException
Throws:
GraphException

removeValue

void removeValue(URI predicate,
                 String lexicalValue,
                 String language)
                 throws GraphException
Throws:
GraphException

removeValue

void removeValue(URI predicate,
                 String lexicalValue,
                 URI dataType)
                 throws GraphException
Throws:
GraphException

asTriple

Triple asTriple(PredicateNode predicate,
                ObjectNode object)
                throws GraphException
Throws:
GraphException

asTriple

Triple asTriple(URI predicate,
                URI object)
                throws GraphException
Throws:
GraphException

asTriple

Triple asTriple(URI predicate,
                String lexicalValue)
                throws GraphException
Throws:
GraphException

asTriple

Triple asTriple(URI predicate,
                Resource object)
                throws GraphException
Throws:
GraphException

asTriple

Triple asTriple(URI predicate,
                Object object)
                throws GraphException
Throws:
GraphException

asTriple

Triple asTriple(URI predicate,
                String lexicalValue,
                String language)
                throws GraphException
Throws:
GraphException

asTriple

Triple asTriple(URI predicate,
                String lexicalValue,
                URI dataType)
                throws GraphException
Throws:
GraphException

removeValues

void removeValues(PredicateNode predicate)
                  throws GraphException
Remove all the triples with this as the subject and the given predicate.

Parameters:
predicate - the existing predicate in the graph.
Throws:
GraphException - if the predicate does not exist in the graph.

removeValues

void removeValues(URI predicate)
                  throws GraphException
Throws:
GraphException

removeSubject

void removeSubject(SubjectNode subject,
                   PredicateNode predicate)
                   throws GraphException
Remove the triple with this as the object, the given subject and predicate.

Parameters:
subject - the existing subject in the graph to remove.
predicate - the existing predicate in the graph to remove.
Throws:
GraphException - if the subject or predicate do not exist in the graph.

removeSubject

void removeSubject(URI subject,
                   URI predicate)
                   throws GraphException
Throws:
GraphException

getObjects

ClosableIterator<ObjectNode> getObjects(PredicateNode predicate)
                                        throws GraphException
With this as the subject and using the given predicate return all the objects.

Parameters:
predicate - the existing predicate in the graph to use to find the objects.
Returns:
all the objects in the graph with this resource as the subject and the given predicate.
Throws:
GraphException - if the subject or predicate do not exist in the graph.

getObjects

ClosableIterator<ObjectNode> getObjects(URI predicate)
                                        throws GraphException
Throws:
GraphException

getSubjects

ClosableIterator<SubjectNode> getSubjects(PredicateNode predicate)
                                          throws GraphException
With this as the object and using the given predicate return all the subjects.

Parameters:
predicate - the existing predicate in the graph to use to find the subjects.
Returns:
all the objects in the graph with this resource as the subject and the given predicate.
Throws:
GraphException - if the subject or predicate do not exist in the graph.

getSubjects

ClosableIterator<SubjectNode> getSubjects(URI predicate)
                                          throws GraphException
Throws:
GraphException

getUnderlyingNode

Node getUnderlyingNode()
Returns the node that the resource represents - either a BlankNode or a URIReference.

Returns:
the BlankNode or URIReference.

containsTriple

boolean containsTriple(PredicateNode predicate,
                       ObjectNode object)
                       throws GraphException
Throws:
GraphException