org.openrdf.sesame.repository.local
Class LocalRepository

java.lang.Object
  org.openrdf.sesame.repository.local.LocalRepository

All Implemented Interfaces:

SailChangedListener, SesameRepository

public class LocalRepository

extends Object

implements SesameRepository, SailChangedListener

Entry point for access to a local Sesame repository. Create this object using a LocalService.

See Also:

LocalService

Method Summary

void	addData(File dataFile, String baseURI, RDFFormat format, boolean verifyData, AdminListener listener) Adds RDF data from the specified file to the repository.
void	addData(InputStream dataStream, String baseURI, RDFFormat format, boolean verifyData, AdminListener listener) Adds RDF data from an InputStream to the repository.
void	addData(Reader reader, String baseURI, RDFFormat format, boolean verifyData, AdminListener listener) Adds RDF data from a Reader to the repository.
void	addData(SesameRepository repository, AdminListener listener) Adds the contents of the supplied SesameRepository to this repository.
void	addData(String data, String baseURI, RDFFormat format, boolean verifyData, AdminListener listener) Adds an RDF document to the repository.
void	addData(URL dataURL, String baseURI, RDFFormat format, boolean verifyData, AdminListener listener) Adds the RDF data that can be found at the specified URL to the repository.
void	addGraph(Graph graph) Adds the contents of the supplied graph to the repository.
void	addGraph(Graph graph, boolean joinBlankNodes) Adds the contents of the supplied graph to the repository.
void	addGraph(QueryLanguage language, String query) Adds the contents of the graph specified by the supplied graph query to the repository.
void	addGraph(QueryLanguage language, String query, boolean joinBlankNodes) Adds the contents of the graph specified by the supplied graph query to the repository.
void	addListener(LocalRepositoryChangedListener listener)
void	clear(AdminListener listener) Clears the repository.
void	extractRDF(RdfDocumentWriter rdfDocWriter, boolean ontology, boolean instances, boolean explicitOnly, boolean niceOutput) Extracts data from the repository and reports the triples to the supplied RdfDocumentWriter.
InputStream	extractRDF(RDFFormat format, boolean ontology, boolean instances, boolean explicitOnly, boolean niceOutput) Extracts data from the repository and returns it in the requested format.
Graph	getGraph() Creates a Graph representation of this repository.
String	getRepositoryId() retrieves the repository id string for this repository.
Sail	getSail() Gets the SAIL object of this repository.
boolean	hasReadAccess() Checks whether the current user has read access to this repository.
boolean	hasWriteAccess() Checks whether the current user has write access to this repository.
void	mergeGraph(Graph graph)
void	mergeGraph(QueryLanguage language, String query)
Graph	performGraphQuery(QueryLanguage language, String query) Evaluates a graph query and reports the resulting statements to the specified listener.
void	performGraphQuery(QueryLanguage language, String query, GraphQueryResultListener listener) Evaluates a graph query and reports the resulting statements to the specified listener.
QueryResultsTable	performTableQuery(QueryLanguage language, String query) Evaluates a query and returns the results in a QueryResultsTable.
void	performTableQuery(QueryLanguage language, String query, TableQueryResultListener listener) Evaluates a query and reports the results as rows in a table to the supplied listener.
void	removeGraph(Graph graph) Removes the contents of the supplied graph from the repository.
void	removeGraph(QueryLanguage language, String query) Removes the contents of the graph specified by the supplied graph query from the repository.
void	removeListener(LocalRepositoryChangedListener listener)
void	removeStatements(Resource subject, URI predicate, Value object, AdminListener listener) Removes statements from the repository.
void	sailChanged(SailChangedEvent event)
void	shutDown() Shuts down the repository.

Methods inherited from class java.lang.Object

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

Method Detail

hasReadAccess

public boolean hasReadAccess()

Checks whether the current user has read access to this repository.

Returns:

true if the user has read access, false otherwise.

hasWriteAccess

public boolean hasWriteAccess()

Checks whether the current user has write access to this repository.

Returns:

true if the user has write access, false otherwise.

performTableQuery

public QueryResultsTable performTableQuery(QueryLanguage language,
                                           String query)
                                    throws IOException,
                                           MalformedQueryException,
                                           QueryEvaluationException,
                                           AccessDeniedException

Description copied from interface: SesameRepository

Evaluates a query and returns the results in a QueryResultsTable.

Specified by:

performTableQuery in interface SesameRepository

Parameters:

language - The query language in which the query is formulated.

query - The query.

Returns:

A QueryResultsTable object that contains the query result. Note: if the query returned no results, an empty QueryResultsTable will be returned.

Throws:

MalformedQueryException - If the supplied query is malformed.

QueryEvaluationException - If a problem occurs during evaluation of the query.

AccessDeniedException - In case the current user does not have read access on this repository.

IOException - In case an I/O error occurs while sending the query to, or retrieving the result from a Sesame server.

See Also:

QueryLanguage

performTableQuery

public void performTableQuery(QueryLanguage language,
                              String query,
                              TableQueryResultListener listener)
                       throws IOException,
                              MalformedQueryException,
                              QueryEvaluationException,
                              AccessDeniedException

Description copied from interface: SesameRepository

Evaluates a query and reports the results as rows in a table to the supplied listener.

Specified by:

performTableQuery in interface SesameRepository

Parameters:

language - the query language in which the query is formulated.

query - the query.

listener - the result listener

Throws:

AccessDeniedException - In case the current user does not have read access on this repository.

QueryEvaluationException - If a problem occurs during evaluation of the query.

MalformedQueryException - If the supplied query is malformed.

IOException - In case an I/O error occurs while sending the query to, or retrieving the result from a Sesame server.

See Also:

QueryLanguage

performGraphQuery

public void performGraphQuery(QueryLanguage language,
                              String query,
                              GraphQueryResultListener listener)
                       throws IOException,
                              MalformedQueryException,
                              QueryEvaluationException,
                              AccessDeniedException

Description copied from interface: SesameRepository

Evaluates a graph query and reports the resulting statements to the specified listener.

Specified by:

performGraphQuery in interface SesameRepository

Parameters:

language - The query language in which the query is formulated. Currently, only SeRQL supports graph queries and QueryLanguage.SERQL is the only legal value.

query - The query.

listener - A listener for the query result.

Throws:

QueryEvaluationException - If a problem occurs during evaluation of the query.

IOException - In case an I/O error occurs while sending the query to, or retrieving the result from a Sesame server.

MalformedQueryException - If the supplied query is malformed.

AccessDeniedException - In case the current user does not have read access on this repository.

See Also:

QueryLanguage

performGraphQuery

public Graph performGraphQuery(QueryLanguage language,
                               String query)
                        throws IOException,
                               MalformedQueryException,
                               QueryEvaluationException,
                               AccessDeniedException

Description copied from interface: SesameRepository

Evaluates a graph query and reports the resulting statements to the specified listener.

Specified by:

performGraphQuery in interface SesameRepository

Parameters:

language - The query language in which the query is formulated. Currently, only SeRQL supports graph queries and QueryLanguage.SERQL is the only legal value.

query - The query.

Returns:

A Graph object that contains the query result.

Throws:

MalformedQueryException - If the supplied query is malformed.

IOException - In case an I/O error occurs while sending the query to, or retrieving the result from a Sesame server.

AccessDeniedException - In case the current user does not have read access on this repository.

QueryEvaluationException - If a problem occurs during evaluation of the query.

See Also:

QueryLanguage

addData

public void addData(URL dataURL,
                    String baseURI,
                    RDFFormat format,
                    boolean verifyData,
                    AdminListener listener)
             throws IOException,
                    AccessDeniedException

Description copied from interface: SesameRepository

Adds the RDF data that can be found at the specified URL to the repository.

Specified by:

addData in interface SesameRepository

Parameters:

dataURL - the URL of the RDF data.

baseURI - the base URI to resolve any relative URIs against. This defaults to the value of dataURL if the value is set to null.

format - the serialization format of the data (one of RDFFormat.RDFXML, RDFFormat.NTRIPLES).

verifyData - if set to 'true', the RDF parser will verify the data before adding it to the repository.

listener - an AdminListener that will receive error- and progress messages.

Throws:

AccessDeniedException - In case the current user does not have write access on this repository.

IOException - In case an I/O error occurs.

See Also:

RDFFormat

addData

public void addData(File dataFile,
                    String baseURI,
                    RDFFormat format,
                    boolean verifyData,
                    AdminListener listener)
             throws FileNotFoundException,
                    IOException,
                    AccessDeniedException

Description copied from interface: SesameRepository

Adds RDF data from the specified file to the repository.

Specified by:

addData in interface SesameRepository

Parameters:

dataFile - a file containing RDF data.

baseURI - the base URI to resolve any relative URIs against.

format - the serialization format of the data (one of RDFFormat.RDFXML, RDFFormat.NTRIPLES).

verifyData - if set to 'true', the RDF parser will verify the data before adding it to the repository.

listener - an AdminListener that will receive error- and progress messages.

Throws:

IOException - In case an I/O error occurs.

AccessDeniedException - In case the current user does not have write access on this repository.

FileNotFoundException - In case the file could not be found.

See Also:

RDFFormat

addData

public void addData(String data,
                    String baseURI,
                    RDFFormat format,
                    boolean verifyData,
                    AdminListener listener)
             throws IOException,
                    AccessDeniedException

Description copied from interface: SesameRepository

Adds an RDF document to the repository.

Specified by:

addData in interface SesameRepository

Parameters:

data - an RDF document.

baseURI - the base URI to resolve any relative URIs against.

format - the serialization format of the data (one of RDFFormat.RDFXML, RDFFormat.NTRIPLES).

verifyData - if set to 'true', the RDF parser will verify the data before adding it to the repository.

listener - an AdminListener that will receive error- and progress messages.

Throws:

IOException - In case an I/O error occurs.

AccessDeniedException - In case the current user does not have write access on this repository.

See Also:

RDFFormat

addData

public void addData(SesameRepository repository,
                    AdminListener listener)
             throws IOException,
                    AccessDeniedException

Description copied from interface: SesameRepository

Adds the contents of the supplied SesameRepository to this repository.

Specified by:

addData in interface SesameRepository

Parameters:

repository - a SesameRepository.

listener - an AdminListener that will receive error- and progress messages.

Throws:

IOException - In case an I/O error occurs.

AccessDeniedException - In case the current user does not have write access on this repository.

See Also:

RDFFormat

addData

public void addData(Reader reader,
                    String baseURI,
                    RDFFormat format,
                    boolean verifyData,
                    AdminListener listener)
             throws IOException,
                    AccessDeniedException

Description copied from interface: SesameRepository

Adds RDF data from a Reader to the repository. Note: uploading XML-encoded RDF using a Reader can destroy the character encoding of the data. Using an InputStream can prevent this.

Specified by:

addData in interface SesameRepository

Parameters:

reader - a Reader from which RDF data can be read.

baseURI - the base URI to resolve any relative URIs against.

format - the serialization format of the data (one of RDFFormat.RDFXML, RDFFormat.NTRIPLES).

verifyData - if set to 'true', the RDF parser will verify the data before adding it to the repository.

listener - an AdminListener that will receive error- and progress messages.

Throws:

IOException - In case an I/O error occurs.

AccessDeniedException - In case the current user does not have write access on this repository.

See Also:

RDFFormat

addData

public void addData(InputStream dataStream,
                    String baseURI,
                    RDFFormat format,
                    boolean verifyData,
                    AdminListener listener)
             throws IOException,
                    AccessDeniedException

Description copied from interface: SesameRepository

Adds RDF data from an InputStream to the repository.

Specified by:

addData in interface SesameRepository

Parameters:

dataStream - an InputStream from which RDF data can be read.

baseURI - the base URI to resolve any relative URIs against.

format - the serialization format of the data (one of RDFFormat.RDFXML, RDFFormat.NTRIPLES).

verifyData - if set to 'true', the RDF parser will verify the data before adding it to the repository.

listener - an AdminListener that will receive error- and progress messages.

Throws:

IOException - In case an I/O error occurs.

AccessDeniedException - In case the current user does not have write access on this repository.

See Also:

RDFFormat

extractRDF

public InputStream extractRDF(RDFFormat format,
                              boolean ontology,
                              boolean instances,
                              boolean explicitOnly,
                              boolean niceOutput)
                       throws IOException,
                              AccessDeniedException

Description copied from interface: SesameRepository

Extracts data from the repository and returns it in the requested format. You can either extract the ontological data, the instance data, or both. For any of these, you can specify whether you want to extract all statements, or only the ones that were explicitly added.

Specified by:

extractRDF in interface SesameRepository

Parameters:

format - The serialization format that should be used (one of RDFFormat.RDFXML, RDFFormat.NTRIPLES, RDFFormat.N3).

ontology - If true, the ontological part of the data will be extracted.

instances - If true, the instances part of the data will be extracted.

explicitOnly - If true, only explicitely added statements will be extracted, i.e. the inferred statements will be skipped.

niceOutput - If true, the server will try its best to make the data as much readable for humans as possible. Note that this will cost extra processing time, and it should be set to 'false' if not necessary.

Throws:

IOException - In case an I/O error occurs.

AccessDeniedException - In case the current user does not have read access on this repository.

See Also:

RDFFormat

extractRDF

public void extractRDF(RdfDocumentWriter rdfDocWriter,
                       boolean ontology,
                       boolean instances,
                       boolean explicitOnly,
                       boolean niceOutput)
                throws IOException,
                       AccessDeniedException

Extracts data from the repository and reports the triples to the supplied RdfDocumentWriter.

Parameters:

rdfDocWriter - The RdfDocumentWriter to report the triples to.

ontology - If true the ontological statements will be extracted.

instances - If true the instance (non-schema) statements will be extracted.

explicitOnly - If true, only the explicitly added statements will be extracted.

niceOutput - If true, the extracted statements will be sorted by their subject.

Throws:

IOException

AccessDeniedException

removeStatements

public void removeStatements(Resource subject,
                             URI predicate,
                             Value object,
                             AdminListener listener)
                      throws IOException,
                             AccessDeniedException

Description copied from interface: SesameRepository

Removes statements from the repository. Statements that match the pattern specified by the parameters subject, predicate and object will be removed from the repository. null values for these parameters indicate wildcards. So calling removeStatements(mySubject, null, null, l) will remove all statements with a subject equal to mySubject.

Specified by:

removeStatements in interface SesameRepository

Parameters:

subject - The subject of the statements that should be removed, or null if the subject is allowed to be anything.

predicate - The predicate of the statements that should be removed, or null if the predicate is allowed to be anything.

object - The object of the statements that should be removed, or null if the object is allowed to be anything.

listener - An AdminListener that will receive error- and progress messages.

Throws:

IOException - In case an I/O error occurs.

AccessDeniedException - In case the current user does not have write access on this repository.

clear

public void clear(AdminListener listener)
           throws IOException,
                  AccessDeniedException

Description copied from interface: SesameRepository

Clears the repository. All statements will be removed.

Specified by:

clear in interface SesameRepository

Parameters:

listener - An AdminListener that will receive error- and progress messages.

Throws:

AccessDeniedException - In case the current user does not have write access on this repository.

IOException - In case an I/O error occurs.

getSail

public Sail getSail()

Gets the SAIL object of this repository. Note that no security restrictions are placed on the Sail; it is the developer's responsibility to check access restrictions before doing operations on the Sail.

shutDown

public void shutDown()

Shuts down the repository. Once shut down, the repository can no longer be queried or modified.

mergeGraph

public void mergeGraph(Graph graph)
                throws IOException,
                       AccessDeniedException

Throws:

IOException

AccessDeniedException

mergeGraph

public void mergeGraph(QueryLanguage language,
                       String query)
                throws IOException,
                       AccessDeniedException

Throws:

IOException

AccessDeniedException

addGraph

public void addGraph(Graph graph)
              throws IOException,
                     AccessDeniedException

Description copied from interface: SesameRepository

Adds the contents of the supplied graph to the repository. Blank nodes in the supplied graph that originate from this repository are reused.

Specified by:

addGraph in interface SesameRepository

Parameters:

graph - a Graph containing the RDF statements to be added.

Throws:

IOException - in case an I/O error occurs.

AccessDeniedException - In case the current user does not have write access on this repository.

See Also:

Graph

addGraph

public void addGraph(Graph graph,
                     boolean joinBlankNodes)
              throws IOException,
                     AccessDeniedException

Description copied from interface: SesameRepository

Adds the contents of the supplied graph to the repository.

Specified by:

addGraph in interface SesameRepository

Parameters:

graph - a Graph containing the RDF statements to be added.

joinBlankNodes - indicates adding behavior. If set to true, blank nodes in the supplied graph that originate from this repository are reused. If set to false, new blank nodes are created for each blank node in the supplied graph.

Throws:

AccessDeniedException - In case the current user does not have write access on this repository.

IOException - in case an I/O error occurs.

See Also:

Graph

removeGraph

public void removeGraph(Graph graph)
                 throws IOException,
                        AccessDeniedException

Description copied from interface: SesameRepository

Removes the contents of the supplied graph from the repository. All statements in the graph are removed from the repository. Blank nodes in the supplied graph that originate from this repository are reused.

Specified by:

removeGraph in interface SesameRepository

Parameters:

graph - a Graph containing RDF statements that are to be removed.

Throws:

IOException - in case an I/O error occurs.

AccessDeniedException - In case the current user does not have write access on this repository.

See Also:

Graph

getGraph

public Graph getGraph()
               throws AccessDeniedException

Creates a Graph representation of this repository. Note that any changes on the Graph object will be reflected in this repository immediately!

Returns:

a Graph object that uses this repository as the backing store.

Throws:

AccessDeniedException - In case one does not have both read and write access on this repository.

addGraph

public void addGraph(QueryLanguage language,
                     String query)
              throws IOException,
                     AccessDeniedException

Description copied from interface: SesameRepository

Adds the contents of the graph specified by the supplied graph query to the repository. Blank nodes in the supplied graph that originate from this repository are reused.

Specified by:

addGraph in interface SesameRepository

Parameters:

language - the query language in which the query is formulated.

query - the query. Note that the query must be of a form that has an RDF graph as its result (e.g. a SeRQL CONSTRUCT query)

Throws:

IOException - in case an I/O error occurs

AccessDeniedException - in case the current user does not have write access on this repository.

addGraph

public void addGraph(QueryLanguage language,
                     String query,
                     boolean joinBlankNodes)
              throws IOException,
                     AccessDeniedException

Description copied from interface: SesameRepository

Adds the contents of the graph specified by the supplied graph query to the repository.

Specified by:

addGraph in interface SesameRepository

Parameters:

language - the query language in which the query is formulated.

query - the query. Note that the query must be of a form that has an RDF graph as its result (e.g. a SeRQL CONSTRUCT query)

joinBlankNodes - indicates adding behavior. If set to true, blank nodes in the supplied graph that originate from this repository are reused. If set to false, new blank nodes are created for each blank node in the supplied graph.

Throws:

AccessDeniedException - in case the current user does not have write access on this repository.

IOException - in case an I/O error occurs

removeGraph

public void removeGraph(QueryLanguage language,
                        String query)
                 throws IOException,
                        AccessDeniedException

Description copied from interface: SesameRepository

Removes the contents of the graph specified by the supplied graph query from the repository. Blank nodes in the supplied graph that originate from this repository are reused.

Specified by:

removeGraph in interface SesameRepository

Parameters:

language - the query language in which the query is formulated.

query - the query. Note that the query must be of a form that has an RDF graph as its result (e.g. a SeRQL CONSTRUCT query)

Throws:

AccessDeniedException - in case the current user does not have write access on this repository.

IOException - in case an I/O error occurs

getRepositoryId

public String getRepositoryId()

Description copied from interface: SesameRepository

retrieves the repository id string for this repository.

Specified by:

getRepositoryId in interface SesameRepository

Returns:

the id of the repository.

addListener

public void addListener(LocalRepositoryChangedListener listener)

removeListener

public void removeListener(LocalRepositoryChangedListener listener)

sailChanged

public void sailChanged(SailChangedEvent event)

Specified by:

sailChanged in interface SailChangedListener