org.jrdf.graph
Interface GraphElementFactory

All Known Implementing Classes:
GraphElementFactoryImpl

public interface GraphElementFactory

A Graph Element Factory is a class which creates the various components of a graph including: resources, literals and blank nodes. It is generally tied to a specific graph (in the case of blank nodes it must be).

Version:
$Revision: 1811 $
Author:
Andrew Newman

Method Summary
 BlankNode createBlankNode()
          Create a blank node that is associated with a specific graph.
 Literal createLiteral(Object object)
          Converts a known Java class (such as Integer) into an RDF literal (XSD:int).
 Literal createLiteral(String lexicalValue)
          Creates a new literal with the given lexical value, with no language or datatype.
 Literal createLiteral(String lexicalValue, String languageType)
          Creates a new literal with the given lexical value, with a given language but no datatype.
 Literal createLiteral(String lexicalValue, URI datatypeURI)
          Creates a new literal with the given lexical value and given datatype.
 Resource createResource()
          Create a resource, wrapping a blank node that is associated with a specific graph.
 Resource createResource(BlankNode node)
          Wrap a blank node in a resource.
 Resource createResource(URI uri)
          Create a URI reference wrapped in a Resource.
 Resource createResource(URI uri, boolean validate)
          Create a URI reference wrapped in a Resource without checking if the URI given is a valid RDF URI, currently if the URI is absolute.
 Resource createResource(URIReference node)
          Wrap a URIReference in a resource.
 URIReference createURIReference(URI uri)
          Create a URI reference.
 URIReference createURIReference(URI uri, boolean validate)
          Create a URI reference without checking if the URI given is a valid RDF URI, currently if the URI is absolute.
 

Method Detail

createResource

Resource createResource()
                        throws GraphElementFactoryException
Create a resource, wrapping a blank node that is associated with a specific graph.

Returns:
the newly created resource wrapping a blank node value.
Throws:
GraphElementFactoryException - if adding a blank node fails.

createResource

Resource createResource(BlankNode node)
                        throws GraphElementFactoryException
Wrap a blank node in a resource.

Parameters:
node - the node to wrap.
Returns:
a new resource.
Throws:
GraphElementFactoryException - if the blank node does not exist.

createResource

Resource createResource(URIReference node)
                        throws GraphElementFactoryException
Wrap a URIReference in a resource.

Parameters:
node - the node to wrap.
Returns:
a new resource.
Throws:
GraphElementFactoryException - if the URIReference does not exist.

createBlankNode

BlankNode createBlankNode()
                          throws GraphElementFactoryException
Create a blank node that is associated with a specific graph.

Returns:
the newly created blank node value.
Throws:
GraphElementFactoryException - if adding a blank node fails.

createResource

Resource createResource(URI uri)
                        throws GraphElementFactoryException
Create a URI reference wrapped in a Resource.

Parameters:
uri - The URI of the resource.
Returns:
the newly created resource wrapping a URI reference value.
Throws:
GraphElementFactoryException - If the resource failed to be created.

createResource

Resource createResource(URI uri,
                        boolean validate)
                        throws GraphElementFactoryException
Create a URI reference wrapped in a Resource without checking if the URI given is a valid RDF URI, currently if the URI is absolute.

Parameters:
uri - The URI of the resource.
validate - true if we disbale checking to see if the URI is valid.
Returns:
The newly created URI reference value.
Throws:
GraphElementFactoryException - If the resource failed to be created.

createURIReference

URIReference createURIReference(URI uri)
                                throws GraphElementFactoryException
Create a URI reference. Checks the validity of the URI (must be absolute).

Parameters:
uri - The URI of the resource.
Returns:
the newly created URI reference value.
Throws:
GraphElementFactoryException - If the resource failed to be created.

createURIReference

URIReference createURIReference(URI uri,
                                boolean validate)
                                throws GraphElementFactoryException
Create a URI reference without checking if the URI given is a valid RDF URI, currently if the URI is absolute.

Parameters:
uri - The URI of the resource.
validate - true if we disbale checking to see if the URI is valid.
Returns:
The newly created URI reference value.
Throws:
GraphElementFactoryException - If the resource failed to be created.

createLiteral

Literal createLiteral(Object object)
                      throws GraphElementFactoryException
Converts a known Java class (such as Integer) into an RDF literal (XSD:int).

Parameters:
object - the value object (a Java class) to create the literal from.
Returns:
the newly created literal value.
Throws:
GraphElementFactoryException - If the literal failed to be created.
IllegalArgumentException - if there is no registered class to value creator mapping in the datatype factory.

createLiteral

Literal createLiteral(String lexicalValue)
                      throws GraphElementFactoryException
Creates a new literal with the given lexical value, with no language or datatype.

Parameters:
lexicalValue - The lexical value for the literal.
Returns:
the newly created literal value.
Throws:
GraphElementFactoryException - If the literal failed to be created.

createLiteral

Literal createLiteral(String lexicalValue,
                      String languageType)
                      throws GraphElementFactoryException
Creates a new literal with the given lexical value, with a given language but no datatype.

Parameters:
lexicalValue - The lexical value for the literal. Cannot be null.
languageType - The language of the literal or null if not required.
Returns:
the newly created literal value.
Throws:
GraphElementFactoryException - If the literal failed to be created.

createLiteral

Literal createLiteral(String lexicalValue,
                      URI datatypeURI)
                      throws GraphElementFactoryException
Creates a new literal with the given lexical value and given datatype.

Parameters:
lexicalValue - The lexical value for the literal. Cannot be null.
datatypeURI - The URI of the datatype of the literal or null if not required.
Returns:
the newly created literal value.
Throws:
GraphElementFactoryException - If the literal failed to be created.