| org.openrdf.sail.SailConnection
All known Subclasses: org.openrdf.sail.helpers.SailConnectionBase, org.openrdf.sail.helpers.SailConnectionWrapper,
| SailConnection | | public interface SailConnection (Code) | | A connection to an RDF Sail object. A SailConnection is active from the
moment it is created until it is closed. Care should be taken to properly
close SailConnections as they might block concurrent queries and/or updates
on the Sail while active, depending on the Sail-implementation that is being
used.
author:
jeen
author:
Arjohn Kampman |
| Method Summary | |
| public void | addConnectionListener(SailConnectionListener listener)
Registers a SailConnection listener with this SailConnection. | | public void | addStatement(Resource subj, URI pred, Value obj, Resource... contexts)
Adds a statement to each context in the specified contexts.
Parameters:
subj - The subject of the statement to add.
Parameters:
pred - The predicate of the statement to add.
Parameters:
obj - The object of the statement to add.
Parameters:
contexts - The context(s) to add the statement to. | | public void | clear(Resource... contexts)
Removes all statements from the specified/all contexts. | | public void | clearNamespaces()
Removes all namespace declarations from the repository. | | public void | close()
Closes the connection. | | public void | commit()
Commits any updates that have been performed since the last time
SailConnection.commit() or
SailConnection.rollback() was called. | | public CloseableIteration<? extends BindingSet, QueryEvaluationException> | evaluate(TupleExpr tupleExpr, Dataset dataset, BindingSet bindings, boolean includeInferred)
Evaluates the supplied TupleExpr on the data contained in this Sail
object, using the (optional) dataset and supplied bindings as input
parameters.
Parameters:
tupleQuery - The TupleQuery to evaluate.
Parameters:
dataset - The dataset to use for evaluating the query, null to usethe Sail's default dataset.
Parameters:
bindings - A set of input parameters for the query evaluation. | | public CloseableIteration<? extends Resource, SailException> | getContextIDs()
Returns the set of all unique context identifiers that are used to store
statements. | | public String | getNamespace(String prefix)
Gets the namespace that is mapped to the specified prefix.
Parameters:
prefix - A namespace prefix. | | public CloseableIteration<? extends Namespace, SailException> | getNamespaces()
Gets the namespaces relevant to the data contained in this Sail object. | | public CloseableIteration<? extends Statement, SailException> | getStatements(Resource subj, URI pred, Value obj, boolean includeInferred, Resource... contexts)
Gets all statements from the specified contexts that have a specific
subject, predicate and/or object. | | public boolean | isOpen()
Checks whether this SailConnection is open. | | public void | removeConnectionListener(SailConnectionListener listener)
Deregisters a SailConnection listener with this SailConnection. | | public void | removeNamespace(String prefix)
Removes a namespace declaration by removing the association between a
prefix and a namespace name. | | public void | removeStatements(Resource subj, URI pred, Value obj, Resource... context)
Removes all statements matching the specified subject, predicate and
object from the repository. | | public void | rollback()
Rolls back the SailConnection, discarding any uncommitted changes that
have been made in this SailConnection. | | public void | setNamespace(String prefix, String name)
Sets the prefix of a namespace. | | public long | size(Resource... contexts)
Returns the number of (explicit) statements. |
| addConnectionListener | | public void addConnectionListener(SailConnectionListener listener)(Code) | | Registers a SailConnection listener with this SailConnection. The listener
should be notified of any statements that are added or removed as part of
this SailConnection.
Parameters:
listener - A SailConnectionListener. |
| addStatement | | public void addStatement(Resource subj, URI pred, Value obj, Resource... contexts) throws SailException(Code) | | Adds a statement to each context in the specified contexts.
Parameters:
subj - The subject of the statement to add.
Parameters:
pred - The predicate of the statement to add.
Parameters:
obj - The object of the statement to add.
Parameters:
contexts - The context(s) to add the statement to. Note that this parameter isa vararg and as such is optional. If no contexts are supplied themethod operates on the entire repository.
throws:
SailException - If the statement could not be added. |
| clear | | public void clear(Resource... contexts) throws SailException(Code) | | Removes all statements from the specified/all contexts. If no contexts are
specified the method operates on the entire repository.
Parameters:
contexts - The context(s) from which to remove the statements. Note that thisparameter is a vararg and as such is optional. If no contexts aresupplied the method operates on the entire repository.
throws:
SailException - If the statements could not be removed. |
| clearNamespaces | | public void clearNamespaces() throws SailException(Code) | | Removes all namespace declarations from the repository.
throws:
SailException - If the namespaces could not be removed. |
| close | | public void close() throws SailException(Code) | | Closes the connection. Any updates that haven't been committed yet will be
rolled back. The connection can no longer be used once it is closed.
|
| evaluate | | public CloseableIteration<? extends BindingSet, QueryEvaluationException> evaluate(TupleExpr tupleExpr, Dataset dataset, BindingSet bindings, boolean includeInferred) throws SailException(Code) | | Evaluates the supplied TupleExpr on the data contained in this Sail
object, using the (optional) dataset and supplied bindings as input
parameters.
Parameters:
tupleQuery - The TupleQuery to evaluate.
Parameters:
dataset - The dataset to use for evaluating the query, null to usethe Sail's default dataset.
Parameters:
bindings - A set of input parameters for the query evaluation. The keysreference variable names that should be bound to the value they mapto.
Parameters:
includeInferred - Indicates whether inferred triples are to be considered in thequery result. If false, no inferred statements are returned; iftrue, inferred statements are returned if available The TupleQueryResult.
throws:
SailException - If the Sail object encountered an error or unexpected situationinternally. |
| getContextIDs | | public CloseableIteration<? extends Resource, SailException> getContextIDs() throws SailException(Code) | | Returns the set of all unique context identifiers that are used to store
statements.
An iterator over the context identifiers, should not contain anyduplicates. |
| getNamespace | | public String getNamespace(String prefix) throws SailException(Code) | | Gets the namespace that is mapped to the specified prefix.
Parameters:
prefix - A namespace prefix. The namespace name that the specified prefix maps to. |
| getNamespaces | | public CloseableIteration<? extends Namespace, SailException> getNamespaces() throws SailException(Code) | | Gets the namespaces relevant to the data contained in this Sail object.
throws:
SailException - If the Sail object encountered an error or unexpected situationinternally. |
| getStatements | | public CloseableIteration<? extends Statement, SailException> getStatements(Resource subj, URI pred, Value obj, boolean includeInferred, Resource... contexts) throws SailException(Code) | | Gets all statements from the specified contexts that have a specific
subject, predicate and/or object. All three parameters may be null to
indicate wildcards. The includeInferred parameter can be used
to control which statements are fetched: all statements or only the
statements that have been added explicitly.
Parameters:
subj - A Resource specifying the subject, or null for awildcard.
Parameters:
pred - A URI specifying the predicate, or null for a wildcard.
Parameters:
obj - A Value specifying the object, or null for a wildcard.
Parameters:
includeInferred - if false, no inferred statements are returned; if true, inferredstatements are returned if available
Parameters:
contexts - The context(s) to get the data from. Note that this parameter is avararg and as such is optional. If no contexts are supplied themethod operates on the entire repository. The statements matching the specified pattern.
throws:
SailException - If the Sail object encountered an error or unexpected situationinternally. |
| isOpen | | public boolean isOpen() throws SailException(Code) | | Checks whether this SailConnection is open. A SailConnection is open from
the moment it is created until it is closed.
See Also: SailConnection.close |
| removeConnectionListener | | public void removeConnectionListener(SailConnectionListener listener)(Code) | | Deregisters a SailConnection listener with this SailConnection.
Parameters:
listener - A SailConnectionListener. |
| removeNamespace | | public void removeNamespace(String prefix) throws SailException(Code) | | Removes a namespace declaration by removing the association between a
prefix and a namespace name.
Parameters:
prefix - The namespace prefix of which the assocation with a namespace nameis to be removed.
throws:
SailException - If the namespace prefix could not be removed. |
| removeStatements | | public void removeStatements(Resource subj, URI pred, Value obj, Resource... context) throws SailException(Code) | | Removes all statements matching the specified subject, predicate and
object from the repository. All three parameters may be null to indicate
wildcards.
Parameters:
subj - The subject of the statement that should be removed, ornull to indicate a wildcard.
Parameters:
pred - The predicate of the statement that should be removed, ornull to indicate a wildcard.
Parameters:
obj - The object of the statement that should be removed , ornull to indicate a wildcard. *
Parameters:
contexts - The context(s) from which to remove the statement. Note that thisparameter is a vararg and as such is optional. If no contexts aresupplied the method operates on the entire repository.
throws:
SailException - If the statement could not be removed. |
| rollback | | public void rollback() throws SailException(Code) | | Rolls back the SailConnection, discarding any uncommitted changes that
have been made in this SailConnection.
throws:
SailException - If the SailConnection could not be rolled back. |
| setNamespace | | public void setNamespace(String prefix, String name) throws SailException(Code) | | Sets the prefix of a namespace.
Parameters:
prefix - The new prefix.
Parameters:
name - The namespace name that the prefix maps to. |
| size | | public long size(Resource... contexts) throws SailException(Code) | | Returns the number of (explicit) statements.
The number of explicit statements in this Sail. |
|
|