org.openrdf.repository.contextaware

Class ContextAwareConnection

java.lang.Object

org.openrdf.repository.base.RepositoryConnectionBase

org.openrdf.repository.base.RepositoryConnectionWrapper

org.openrdf.repository.contextaware.ContextAwareConnection

All Implemented Interfaces:

DelegatingRepositoryConnection, RepositoryConnection

public class ContextAwareConnection
extends RepositoryConnectionWrapper

Allows contexts to be specified at the connection level or the method level.

Author:

James Leigh

Field Summary

Fields inherited from class org.openrdf.repository.base.RepositoryConnectionBase

logger

Constructor Summary

Constructors

Constructor and Description
ContextAwareConnection(Repository repository)
ContextAwareConnection(RepositoryConnection connection)
ContextAwareConnection(Repository repository, RepositoryConnection connection)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(File file, RDFFormat dataFormat, Resource... contexts)
void	add(File file, String baseURI, RDFFormat dataFormat, Resource... contexts)
void	add(InputStream in, RDFFormat dataFormat, Resource... contexts)
void	add(InputStream in, String baseURI, RDFFormat dataFormat, Resource... contexts)
void	add(Iterable<? extends Statement> statements, Resource... contexts)
<E extends Exception> void	add(Iteration<? extends Statement,E> statementIter, Resource... contexts)
void	add(Reader reader, RDFFormat dataFormat, Resource... contexts)
void	add(Reader reader, String baseURI, RDFFormat dataFormat, Resource... contexts)
void	add(Resource subject, URI predicate, Value object, Resource... contexts)
void	add(Statement st, Resource... contexts)
void	add(URL url, RDFFormat dataFormat, Resource... contexts)
void	add(URL url, String baseURI, RDFFormat dataFormat, Resource... contexts)
void	clear(Resource... contexts)
void	export(RDFHandler handler, Resource... contexts)
void	exportStatements(Resource subj, URI pred, Value obj, boolean includeInferred, RDFHandler handler, Resource... contexts)
void	exportStatements(Resource subj, URI pred, Value obj, RDFHandler handler, Resource... contexts) Exports all statements with a specific subject, predicate and/or object from the repository, optionally from the specified contexts.
URI[]	getAddContexts() Deprecated.
URI[]	getArchiveContexts() Deprecated.
String	getBaseURI()
URI	getInsertContext() The default context to add the statements to.
int	getMaxQueryTime()
QueryLanguage	getQueryLanguage()
URI[]	getReadContexts() The default context(s) to get the data from.
URI[]	getRemoveContexts() The context(s) to remove the data from.
RepositoryResult<Statement>	getStatements(Resource subj, URI pred, Value obj, boolean includeInferred, Resource... contexts)
RepositoryResult<Statement>	getStatements(Resource subj, URI pred, Value obj, Resource... contexts) Gets all statements with a specific subject, predicate and/or object from the repository.
boolean	hasStatement(Resource subj, URI pred, Value obj, boolean includeInferred, Resource... contexts)
boolean	hasStatement(Resource subj, URI pred, Value obj, Resource... contexts) Checks whether the repository contains statements with a specific subject, predicate and/or object, optionally in the specified contexts.
boolean	hasStatement(Statement st, boolean includeInferred, Resource... contexts)
boolean	hasStatement(Statement st, Resource... contexts) Checks whether the repository contains the specified statement, optionally in the specified contexts.
protected boolean	isDelegatingRemove()
boolean	isIncludeInferred() if false, no inferred statements are considered; if true, inferred statements are considered if available
BooleanQuery	prepareBooleanQuery(QueryLanguage ql, String query)
BooleanQuery	prepareBooleanQuery(QueryLanguage ql, String query, String baseURI)
GraphQuery	prepareGraphQuery(QueryLanguage ql, String query)
GraphQuery	prepareGraphQuery(QueryLanguage ql, String query, String baseURI)
GraphQuery	prepareGraphQuery(String query)
Query	prepareQuery(QueryLanguage ql, String query)
Query	prepareQuery(QueryLanguage ql, String query, String baseURI)
Query	prepareQuery(String query)
TupleQuery	prepareTupleQuery(QueryLanguage ql, String query)
TupleQuery	prepareTupleQuery(QueryLanguage ql, String query, String baseURI)
TupleQuery	prepareTupleQuery(String query)
Update	prepareUpdate(QueryLanguage ql, String query)
Update	prepareUpdate(QueryLanguage ql, String update, String baseURI)
Update	prepareUpdate(String query)
void	remove(Iterable<? extends Statement> statements, Resource... contexts)
<E extends Exception> void	remove(Iteration<? extends Statement,E> statementIter, Resource... contexts) Removes the supplied statements from a specific context in this repository, ignoring any context information carried by the statements themselves.
void	remove(Resource subject, URI predicate, Value object, Resource... contexts) Removes the statement with the specified subject, predicate and object from the repository, optionally restricted to the specified contexts.
void	remove(Statement st, Resource... contexts) Removes the supplied statement from the specified contexts in the repository.
protected void	removeWithoutCommit(Resource subject, URI predicate, Value object, Resource... contexts)
void	setAddContexts(URI... addContexts) Deprecated.
void	setArchiveContexts(URI... archiveContexts) Deprecated.
void	setBaseURI(String baseURI)
void	setIncludeInferred(boolean includeInferred) if false, no inferred statements are considered; if true, inferred statements are considered if available
void	setInsertContext(URI insertContext) The default context to add the statements to.
void	setMaxQueryTime(int maxQueryTime)
void	setQueryLanguage(QueryLanguage ql)
void	setReadContexts(URI... readContexts) The default context(s) to get the data from.
void	setRemoveContexts(URI... removeContexts) The context(s) to remove the data from.
long	size(Resource... contexts) Returns the number of (explicit) statements that are in the specified contexts in this repository.

Methods inherited from class org.openrdf.repository.base.RepositoryConnectionWrapper

addWithoutCommit, begin, clearNamespaces, close, commit, exportStatements, getContextIDs, getDelegate, getNamespace, getNamespaces, isActive, isAutoCommit, isDelegatingAdd, isDelegatingRead, isEmpty, isOpen, removeNamespace, rollback, setAutoCommit, setDelegate, setNamespace, setParserConfig

Methods inherited from class org.openrdf.repository.base.RepositoryConnectionBase

addWithoutCommit, conditionalCommit, conditionalRollback, getParserConfig, getRepository, getValueFactory, removeWithoutCommit, startLocalTransaction

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openrdf.repository.RepositoryConnection

getParserConfig, getRepository, getValueFactory

Constructor Detail

ContextAwareConnection

public ContextAwareConnection(Repository repository)
                       throws RepositoryException

Throws:

RepositoryException

ContextAwareConnection

public ContextAwareConnection(RepositoryConnection connection)
                       throws RepositoryException

Throws:

RepositoryException

ContextAwareConnection

public ContextAwareConnection(Repository repository,
                      RepositoryConnection connection)
                       throws RepositoryException

Throws:

RepositoryException

Method Detail

isDelegatingRemove

protected boolean isDelegatingRemove()
                              throws RepositoryException

Overrides:

isDelegatingRemove in class RepositoryConnectionWrapper

Throws:

RepositoryException

isIncludeInferred

public boolean isIncludeInferred()

if false, no inferred statements are considered; if true, inferred statements are considered if available

setIncludeInferred

public void setIncludeInferred(boolean includeInferred)

if false, no inferred statements are considered; if true, inferred statements are considered if available

getMaxQueryTime

public int getMaxQueryTime()

setMaxQueryTime

public void setMaxQueryTime(int maxQueryTime)

getQueryLanguage

public QueryLanguage getQueryLanguage()

setQueryLanguage

public void setQueryLanguage(QueryLanguage ql)

getBaseURI

public String getBaseURI()

Returns:

Returns the default baseURI.

setBaseURI

public void setBaseURI(String baseURI)

Parameters:

baseURI - The default baseURI to set.

getReadContexts

public URI[] getReadContexts()

The default context(s) to get the data from. Note that this parameter is a vararg and as such is optional. If no contexts are supplied the method operates on the entire repository.

setReadContexts

public void setReadContexts(URI... readContexts)

The default context(s) to get the data from. Note that this parameter is a vararg and as such is optional. If no contexts are supplied the method operates on the entire repository.

getAddContexts

@Deprecated
public URI[] getAddContexts()

Deprecated.

The contexts to add the statements to. Note that this parameter is a vararg and as such is optional. If no contexts are specified, each statement is added to any context specified in the statement, or if the statement contains no context, it is added without a context. If one or more contexts are specified each statement is added to these contexts, ignoring any context information in the statement itself.

setAddContexts

@Deprecated
public void setAddContexts(URI... addContexts)

Deprecated.

The contexts to add the statements to. Note that this parameter is a vararg and as such is optional. If no contexts are specified, each statement is added to any context specified in the statement, or if the statement contains no context, it is added without a context. If one or more contexts are specified each statement is added to these contexts, ignoring any context information in the statement itself.

getRemoveContexts

public URI[] getRemoveContexts()

The context(s) to remove the data from. Note that this parameter is a vararg and as such is optional. If no contexts are supplied the method operates on the contexts associated with the statement itself, and if no context is associated with the statement, on the entire repository.

setRemoveContexts

public void setRemoveContexts(URI... removeContexts)

The context(s) to remove the data from. Note that this parameter is a vararg and as such is optional. If no contexts are supplied the method operates on the contexts associated with the statement itself, and if no context is associated with the statement, on the entire repository.

getArchiveContexts

@Deprecated
public URI[] getArchiveContexts()

Deprecated.

Before Statements are removed, they are first copied to these contexts.

setArchiveContexts

@Deprecated
public void setArchiveContexts(URI... archiveContexts)

Deprecated.

Before Statements are removed, they are first copied to these contexts.

getInsertContext

public URI getInsertContext()

The default context to add the statements to. For INSERT/add operations Each statement is added to any context specified in the statement, or if the statement contains no context, it is added with the context specified here.

setInsertContext

public void setInsertContext(URI insertContext)

The default context to add the statements to. For INSERT/add operations Each statement is added to any context specified in the statement, or if the statement contains no context, it is added with the context specified here.

add

public void add(File file,
       RDFFormat dataFormat,
       Resource... contexts)
         throws IOException,
                RDFParseException,
                RepositoryException

Throws:

IOException

RDFParseException

RepositoryException

add

public void add(File file,
       String baseURI,
       RDFFormat dataFormat,
       Resource... contexts)
         throws IOException,
                RDFParseException,
                RepositoryException

Specified by:

add in interface RepositoryConnection

Overrides:

add in class RepositoryConnectionWrapper

Throws:

IOException

RDFParseException

RepositoryException

add

public void add(InputStream in,
       RDFFormat dataFormat,
       Resource... contexts)
         throws IOException,
                RDFParseException,
                RepositoryException

Throws:

IOException

RDFParseException

RepositoryException

add

public void add(InputStream in,
       String baseURI,
       RDFFormat dataFormat,
       Resource... contexts)
         throws IOException,
                RDFParseException,
                RepositoryException

Specified by:

add in interface RepositoryConnection

Overrides:

add in class RepositoryConnectionWrapper

Throws:

IOException

RDFParseException

RepositoryException

add

public void add(Iterable<? extends Statement> statements,
       Resource... contexts)
         throws RepositoryException

Specified by:

add in interface RepositoryConnection

Overrides:

add in class RepositoryConnectionWrapper

Throws:

RepositoryException

add

public <E extends Exception> void add(Iteration<? extends Statement,E> statementIter,
                             Resource... contexts)
         throws RepositoryException,
                E extends Exception

Specified by:

add in interface RepositoryConnection

Overrides:

add in class RepositoryConnectionWrapper

Throws:

RepositoryException

E extends Exception

add

public void add(Reader reader,
       RDFFormat dataFormat,
       Resource... contexts)
         throws IOException,
                RDFParseException,
                RepositoryException

Throws:

IOException

RDFParseException

RepositoryException

add

public void add(Reader reader,
       String baseURI,
       RDFFormat dataFormat,
       Resource... contexts)
         throws IOException,
                RDFParseException,
                RepositoryException

Specified by:

add in interface RepositoryConnection

Overrides:

add in class RepositoryConnectionWrapper

Throws:

IOException

RDFParseException

RepositoryException

add

public void add(Resource subject,
       URI predicate,
       Value object,
       Resource... contexts)
         throws RepositoryException

Specified by:

add in interface RepositoryConnection

Overrides:

add in class RepositoryConnectionWrapper

Throws:

RepositoryException

add

public void add(Statement st,
       Resource... contexts)
         throws RepositoryException

Specified by:

add in interface RepositoryConnection

Overrides:

add in class RepositoryConnectionWrapper

Throws:

RepositoryException

add

public void add(URL url,
       RDFFormat dataFormat,
       Resource... contexts)
         throws IOException,
                RDFParseException,
                RepositoryException

Throws:

IOException

RDFParseException

RepositoryException

add

public void add(URL url,
       String baseURI,
       RDFFormat dataFormat,
       Resource... contexts)
         throws IOException,
                RDFParseException,
                RepositoryException

Specified by:

add in interface RepositoryConnection

Overrides:

add in class RepositoryConnectionWrapper

Throws:

IOException

RDFParseException

RepositoryException

clear

public void clear(Resource... contexts)
           throws RepositoryException

Specified by:

clear in interface RepositoryConnection

Overrides:

clear in class RepositoryConnectionWrapper

Throws:

RepositoryException

export

public void export(RDFHandler handler,
          Resource... contexts)
            throws RepositoryException,
                   RDFHandlerException

Specified by:

export in interface RepositoryConnection

Overrides:

export in class RepositoryConnectionBase

Throws:

RepositoryException

RDFHandlerException

exportStatements

public void exportStatements(Resource subj,
                    URI pred,
                    Value obj,
                    RDFHandler handler,
                    Resource... contexts)
                      throws RepositoryException,
                             RDFHandlerException

Exports all statements with a specific subject, predicate and/or object from the repository, optionally from the specified contexts.

Parameters:

subj - The subject, or null if the subject doesn't matter.

pred - The predicate, or null if the predicate doesn't matter.

obj - The object, or null if the object doesn't matter.

handler - The handler that will handle the RDF data.

Throws:

RDFHandlerException - If the handler encounters an unrecoverable error.

RepositoryException

See Also:

getReadContexts(), isIncludeInferred()

exportStatements

public void exportStatements(Resource subj,
                    URI pred,
                    Value obj,
                    boolean includeInferred,
                    RDFHandler handler,
                    Resource... contexts)
                      throws RepositoryException,
                             RDFHandlerException

Specified by:

exportStatements in interface RepositoryConnection

Overrides:

exportStatements in class RepositoryConnectionWrapper

Throws:

RepositoryException

RDFHandlerException

getStatements

public RepositoryResult<Statement> getStatements(Resource subj,
                                        URI pred,
                                        Value obj,
                                        Resource... contexts)
                                          throws RepositoryException

Gets all statements with a specific subject, predicate and/or object from the repository. The result is optionally restricted to the specified set of named contexts.

Parameters:

subj - A Resource specifying the subject, or null for a wildcard.

pred - A URI specifying the predicate, or null for a wildcard.

obj - A Value specifying the object, or null for a wildcard.

Returns:

The statements matching the specified pattern. The result object is a RepositoryResult object, a lazy Iterator-like object containing Statements and optionally throwing a RepositoryException when an error when a problem occurs during retrieval.

Throws:

RepositoryException

See Also:

getReadContexts(), isIncludeInferred()

getStatements

public RepositoryResult<Statement> getStatements(Resource subj,
                                        URI pred,
                                        Value obj,
                                        boolean includeInferred,
                                        Resource... contexts)
                                          throws RepositoryException

Specified by:

getStatements in interface RepositoryConnection

Overrides:

getStatements in class RepositoryConnectionWrapper

Throws:

RepositoryException

hasStatement

public boolean hasStatement(Resource subj,
                   URI pred,
                   Value obj,
                   boolean includeInferred,
                   Resource... contexts)
                     throws RepositoryException

Specified by:

hasStatement in interface RepositoryConnection

Overrides:

hasStatement in class RepositoryConnectionWrapper

Throws:

RepositoryException

hasStatement

public boolean hasStatement(Statement st,
                   boolean includeInferred,
                   Resource... contexts)
                     throws RepositoryException

Specified by:

hasStatement in interface RepositoryConnection

Overrides:

hasStatement in class RepositoryConnectionWrapper

Throws:

RepositoryException

hasStatement

public boolean hasStatement(Resource subj,
                   URI pred,
                   Value obj,
                   Resource... contexts)
                     throws RepositoryException

Checks whether the repository contains statements with a specific subject, predicate and/or object, optionally in the specified contexts.

Parameters:

subj - A Resource specifying the subject, or null for a wildcard.

pred - A URI specifying the predicate, or null for a wildcard.

obj - A Value specifying the object, or null for a wildcard.

Returns:

true If a matching statement is in the repository in the specified context, false otherwise.

Throws:

RepositoryException

See Also:

getReadContexts(), isIncludeInferred()

hasStatement

public boolean hasStatement(Statement st,
                   Resource... contexts)
                     throws RepositoryException

Checks whether the repository contains the specified statement, optionally in the specified contexts.

Parameters:

st - The statement to look for. Context information in the statement is ignored.

Returns:

true If the repository contains the specified statement, false otherwise.

Throws:

RepositoryException

See Also:

getReadContexts(), isIncludeInferred()

prepareGraphQuery

public GraphQuery prepareGraphQuery(String query)
                             throws MalformedQueryException,
                                    RepositoryException

Throws:

MalformedQueryException

RepositoryException

prepareQuery

public Query prepareQuery(String query)
                   throws MalformedQueryException,
                          RepositoryException

Throws:

MalformedQueryException

RepositoryException

prepareTupleQuery

public TupleQuery prepareTupleQuery(String query)
                             throws MalformedQueryException,
                                    RepositoryException

Throws:

MalformedQueryException

RepositoryException

prepareUpdate

public Update prepareUpdate(String query)
                     throws MalformedQueryException,
                            RepositoryException

Throws:

MalformedQueryException

RepositoryException

prepareGraphQuery

public GraphQuery prepareGraphQuery(QueryLanguage ql,
                           String query)
                             throws MalformedQueryException,
                                    RepositoryException

Specified by:

prepareGraphQuery in interface RepositoryConnection

Overrides:

prepareGraphQuery in class RepositoryConnectionBase

Throws:

MalformedQueryException

RepositoryException

prepareQuery

public Query prepareQuery(QueryLanguage ql,
                 String query)
                   throws MalformedQueryException,
                          RepositoryException

Specified by:

prepareQuery in interface RepositoryConnection

Overrides:

prepareQuery in class RepositoryConnectionBase

Throws:

MalformedQueryException

RepositoryException

prepareTupleQuery

public TupleQuery prepareTupleQuery(QueryLanguage ql,
                           String query)
                             throws MalformedQueryException,
                                    RepositoryException

Specified by:

prepareTupleQuery in interface RepositoryConnection

Overrides:

prepareTupleQuery in class RepositoryConnectionBase

Throws:

MalformedQueryException

RepositoryException

prepareBooleanQuery

public BooleanQuery prepareBooleanQuery(QueryLanguage ql,
                               String query)
                                 throws MalformedQueryException,
                                        RepositoryException

Specified by:

prepareBooleanQuery in interface RepositoryConnection

Overrides:

prepareBooleanQuery in class RepositoryConnectionBase

Throws:

MalformedQueryException

RepositoryException

prepareUpdate

public Update prepareUpdate(QueryLanguage ql,
                   String query)
                     throws MalformedQueryException,
                            RepositoryException

Specified by:

prepareUpdate in interface RepositoryConnection

Overrides:

prepareUpdate in class RepositoryConnectionBase

Throws:

MalformedQueryException

RepositoryException

prepareGraphQuery

public GraphQuery prepareGraphQuery(QueryLanguage ql,
                           String query,
                           String baseURI)
                             throws MalformedQueryException,
                                    RepositoryException

Specified by:

prepareGraphQuery in interface RepositoryConnection

Overrides:

prepareGraphQuery in class RepositoryConnectionWrapper

Throws:

MalformedQueryException

RepositoryException

prepareQuery

public Query prepareQuery(QueryLanguage ql,
                 String query,
                 String baseURI)
                   throws MalformedQueryException,
                          RepositoryException

Specified by:

prepareQuery in interface RepositoryConnection

Overrides:

prepareQuery in class RepositoryConnectionWrapper

Throws:

MalformedQueryException

RepositoryException

prepareTupleQuery

public TupleQuery prepareTupleQuery(QueryLanguage ql,
                           String query,
                           String baseURI)
                             throws MalformedQueryException,
                                    RepositoryException

Specified by:

prepareTupleQuery in interface RepositoryConnection

Overrides:

prepareTupleQuery in class RepositoryConnectionWrapper

Throws:

MalformedQueryException

RepositoryException

prepareBooleanQuery

public BooleanQuery prepareBooleanQuery(QueryLanguage ql,
                               String query,
                               String baseURI)
                                 throws MalformedQueryException,
                                        RepositoryException

Specified by:

prepareBooleanQuery in interface RepositoryConnection

Overrides:

prepareBooleanQuery in class RepositoryConnectionWrapper

Throws:

MalformedQueryException

RepositoryException

prepareUpdate

public Update prepareUpdate(QueryLanguage ql,
                   String update,
                   String baseURI)
                     throws MalformedQueryException,
                            RepositoryException

Specified by:

prepareUpdate in interface RepositoryConnection

Overrides:

prepareUpdate in class RepositoryConnectionWrapper

Throws:

MalformedQueryException

RepositoryException

remove

public void remove(Iterable<? extends Statement> statements,
          Resource... contexts)
            throws RepositoryException

Specified by:

remove in interface RepositoryConnection

Overrides:

remove in class RepositoryConnectionWrapper

Throws:

RepositoryException

remove

public <E extends Exception> void remove(Iteration<? extends Statement,E> statementIter,
                                Resource... contexts)
            throws RepositoryException,
                   E extends Exception

Removes the supplied statements from a specific context in this repository, ignoring any context information carried by the statements themselves.

Specified by:

remove in interface RepositoryConnection

Overrides:

remove in class RepositoryConnectionWrapper

Parameters:

statementIter - The statements to remove. In case the iterator is a CloseableIteration, it will be closed before this method returns.

Throws:

RepositoryException - If the statements could not be removed from the repository, for example because the repository is not writable.

E extends Exception

See Also:

getRemoveContexts()

remove

public void remove(Resource subject,
          URI predicate,
          Value object,
          Resource... contexts)
            throws RepositoryException

Removes the statement with the specified subject, predicate and object from the repository, optionally restricted to the specified contexts.

Specified by:

remove in interface RepositoryConnection

Overrides:

remove in class RepositoryConnectionWrapper

Parameters:

subject - The statement's subject.

predicate - The statement's predicate.

object - The statement's object.

Throws:

RepositoryException - If the statement could not be removed from the repository, for example because the repository is not writable.

See Also:

getRemoveContexts()

remove

public void remove(Statement st,
          Resource... contexts)
            throws RepositoryException

Removes the supplied statement from the specified contexts in the repository.

Specified by:

remove in interface RepositoryConnection

Overrides:

remove in class RepositoryConnectionWrapper

Parameters:

st - The statement to remove.

Throws:

RepositoryException - If the statement could not be removed from the repository, for example because the repository is not writable.

See Also:

getRemoveContexts()

size

public long size(Resource... contexts)
          throws RepositoryException

Returns the number of (explicit) statements that are in the specified contexts in this repository.

Specified by:

size in interface RepositoryConnection

Overrides:

size in class RepositoryConnectionWrapper

Returns:

The number of explicit statements from the specified contexts in this repository.

Throws:

RepositoryException

See Also:

getReadContexts()

removeWithoutCommit

protected void removeWithoutCommit(Resource subject,
                       URI predicate,
                       Value object,
                       Resource... contexts)
                            throws RepositoryException

Overrides:

removeWithoutCommit in class RepositoryConnectionWrapper

Throws:

RepositoryException