com.marklogic.client.semantics

Interface GraphManager

public interface GraphManager

A manager for CRUD operations on semantic graphs which reside in MarkLogic Server.

For example:

If you have a file called "example.nt" containing one triple in turtle mimetype:

    <http://example.org/subject1> <http://example.org/predicate1> <http://example.org/object1> .

You could write it to the database in a graph called "myExample/graphUri" like so:

    GraphManager graphMgr = databaseClient.newGraphManager();
    FileHandle fileHandle = new FileHandle(new File("example.nt")).withMimetype(RDFMimeTypes.NTRIPLES);
    graphMgr.write("myExample/graphUri", fileHandle);
 

Then you could add another triple to the graph like so:

    StringHandle stringHandle = new StringHandle()
        .with("<http://example.org/subject2> <http://example.org/predicate2> <http://example.org/object2> .")
        .withMimetype(RDFMimeTypes.NTRIPLES);
    graphMgr.merge("myExample/graphUri", stringHandle);
 

Then you read the graph from the database into turtle syntax into a variable "triples" like so:

    String triples = graphMgr.read("myExample/graphUri",
        new StringHandle().withMimetype(RDFMimeTypes.NTRIPLES)).get();
 

You could simplify these examples if you first set the default mimetype so you don't have to call setMimetype on each handle. That also enables you to use the *As convenience methods:

    graphMgr.setDefaultMimetype(RDFMimeTypes.NTRIPLES);
    String triples = graphMgr.readAs("myExample/graphUri", String.class);
 

If you need to limit access to a graph you can set the permissions:

    graphMgr.writePermissions("myExample/graphUri",
        graphMgr.permission("example_manager", Capability.READ)
                .permission("example_manager", Capability.UPDATE));
 

Permissions can also be added with mergePermissions, deleted with deletePermissions, or set with calls to write or merge to a graph by providing the permissions argument.

Each new instance of GraphManager is created by DatabaseClient.newGraphManager(). While these examples use FileHandle and StringHandle, any TriplesWriteHandle may be used, including custom handles. While JSONWriteHandles will need to use RDFMimeTypes.RDFJSON mimetype, and XMLWriteHandles will need to use RDFMimeTypes.RDFXML mimetype, most TriplesWriteHandles can write any text mimteypt and can therefore write triples using any of the RDFMimeTypes.

GraphManager is thread-safe other than setDefaultMimetype. In other words the only state maintained by an instance is the default mimetype. Common usage is to call setDefaultMimetype only once then use the instance across many threads. If you intend to call setDefaultMimetype from multiple threads, create a new GraphManager for each thread.

For details about RDF, SPARQL, and semantics in MarkLogic see Semantics Developer's Guide

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_GRAPH Use with any GraphManager method in place of the uri to work against the default graph.

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String uri) Permanently delete the specified graph from the server.
void	delete(java.lang.String uri, Transaction transaction) Permanently delete the specified graph from the server.
void	deleteGraphs() Permanently delete all quads from all graphs.
void	deleteGraphs(Transaction transaction) Permanently delete all quads from all graphs.
void	deletePermissions(java.lang.String uri) Delete all permissions for the graph.
void	deletePermissions(java.lang.String uri, Transaction transaction) Delete all permissions for the graph.
java.lang.String	getDefaultMimetype() Get the mimetype set by calling setDefaultMimetype.
GraphPermissions	getPermissions(java.lang.String uri) Retrieve permissions for a graph.
GraphPermissions	getPermissions(java.lang.String uri, Transaction transaction) Retrieve permissions for a graph.
java.util.Iterator<java.lang.String>	listGraphUris() Get the uri for available graphs.
void	merge(java.lang.String uri, TriplesWriteHandle handle) Add triples from the handle to the specified graph.
void	merge(java.lang.String uri, TriplesWriteHandle handle, GraphPermissions permissions) Add triples from the handle and add specified permissions to the specified graph.
void	merge(java.lang.String uri, TriplesWriteHandle handle, GraphPermissions permissions, Transaction transaction) Add triples from the handle and add specified permissions to the specified graph.
void	merge(java.lang.String uri, TriplesWriteHandle handle, Transaction transaction) Add triples from the handle to the specified graph.
void	mergeAs(java.lang.String uri, java.lang.Object graphData) Add triples from the graphData object to the specified graph.
void	mergeAs(java.lang.String uri, java.lang.Object graphData, GraphPermissions permissions) Add triples from the graphData object and add specified permissions to the specified graph.
void	mergeAs(java.lang.String uri, java.lang.Object graphData, GraphPermissions permissions, Transaction transaction) Add triples from the graphData object and add specified permissions to the specified graph.
void	mergeAs(java.lang.String uri, java.lang.Object graphData, Transaction transaction) Add triples from the graphData object to the specified graph.
void	mergeGraphs(QuadsWriteHandle handle) Add quads from the handle to the graphs specified in the quads data.
void	mergeGraphs(QuadsWriteHandle handle, Transaction transaction) Add quads from the handle to the graphs specified in the quads data.
void	mergeGraphsAs(java.lang.Object quadsData) Add quads from the object to the graphs specified in the quads data.
void	mergeGraphsAs(java.lang.Object quadsData, Transaction transaction) Add quads from the object to the graphs specified in the quads data.
void	mergePermissions(java.lang.String uri, GraphPermissions permissions) Add to permissions on the graph.
void	mergePermissions(java.lang.String uri, GraphPermissions permissions, Transaction transaction) Add to permissions on the graph.
GraphPermissions	newGraphPermissions() Get an empty GraphPermissions instance.
GraphPermissions	permission(java.lang.String role, Capability... capabilities) Create a GraphPermissions builder object with the specified role and capabilities.
<T extends TriplesReadHandle> T	read(java.lang.String uri, T handle) Read triples from the server.
<T extends TriplesReadHandle> T	read(java.lang.String uri, T handle, Transaction transaction) Read triples from the server.
<T> T	readAs(java.lang.String uri, java.lang.Class<T> as) Read triples from the server as the specified type.
<T> T	readAs(java.lang.String uri, java.lang.Class<T> as, Transaction transaction) Read triples from the server as the specified type.
void	replaceGraphs(QuadsWriteHandle handle) Remove all quads from all graphs then insert quads from the handle to the graphs specified in the quads data.
void	replaceGraphs(QuadsWriteHandle handle, Transaction transaction) Remove all quads from all graphs then insert quads from the handle to the graphs specified in the quads data.
void	replaceGraphsAs(java.lang.Object quadsData) Remove all quads from all graphs then insert quads from the quadsData to the graphs specified in the quads data.
void	replaceGraphsAs(java.lang.Object quadsData, Transaction transaction) Remove all quads from all graphs then insert quads from the quadsData to the graphs specified in the quads data.
void	setDefaultMimetype(java.lang.String mimetype) Set the default mimetype for data sent by write* or merge* methods and data serialized by the server in response to calls to read* or things* methods.
<T extends TriplesReadHandle> T	things(T handle, java.lang.String... iris) Retrieves all triples related to specified subject or object iris.
<T> T	thingsAs(java.lang.Class<T> as, java.lang.String... iris) Retrieves all triples related to specified subject or object iris.
void	write(java.lang.String uri, TriplesWriteHandle handle) Overwrite triples from the handle as the specified graph.
void	write(java.lang.String uri, TriplesWriteHandle handle, GraphPermissions permissions) Overwrite triples from the handle and specified permissions as the specified graph.
void	write(java.lang.String uri, TriplesWriteHandle handle, GraphPermissions permissions, Transaction transaction) Overwrite triples from the handle and specified permissions as the specified graph.
void	write(java.lang.String uri, TriplesWriteHandle handle, Transaction transaction) Overwrite triples from the handle as the specified graph.
void	writeAs(java.lang.String uri, java.lang.Object graphData) Overwrite triples from the graphData object as the specified graph.
void	writeAs(java.lang.String uri, java.lang.Object graphData, GraphPermissions permissions) Overwrite triples from the graphData object and specified permissions as the specified graph.
void	writeAs(java.lang.String uri, java.lang.Object graphData, GraphPermissions permissions, Transaction transaction) Overwrite triples from the graphData object and specified permissions as the specified graph.
void	writeAs(java.lang.String uri, java.lang.Object graphData, Transaction transaction) Overwrite triples from the graphData object as the specified graph.
void	writePermissions(java.lang.String uri, GraphPermissions permissions) Overwrite all permissions for the graph.
void	writePermissions(java.lang.String uri, GraphPermissions permissions, Transaction transaction) Overwrite all permissions for the graph.

Field Detail

DEFAULT_GRAPH

static final java.lang.String DEFAULT_GRAPH

Use with any GraphManager method in place of the uri to work against the default graph. The string value is not important and for java-client internal use only--it is never sent to the database.

Example:

    StringHandle stringHandle = new StringHandle()
        .with("<http://example.org/subject2> <http://example.org/predicate2> <http://example.org/object2> .")
        .withMimetype(RDFMimeTypes.NTRIPLES);
    graphMgr.merge(DEFAULT_GRAPH, stringHandle);

See Also:

Constant Field Values

Method Detail

listGraphUris

java.util.Iterator<java.lang.String> listGraphUris()

Get the uri for available graphs.

Example:

    Iterator<String> iter = graphMgr.listGraphUris();
    while ( iter.hasNext() ) {
        String uri = iter.next();
        ...
    }

Returns:

the graph uris

read

<T extends TriplesReadHandle> T read(java.lang.String uri,
                                     T handle)
                              throws ResourceNotFoundException,
                                     ForbiddenUserException,
                                     FailedRequestException

Read triples from the server. The server can serialize the triples using any RDFMimeTypes except TRIG. Specify the desired serialization mimetype by calling setDefaultMimetype or handle.setMimetype or withMimetype (if available) on your handle.

Type Parameters:

T - the type of TriplesReadHandle to return

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

handle - the handle to populate and return, set with the desired mimetype from RDFMimeTypes

Returns:

the populated handle

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

See Also:

example usage in class javadoc

read

<T extends TriplesReadHandle> T read(java.lang.String uri,
                                     T handle,
                                     Transaction transaction)
                              throws ResourceNotFoundException,
                                     ForbiddenUserException,
                                     FailedRequestException

Read triples from the server. The server can serialize the triples using any RDFMimeTypes except TRIG. Specify the desired serialization mimetype by calling setDefaultMimetype or handle.setMimetype or withMimetype (if available) on your handle.

Type Parameters:

T - the type of TriplesReadHandle to return

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

handle - the handle to populate and return with the desired mimetype from RDFMimeTypes mimetype from RDFMimeTypes

transaction - the open transaction to read from

Returns:

the populated handle

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

readAs

<T> T readAs(java.lang.String uri,
             java.lang.Class<T> as)
      throws ResourceNotFoundException,
             ForbiddenUserException,
             FailedRequestException

Read triples from the server as the specified type. The server can serialize the triples using any RDFMimeTypes except TRIG. Specify the desired serialization using setDefaultMimetype.

Type Parameters:

T - the type of object that will be returned by the handle registered for it

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

as - the type to populate and return. This type must be registered by an io handle.

Returns:

the retrieved triples as the specified type

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

See Also:

example usage in class javadoc

readAs

<T> T readAs(java.lang.String uri,
             java.lang.Class<T> as,
             Transaction transaction)
      throws ResourceNotFoundException,
             ForbiddenUserException,
             FailedRequestException

Read triples from the server as the specified type. The server can serialize the triples using any RDFMimeTypes except TRIG. Specify the desired serialization using setDefaultMimetype.

Type Parameters:

T - the type of object that will be returned by the handle registered for it

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

as - the type to populate and return. This type must be registered by an io handle.

transaction - the open transaction to read from

Returns:

the retrieved triples as the specified type

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

getPermissions

GraphPermissions getPermissions(java.lang.String uri)
                         throws ResourceNotFoundException,
                                ForbiddenUserException,
                                FailedRequestException

Retrieve permissions for a graph.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

Returns:

the retrieved GraphPermissions

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

getPermissions

GraphPermissions getPermissions(java.lang.String uri,
                                Transaction transaction)
                         throws ResourceNotFoundException,
                                ForbiddenUserException,
                                FailedRequestException

Retrieve permissions for a graph.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

transaction - the open transaction to read from

Returns:

the retrieved GraphPermissions

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

deletePermissions

void deletePermissions(java.lang.String uri)
                throws ResourceNotFoundException,
                       ForbiddenUserException,
                       FailedRequestException

Delete all permissions for the graph.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

deletePermissions

void deletePermissions(java.lang.String uri,
                       Transaction transaction)
                throws ResourceNotFoundException,
                       ForbiddenUserException,
                       FailedRequestException

Delete all permissions for the graph.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

transaction - the open transaction to delete in

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

writePermissions

void writePermissions(java.lang.String uri,
                      GraphPermissions permissions)
               throws ResourceNotFoundException,
                      ForbiddenUserException,
                      FailedRequestException

Overwrite all permissions for the graph.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

permissions - the permissions to set for this graph

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

writePermissions

void writePermissions(java.lang.String uri,
                      GraphPermissions permissions,
                      Transaction transaction)
               throws ResourceNotFoundException,
                      ForbiddenUserException,
                      FailedRequestException

Overwrite all permissions for the graph.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

permissions - the permissions to set for this graph

transaction - the open transaction to write in

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

mergePermissions

void mergePermissions(java.lang.String uri,
                      GraphPermissions permissions)
               throws ResourceNotFoundException,
                      ForbiddenUserException,
                      FailedRequestException

Add to permissions on the graph.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

permissions - the permissions to add to this graph

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

mergePermissions

void mergePermissions(java.lang.String uri,
                      GraphPermissions permissions,
                      Transaction transaction)
               throws ResourceNotFoundException,
                      ForbiddenUserException,
                      FailedRequestException

Add to permissions on the graph.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

permissions - the permissions to add to this graph

transaction - the open transaction to write in

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

permission

GraphPermissions permission(java.lang.String role,
                            Capability... capabilities)

Create a GraphPermissions builder object with the specified role and capabilities.

Parameters:

role - the name of the role receiving these capabilities

capabilities - the capabilities (READ, UPDATE, or EXECUTE) granted to this role

Returns:

the new GraphPermissions object with these capabilities set

merge

void merge(java.lang.String uri,
           TriplesWriteHandle handle)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException

Add triples from the handle to the specified graph. The server can receive the triples as any of the RDFMimeTypes. Specify the mimetype appropriate for your content by calling setDefaultMimetype or handle.setMimetype or withMimetype (if available) on your handle.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

handle - the handle containing triples of appropriate RDFMimeTypes

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

See Also:

example usage in class javadoc

merge

void merge(java.lang.String uri,
           TriplesWriteHandle handle,
           Transaction transaction)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException

Add triples from the handle to the specified graph. The server can receive the triples as any of the RDFMimeTypes. Specify the mimetype appropriate for your content by calling setDefaultMimetype or handle.setMimetype or withMimetype (if available) on your handle.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

handle - the handle containing triples of appropriate RDFMimeTypes

transaction - the open transaction to write in

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

merge

void merge(java.lang.String uri,
           TriplesWriteHandle handle,
           GraphPermissions permissions)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException

Add triples from the handle and add specified permissions to the specified graph. The server can receive the triples as any of the RDFMimeTypes. Specify the mimetype appropriate for your content by calling setDefaultMimetype or handle.setMimetype or withMimetype (if available) on your handle.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

handle - the handle containing triples of appropriate RDFMimeTypes

permissions - the permissions to add to this graph

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

merge

void merge(java.lang.String uri,
           TriplesWriteHandle handle,
           GraphPermissions permissions,
           Transaction transaction)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException

Add triples from the handle and add specified permissions to the specified graph. The server can receive the triples as any of the RDFMimeTypes. Specify the mimetype appropriate for your content by calling setDefaultMimetype or handle.setMimetype or withMimetype (if available) on your handle.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

handle - the handle containing triples of appropriate RDFMimeTypes

permissions - the permissions to add to this graph

transaction - the open transaction to write in

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

mergeAs

void mergeAs(java.lang.String uri,
             java.lang.Object graphData)
      throws ResourceNotFoundException,
             ForbiddenUserException,
             FailedRequestException

Add triples from the graphData object to the specified graph. The server can receive the triples as any of the RDFMimeTypes. Specify the mimetype appropriate for your content by calling setDefaultMimetype.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

graphData - the object containing triples of appropriate RDFMimeTypesMimetype}

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

mergeAs

void mergeAs(java.lang.String uri,
             java.lang.Object graphData,
             Transaction transaction)
      throws ResourceNotFoundException,
             ForbiddenUserException,
             FailedRequestException

Add triples from the graphData object to the specified graph. The server can receive the triples as any of the RDFMimeTypes. Specify the mimetype appropriate for your content by calling setDefaultMimetype.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

graphData - the object containing triples of RDFMimeTypes specified by setDefaultMimetype

transaction - the open transaction to write in

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

mergeAs

void mergeAs(java.lang.String uri,
             java.lang.Object graphData,
             GraphPermissions permissions)
      throws ResourceNotFoundException,
             ForbiddenUserException,
             FailedRequestException

Add triples from the graphData object and add specified permissions to the specified graph. The server can receive the triples as any of the RDFMimeTypes. Specify the mimetype appropriate for your content by calling setDefaultMimetype.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

graphData - the object containing triples of RDFMimeTypes specified by setDefaultMimetype

permissions - the permissions to add to this graph

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

mergeAs

void mergeAs(java.lang.String uri,
             java.lang.Object graphData,
             GraphPermissions permissions,
             Transaction transaction)
      throws ResourceNotFoundException,
             ForbiddenUserException,
             FailedRequestException

Add triples from the graphData object and add specified permissions to the specified graph. The server can receive the triples as any of the RDFMimeTypes. Specify the mimetype appropriate for your content by calling setDefaultMimetype.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

graphData - the object containing triples of RDFMimeTypes specified by setDefaultMimetype

permissions - the permissions to add to this graph

transaction - the open transaction to write in

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

write

void write(java.lang.String uri,
           TriplesWriteHandle handle)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException

Overwrite triples from the handle as the specified graph. The server can receive the triples as any of the RDFMimeTypes. Specify the mimetype appropriate for your content by calling setDefaultMimetype or handle.setMimetype or withMimetype (if available) on your handle.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

handle - the handle containing triples of appropriate RDFMimeTypes

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

See Also:

example usage in class javadoc

write

void write(java.lang.String uri,
           TriplesWriteHandle handle,
           Transaction transaction)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException

Overwrite triples from the handle as the specified graph. The server can receive the triples as any of the RDFMimeTypes. Specify the mimetype appropriate for your content by calling setDefaultMimetype or handle.setMimetype or withMimetype (if available) on your handle.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

handle - the handle containing triples of appropriate RDFMimeTypes

transaction - the open transaction to write in

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

write

void write(java.lang.String uri,
           TriplesWriteHandle handle,
           GraphPermissions permissions)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException

Overwrite triples from the handle and specified permissions as the specified graph. The server can receive the triples as any of the RDFMimeTypes. Specify the mimetype appropriate for your content by calling setDefaultMimetype or handle.setMimetype or withMimetype (if available) on your handle.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

handle - the handle containing triples of appropriate RDFMimeTypes

permissions - the permissions to ovewrite for this graph

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

See Also:

example usage in class javadoc

write

void write(java.lang.String uri,
           TriplesWriteHandle handle,
           GraphPermissions permissions,
           Transaction transaction)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException

Overwrite triples from the handle and specified permissions as the specified graph. The server can receive the triples as any of the RDFMimeTypes. Specify the mimetype appropriate for your content by calling setDefaultMimetype or handle.setMimetype or withMimetype (if available) on your handle.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

handle - the handle containing triples of appropriate RDFMimeTypes

permissions - the permissions to ovewrite for this graph

transaction - the open transaction to write in

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

writeAs

void writeAs(java.lang.String uri,
             java.lang.Object graphData)
      throws ResourceNotFoundException,
             ForbiddenUserException,
             FailedRequestException

Overwrite triples from the graphData object as the specified graph. The server can receive the triples as any of the RDFMimeTypes. Specify the mimetype appropriate for your content by calling setDefaultMimetype.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

graphData - the object containing triples of RDFMimeTypes specified by setDefaultMimetype

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

writeAs

void writeAs(java.lang.String uri,
             java.lang.Object graphData,
             Transaction transaction)
      throws ResourceNotFoundException,
             ForbiddenUserException,
             FailedRequestException

Overwrite triples from the graphData object as the specified graph. The server can receive the triples as any of the RDFMimeTypes. Specify the mimetype appropriate for your content by calling setDefaultMimetype.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

graphData - the object containing triples of RDFMimeTypes specified by setDefaultMimetype

transaction - the open transaction to write in

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

writeAs

void writeAs(java.lang.String uri,
             java.lang.Object graphData,
             GraphPermissions permissions)
      throws ResourceNotFoundException,
             ForbiddenUserException,
             FailedRequestException

Overwrite triples from the graphData object and specified permissions as the specified graph. The server can receive the triples as any of the RDFMimeTypes. Specify the mimetype appropriate for your content by calling setDefaultMimetype.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

graphData - the object containing triples of RDFMimeTypes specified by setDefaultMimetype

permissions - the permissions to ovewrite for this graph

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

writeAs

void writeAs(java.lang.String uri,
             java.lang.Object graphData,
             GraphPermissions permissions,
             Transaction transaction)
      throws ResourceNotFoundException,
             ForbiddenUserException,
             FailedRequestException

Overwrite triples from the graphData object and specified permissions as the specified graph. The server can receive the triples as any of the RDFMimeTypes. Specify the mimetype appropriate for your content by calling setDefaultMimetype.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

graphData - the object containing triples of RDFMimeTypes specified by setDefaultMimetype

permissions - the permissions to ovewrite for this graph

transaction - the open transaction to write in

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

delete

void delete(java.lang.String uri)
     throws ResourceNotFoundException,
            ForbiddenUserException,
            FailedRequestException

Permanently delete the specified graph from the server.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

delete

void delete(java.lang.String uri,
            Transaction transaction)
     throws ResourceNotFoundException,
            ForbiddenUserException,
            FailedRequestException

Permanently delete the specified graph from the server.

Parameters:

uri - the graph uri or DEFAULT_GRAPH constant

transaction - the open transaction to delete in

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

things

<T extends TriplesReadHandle> T things(T handle,
                                       java.lang.String... iris)
                                throws ResourceNotFoundException,
                                       ForbiddenUserException,
                                       FailedRequestException

Retrieves all triples related to specified subject or object iris. The server can serialize the triples using any RDFMimeTypes except TRIG. Specify the desired serialization mimetype by calling setDefaultMimetype or handle.setMimetype or withMimetype (if available) on your handle.

Type Parameters:

T - the type of TriplesReadHandle to return

Parameters:

handle - the handle to populate and return with the desired mimetype from RDFMimeTypes

iris - the subject or object iris to retrieve

Returns:

the populated handle

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

thingsAs

<T> T thingsAs(java.lang.Class<T> as,
               java.lang.String... iris)
        throws ResourceNotFoundException,
               ForbiddenUserException,
               FailedRequestException

Retrieves all triples related to specified subject or object iris. The server can serialize the triples using any RDFMimeTypes except TRIG. Specify the desired serialization using setDefaultMimetype.

Type Parameters:

T - the type of object that will be returned by the handle registered for it

Parameters:

as - the type to populate and return. This type must be registered by an io handle.

iris - the subject or object iris to retrieve

Returns:

the retrieved triples as the specified type

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

mergeGraphs

void mergeGraphs(QuadsWriteHandle handle)
          throws ResourceNotFoundException,
                 ForbiddenUserException,
                 FailedRequestException

Add quads from the handle to the graphs specified in the quads data. The server can receive the quads as RDFMimeTypes.NQUADS or RDFMimeTypes.TRIG. Specify the mimetype appropriate for your content by calling setDefaultMimetype or handle.setMimetype or withMimetype (if available) on your handle.

Parameters:

handle - the handle containing quads of appropriate RDFMimeTypes

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

mergeGraphs

void mergeGraphs(QuadsWriteHandle handle,
                 Transaction transaction)
          throws ResourceNotFoundException,
                 ForbiddenUserException,
                 FailedRequestException

Add quads from the handle to the graphs specified in the quads data. The server can receive the quads as RDFMimeTypes.NQUADS or RDFMimeTypes.TRIG. Specify the mimetype appropriate for your content by calling setDefaultMimetype or handle.setMimetype or withMimetype (if available) on your handle.

Parameters:

handle - the handle containing quads of appropriate RDFMimeTypes

transaction - the open transaction to write in

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

mergeGraphsAs

void mergeGraphsAs(java.lang.Object quadsData)
            throws ResourceNotFoundException,
                   ForbiddenUserException,
                   FailedRequestException

Add quads from the object to the graphs specified in the quads data. The server can receive the quads as RDFMimeTypes.NQUADS or RDFMimeTypes.TRIG. Specify the mimetype appropriate for your content by calling setDefaultMimetype.

Parameters:

quadsData - the object containing quads of RDFMimeTypes specified by setDefaultMimetype

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

mergeGraphsAs

void mergeGraphsAs(java.lang.Object quadsData,
                   Transaction transaction)
            throws ResourceNotFoundException,
                   ForbiddenUserException,
                   FailedRequestException

Add quads from the object to the graphs specified in the quads data. The server can receive the quads as RDFMimeTypes.NQUADS or RDFMimeTypes.TRIG. Specify the mimetype appropriate for your content by calling setDefaultMimetype.

Parameters:

quadsData - the object containing quads of RDFMimeTypes specified by setDefaultMimetype

transaction - the open transaction to write in

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

replaceGraphs

void replaceGraphs(QuadsWriteHandle handle)
            throws ResourceNotFoundException,
                   ForbiddenUserException,
                   FailedRequestException

Remove all quads from all graphs then insert quads from the handle to the graphs specified in the quads data. The server can receive the quads as RDFMimeTypes.NQUADS or RDFMimeTypes.TRIG. Specify the mimetype appropriate for your content by calling setDefaultMimetype or handle.setMimetype or withMimetype (if available) on your handle.

Parameters:

handle - the handle containing quads of appropriate RDFMimeTypes

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

replaceGraphs

void replaceGraphs(QuadsWriteHandle handle,
                   Transaction transaction)
            throws ResourceNotFoundException,
                   ForbiddenUserException,
                   FailedRequestException

Remove all quads from all graphs then insert quads from the handle to the graphs specified in the quads data. The server can receive the quads as RDFMimeTypes.NQUADS or RDFMimeTypes.TRIG. Specify the mimetype appropriate for your content by calling setDefaultMimetype or handle.setMimetype or withMimetype (if available) on your handle.

Parameters:

handle - the handle containing quads of appropriate RDFMimeTypes

transaction - the open transaction to write in

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

replaceGraphsAs

void replaceGraphsAs(java.lang.Object quadsData)
              throws ResourceNotFoundException,
                     ForbiddenUserException,
                     FailedRequestException

Remove all quads from all graphs then insert quads from the quadsData to the graphs specified in the quads data. The server can receive the quads as RDFMimeTypes.NQUADS or RDFMimeTypes.TRIG. Specify the mimetype appropriate for your content by calling setDefaultMimetype.

Parameters:

quadsData - the object containing quads of RDFMimeTypes specified by setDefaultMimetype

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

replaceGraphsAs

void replaceGraphsAs(java.lang.Object quadsData,
                     Transaction transaction)
              throws ResourceNotFoundException,
                     ForbiddenUserException,
                     FailedRequestException

Remove all quads from all graphs then insert quads from the quadsData to the graphs specified in the quads data. The server can receive the quads as RDFMimeTypes.NQUADS or RDFMimeTypes.TRIG. Specify the mimetype appropriate for your content by calling setDefaultMimetype.

Parameters:

quadsData - the object containing quads of RDFMimeTypes specified by setDefaultMimetype

transaction - the open transaction to write in

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

deleteGraphs

void deleteGraphs()
           throws ResourceNotFoundException,
                  ForbiddenUserException,
                  FailedRequestException

Permanently delete all quads from all graphs.

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

deleteGraphs

void deleteGraphs(Transaction transaction)
           throws ResourceNotFoundException,
                  ForbiddenUserException,
                  FailedRequestException

Permanently delete all quads from all graphs.

Parameters:

transaction - the open transaction to delete in

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

getDefaultMimetype

java.lang.String getDefaultMimetype()

Get the mimetype set by calling setDefaultMimetype.

Returns:

the default mimetype set by calling setDefaultMimetype

setDefaultMimetype

void setDefaultMimetype(java.lang.String mimetype)

Set the default mimetype for data sent by write* or merge* methods and data serialized by the server in response to calls to read* or things* methods. A mimetype explicitly set on the handle will be used instead of the default. This default mimetype must be set to use the *As methods since there is no handle on which to explicity set a mimetype.

Parameters:

mimetype - the new default mimetype

newGraphPermissions

GraphPermissions newGraphPermissions()

Get an empty GraphPermissions instance.

Returns:

an empty GraphPermissions instance