net.fortytwo.ripple.model

Interface ModelConnection

All Known Implementing Classes:

SesameModelConnection

public interface ModelConnection

A transactional connection to a Model. It permits the addition and removal of data to and from the model, handling of transactions, access to the total order of Ripple values in the model, and mapping of values into and out of Ripple space.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(RippleValue subj, RippleValue pred, RippleValue obj, RippleValue... contexts) Adds one or more RDF statements to the model.
RDFValue	booleanValue(boolean b) Constructs a boolean value.
RippleValue	canonicalValue(RDFValue v) Finds the "canonical" value, in Ripple space, for a given RDF value.
void	close() Closes this connection, releasing its resources and rolling back any uncommitted changes.
void	commit() Commits the current transaction.
info.aduna.iteration.CloseableIteration<? extends org.openrdf.query.BindingSet,org.openrdf.query.QueryEvaluationException>	evaluate(String query) Evaluates a SPARQL query against the model.
void	finish() Complete any still-executing tasks.
Comparator<RippleValue>	getComparator()
Source<RippleValue>	getContexts()
Model	getModel()
Source<org.openrdf.model.Namespace>	getNamespaces() Retrieves all namespaces defined in this model.
void	getStatements(RDFValue subj, RDFValue pred, RDFValue obj, Sink<org.openrdf.model.Statement> sink) Retrieves all statements in the model matching a given triple pattern.
boolean	internalize(RippleList list) Adds an RDF description of the given list to the model.
RDFValue	languageTaggedValue(String s, String language) Constructs a language-tagged literal value in Ripple space.
RippleList	list()
NumericValue	numericValue(BigDecimal bd) Constructs a big-decimal-typed numeric value.
NumericValue	numericValue(double d) Constructs a double-precision numeric value.
NumericValue	numericValue(int i) Constructs an integer-typed numeric value.
NumericValue	numericValue(long l) Constructs a long-integer-typed numeric value.
RDFValue	plainValue(String label) Constructs a plain literal value in Ripple space.
void	query(StatementPatternQuery query, Sink<RippleValue> sink, boolean asynchronous) Issues a triple pattern query over the model.
void	remove(RippleValue subj, RippleValue pred, RippleValue obj, RippleValue... contexts) Removes matching RDF statements from the model.
void	reset(boolean rollback) Returns the ModelConnection to a normal state after an Exception has been thrown.
void	setNamespace(String prefix, String ns, boolean override) Define a namespace prefix.
boolean	toBoolean(RippleValue v) Attempts to convert a Ripple value to a boolean value.
Date	toDateValue(RippleValue v) Attempts to convert a Ripple value to a date value.
void	toList(RippleValue v, Sink<RippleList> sink) Attempts to convert a Ripple value to a Ripple List.
NumericValue	toNumericValue(RippleValue v) Attempts to convert a Ripple value to a numeric value.
String	toString(RippleValue v) Attempts to convert a Ripple value to a string value.
RDFValue	typedValue(String label, org.openrdf.model.URI datatype) Constructs a typed RDF literal value.
RDFValue	uriValue(String uri) Construct an RDF URI reference.

Method Detail

getModel

Model getModel()

Returns:

the Model of this connection

close

void close()
           throws RippleException

Closes this connection, releasing its resources and rolling back any uncommitted changes.

Throws:

RippleException - if anything goes wrong

reset

void reset(boolean rollback)
           throws RippleException

Returns the ModelConnection to a normal state after an Exception has been thrown.

Parameters:

rollback - whether to roll back the current transaction

Throws:

RippleException - if anything goes wrong

commit

void commit()
            throws RippleException

Commits the current transaction.

Throws:

RippleException - if the transaction cannot be committed

toBoolean

boolean toBoolean(RippleValue v)
                  throws RippleException

Attempts to convert a Ripple value to a boolean value.

Parameters:

v - the value to convert. It must be of a type which is convertible to boolean.

Returns:

the resulting boolean value

Throws:

RippleException - if the value cannot be converted

toNumericValue

NumericValue toNumericValue(RippleValue v)
                            throws RippleException

Attempts to convert a Ripple value to a numeric value.

Parameters:

v - the value to convert. It must be of a type which is convertible to a number.

Returns:

the resulting numeric value

Throws:

RippleException - if the value cannot be converted

toDateValue

Date toDateValue(RippleValue v)
                 throws RippleException

Attempts to convert a Ripple value to a date value.

Parameters:

v - the value to convert. It must be of a type which is convertible to a date.

Returns:

the resulting date

Throws:

RippleException - if the value cannot be converted

toString

String toString(RippleValue v)
                throws RippleException

Attempts to convert a Ripple value to a string value.

Parameters:

v - the value to convert.

Returns:

the string representation of a value. This is not identical to Object.toString(), and may involve a loss of information.

Throws:

RippleException - if conversion fails

toList

void toList(RippleValue v,
          Sink<RippleList> sink)
            throws RippleException

Attempts to convert a Ripple value to a Ripple List.

Parameters:

v - the value to convert. It must be of a type which is convertible to a list, or be the head of an RDF list in the model's RDF knowledge base.

sink - a handler for successfully converted lists

Throws:

RippleException - if conversion fails

uriValue

RDFValue uriValue(String uri)
                  throws RippleException

Construct an RDF URI reference.

Parameters:

uri - the URI to convert

Returns:

the resulting RDF value

Throws:

RippleException - if the argument is not a valid URI

plainValue

RDFValue plainValue(String label)
                    throws RippleException

Constructs a plain literal value in Ripple space.

Parameters:

label - the lexical form of the string

Returns:

the resulting string value

Throws:

RippleException - if the literal cannot be constructed

languageTaggedValue

RDFValue languageTaggedValue(String s,
                           String language)
                             throws RippleException

Constructs a language-tagged literal value in Ripple space.

Parameters:

s - the label of the literal

language - the language tag of the literal (e.g. "en" or "de")

Returns:

the resulting value

Throws:

RippleException - if the literal cannot be constructed

typedValue

RDFValue typedValue(String label,
                  org.openrdf.model.URI datatype)
                    throws RippleException

Constructs a typed RDF literal value.

Parameters:

label - the label of the literal

datatype - the data type of the value

Returns:

the resulting RDF value

Throws:

RippleException - if the arguments do not define a valid literal

booleanValue

RDFValue booleanValue(boolean b)
                      throws RippleException

Constructs a boolean value.

Parameters:

b - the primitive value to wrap

Returns:

the resulting RDF value

Throws:

RippleException - if the value cannot be constructed

numericValue

NumericValue numericValue(int i)
                          throws RippleException

Constructs an integer-typed numeric value.

Parameters:

i - the primitive value to wrap

Returns:

the resulting numeric value

Throws:

RippleException - if the value cannot be constructed

numericValue

NumericValue numericValue(long l)
                          throws RippleException

Constructs a long-integer-typed numeric value.

Parameters:

l - the primitive value to wrap

Returns:

the resulting numeric value

Throws:

RippleException - if the value cannot be constructed

numericValue

NumericValue numericValue(double d)
                          throws RippleException

Constructs a double-precision numeric value.

Parameters:

d - the primitive value to wrap

Returns:

the resulting numeric value

Throws:

RippleException - if the value cannot be constructed

numericValue

NumericValue numericValue(BigDecimal bd)
                          throws RippleException

Constructs a big-decimal-typed numeric value.

Parameters:

bd - the primitive value to wrap

Returns:

the resulting numeric value

Throws:

RippleException - if the value cannot be constructed

canonicalValue

RippleValue canonicalValue(RDFValue v)

Finds the "canonical" value, in Ripple space, for a given RDF value. Several RDF values may map to the same canonical value. See also SpecialValueMap.

Parameters:

v - the RDF value to look up

Returns:

the canonical value. Always non-null.

list

RippleList list()

Returns:

the empty list, of which there is exactly one in this model

getComparator

Comparator<RippleValue> getComparator()

Returns:

the total order of Ripple values in this model

setNamespace

void setNamespace(String prefix,
                String ns,
                boolean override)
                  throws RippleException

Define a namespace prefix.

Parameters:

prefix - the namespace prefix

ns - the namespace URI, or null to undefine a prefix

override - whether to override an existing namespace with this prefix, if there is one

Throws:

RippleException - if the namespace cannot be set

query

void query(StatementPatternQuery query,
         Sink<RippleValue> sink,
         boolean asynchronous)
           throws RippleException

Issues a triple pattern query over the model.

Parameters:

query - the query to evaluate

sink - a handler for query results

asynchronous - whether the query should be evaluated in an asynchronous fashion, allowing new threads to be spawned in order to compute results in parallel

Throws:

RippleException - if the query cannot be evaluated

getNamespaces

Source<org.openrdf.model.Namespace> getNamespaces()
                                                  throws RippleException

Retrieves all namespaces defined in this model.

Returns:

a source producing all namespaces

Throws:

RippleException - if namespaces cannot be retrieved

getStatements

void getStatements(RDFValue subj,
                 RDFValue pred,
                 RDFValue obj,
                 Sink<org.openrdf.model.Statement> sink)
                   throws RippleException

Retrieves all statements in the model matching a given triple pattern.

Parameters:

subj - the subject of matching statements

pred - the predicate of matching statements

obj - the object of matching statements

sink - a handler for matched statements

Throws:

RippleException - if statements cannot be retrieved

evaluate

info.aduna.iteration.CloseableIteration<? extends org.openrdf.query.BindingSet,org.openrdf.query.QueryEvaluationException> evaluate(String query)
                                                                                                                                    throws RippleException

Evaluates a SPARQL query against the model.

Parameters:

query - the query to evaluate

Returns:

an iterator over all solutios to the query

Throws:

RippleException - if query evaluation fails

getContexts

Source<RippleValue> getContexts()
                                throws RippleException

Returns:

a source producing all graph contexts in this model

Throws:

RippleException - if contexts cannot be retrieved

add

void add(RippleValue subj,
       RippleValue pred,
       RippleValue obj,
       RippleValue... contexts)
         throws RippleException

Adds one or more RDF statements to the model.

Parameters:

subj - the subject of each statement

pred - the predicate of each statement

obj - the object of each statement

contexts - the graph contexts of the statements, if any. For each non-null context supplied, a statement will be created and placed in the corresponding graph. If a null context is supplied, a statement will be added to the default graph. If no contexts are supplied, a single statement will be added to the default graph.

Throws:

RippleException - if the statement(s) cannot be added

remove

void remove(RippleValue subj,
          RippleValue pred,
          RippleValue obj,
          RippleValue... contexts)
            throws RippleException

Removes matching RDF statements from the model.

Parameters:

subj - the subject of each matching statement, or null as a wildcard

pred - the predicate of each matching statement, or null as a wildcard

obj - the object of each matching statement, or null as a wildcard

contexts - zero or more graph contexts for matching statements. For each non-null context supplied, matching statements from the corresponding graph will be removed. If a null context is supplied, matching statements from the default context will be removed. If no contexts are supplied, matching statements from all contexts will be removed.

Throws:

RippleException - if matching statements cannot be removed

internalize

boolean internalize(RippleList list)
                    throws RippleException

Adds an RDF description of the given list to the model. This involves adding all appropriate rdf:type, rdf:first, and rdf:rest statements for the list itself, as well as those of any lists it contains, recursively.

Parameters:

list - the list to internalize

Returns:

whether the list was internalized successfully. If this operation is unsuccessful, no statements are added to the model.

Throws:

RippleException - if internalization fails

finish

void finish()
            throws RippleException

Complete any still-executing tasks.

Throws:

RippleException