com.bigdata.rdf.store

Interface ITripleStore

All Known Subinterfaces:

IRawTripleStore

All Known Implementing Classes:

AbstractLocalTripleStore, AbstractTripleStore, LocalTripleStore, ScaleOutTripleStore, TempTripleStore

public interface ITripleStore

Interface for a triple -or- quad store.

Note: This API does NOT implement a Truth Maintenance (TM) strategy and by itself only supports "explicit" triples. If the knowledge base is NOT to store any entailments then the application MAY directly use this API to read and write explicit statements on the knowledge base. However, if the knowledge base is to directly store any entailments, then the application MUST NOT invoke operations on this API that add statements to, or remove statements from, the knowledge base as the entailments will not be updated properly.

When entailments are stored in the knowledge base, a TM strategy MUST be used to made those entailments based on the explicit triples asserted or retracted by the application. When an application requests that statements are added to a knowledge base that maintains entailments, the TM strategy MAY need to add additional entailments to the knowledge base. When an application requests that statement(s) are removed from the knowledge base, the TM strategy needs to consider the state of the knowledge base. In general, a statement should be removed IFF it was StatementEnum.Explicit AND the statement is no longer entailed by the model theory and the remaining statements in the knowledge base.

Version:

$Id$

Author:

Bryan Thompson

See Also:

IRawTripleStore, AbstractTripleStore

Method Summary

Methods

Modifier and Type	Method and Description
void	abort() Discard the write set.
void	addStatement(org.openrdf.model.Resource s, org.openrdf.model.URI p, org.openrdf.model.Value o) Deprecated. by addStatement(Resource, URI, Value, Resource)
void	addStatement(org.openrdf.model.Resource s, org.openrdf.model.URI p, org.openrdf.model.Value o, org.openrdf.model.Resource c) Add a single StatementEnum.Explicit statement by lookup and/or insert into the various indices (non-batch api).
BigdataStatement	asStatement(ISPO spo) Convert an internal ISPO into a Sesame Statement.
BigdataStatementIterator	asStatementIterator(IChunkedOrderedIterator<ISPO> src) Wraps an IChunkedOrderedIterator as a BigdataStatementIterator.
BigdataValue	asValue(org.openrdf.model.Value value) Converts a BigdataValue to a Sesame Value object.
void	close() Close the connection to the ITripleStore.
long	commit() Commit changes on the database.
void	destroy() Deletes all data for the ITripleStore.
IAccessPath<ISPO>	getAccessPath(org.openrdf.model.Resource s, org.openrdf.model.URI p, org.openrdf.model.Value o) Deprecated. by getAccessPath(Resource, URI, Value, Resource)
IAccessPath<ISPO>	getAccessPath(org.openrdf.model.Resource s, org.openrdf.model.URI p, org.openrdf.model.Value o, org.openrdf.model.Resource c) Returns an IAccessPath matching the triple pattern.
long	getBNodeCount() The #of BNodes in the lexicon (this is not specific to any named graph).
DataLoader	getDataLoader() Return a DataLoader singleton configured using the properties that were used to configure the database.
InferenceEngine	getInferenceEngine() Return an InferenceEngine singleton configured using the properties that were used to configure the database.
long	getLiteralCount() The #of Literals in the lexicon (this is not specific to any named graph).
long	getNamedGraphCount() The #of named graphs.
BigdataStatement	getStatement(org.openrdf.model.Resource s, org.openrdf.model.URI p, org.openrdf.model.Value o) Deprecated. by getStatement(Resource, URI, Value, Resource)
BigdataStatement	getStatement(org.openrdf.model.Resource s, org.openrdf.model.URI p, org.openrdf.model.Value o, org.openrdf.model.Resource c) Return the statement from the database matching the fully bound query.
long	getStatementCount() Deprecated. by getStatementCount(Resource, boolean)
long	getStatementCount(boolean exact) Deprecated. by getStatementCount(Resource, boolean)
long	getStatementCount(org.openrdf.model.Resource c) Deprecated. by getStatementCount(Resource, boolean)
long	getStatementCount(org.openrdf.model.Resource c, boolean exact) The #of triples in the named graph or in the database if no context is specified.
BigdataStatementIterator	getStatements(org.openrdf.model.Resource s, org.openrdf.model.URI p, org.openrdf.model.Value o) Deprecated. by getStatements(Resource, URI, Value, Resource)
BigdataStatementIterator	getStatements(org.openrdf.model.Resource s, org.openrdf.model.URI p, org.openrdf.model.Value o, org.openrdf.model.Resource c) Return an iterator that will visit all BigdataStatements in the database matching the triple pattern.
long	getTermCount() The #of RDF Values in the lexicon (this is not specific to any named graph).
long	getURICount() The #of URIs in the lexicon (this is not specific to any named graph).
boolean	hasStatement(org.openrdf.model.Resource s, org.openrdf.model.URI p, org.openrdf.model.Value o) Deprecated. by hasStatement(Resource, URI, Value, Resource)
boolean	hasStatement(org.openrdf.model.Resource s, org.openrdf.model.URI p, org.openrdf.model.Value o, org.openrdf.model.Resource c) Return true if the triple pattern matches any statements in the store (non-batch API).
boolean	isQuads() Return true iff this is a quad store.
boolean	isReadOnly() True iff the database view is read-only.
long	removeStatements(org.openrdf.model.Resource s, org.openrdf.model.URI p, org.openrdf.model.Value o) Deprecated. by removeStatements(Resource, URI, Value, Resource)
long	removeStatements(org.openrdf.model.Resource s, org.openrdf.model.URI p, org.openrdf.model.Value o, org.openrdf.model.Resource c) Unconditionally removes statement(s) matching the triple pattern (NO truth maintenance).

Method Detail

getNamedGraphCount

long getNamedGraphCount()

The #of named graphs.

Throws:

UnsupportedOperationException - unless this is a quad store.

getStatementCount

long getStatementCount(org.openrdf.model.Resource c)

Deprecated. by getStatementCount(Resource, boolean)

The #of triples in the named graph, or in the database if c is not specified.

Parameters:

c - The context (optional).

Returns:

The #of triples in the named graph or in the database.

getStatementCount

long getStatementCount()

Deprecated. by getStatementCount(Resource, boolean)

The #of triples in the store.

Returns:

The #of statements in the database. When either transactions or key-range partitioned indices are being used, then this will be an upper bound.

See Also:

getStatementCount(boolean)

getStatementCount

long getStatementCount(boolean exact)

Deprecated. by getStatementCount(Resource, boolean)

The #of triples in the store.

Parameters:

exact - When true the result will be an exact count, which may require a full key-range scan of one of the statement indices.

Returns:

The #of statements in the database. When exact is false and either transactions or key-range partitioned indices are being used, then this will be an upper bound.

getStatementCount

long getStatementCount(org.openrdf.model.Resource c,
                     boolean exact)

The #of triples in the named graph or in the database if no context is specified.

Parameters:

c - The context (optional).

exact - When true the result will be an exact count, which may require a full key-range scan of one of the statement indices.

Returns:

The #of statements in the named graph or in the database if c is null. When exact is false and either transactions or key-range partitioned indices are being used, then this will be an upper bound.

getTermCount

long getTermCount()

The #of RDF Values in the lexicon (this is not specific to any named graph).

This may be an estimate when using partitioned indices.

Many RDF Values are inlined into the statement indices. Inlined values are not be reported by this method.

getURICount

long getURICount()

The #of URIs in the lexicon (this is not specific to any named graph).

This may be an estimate when using partitioned indices.

Many RDF Values are inlined into the statement indices. Inlined values are not be reported by this method.

getLiteralCount

long getLiteralCount()

The #of Literals in the lexicon (this is not specific to any named graph).

This may be an estimate when using partitioned indices.

Many RDF Values are inlined into the statement indices. Inlined values are not be reported by this method.

getBNodeCount

long getBNodeCount()

The #of BNodes in the lexicon (this is not specific to any named graph).

This may be an estimate when using partitioned indices.

This will always return ZERO (0) if AbstractTripleStore.Options.STORE_BLANK_NODES is false since there will not be any blank nodes in the lexicon.

Many RDF Values are inlined into the statement indices. Inlined values are not be reported by this method.

addStatement

void addStatement(org.openrdf.model.Resource s,
                org.openrdf.model.URI p,
                org.openrdf.model.Value o,
                org.openrdf.model.Resource c)

Add a single StatementEnum.Explicit statement by lookup and/or insert into the various indices (non-batch api).

Note: The non-batch API is horridly inefficient and can not be used to co-reference blank nodes. The batch load API for Sesame Value objects is:

 
  StatementBuffer buffer = new StatementBuffer(store, ...);
  
  buffer.add( s, p, o );
  ...
  
  buffer.flush();
 
 

Parameters:

s - The subject (required).

p - The predicate (required).

o - The object (required).

c - The context (required IFF a quad store and otherwise ignored).

addStatement

void addStatement(org.openrdf.model.Resource s,
                org.openrdf.model.URI p,
                org.openrdf.model.Value o)

Deprecated. by addStatement(Resource, URI, Value, Resource)

hasStatement

boolean hasStatement(org.openrdf.model.Resource s,
                   org.openrdf.model.URI p,
                   org.openrdf.model.Value o,
                   org.openrdf.model.Resource c)

Return true if the triple pattern matches any statements in the store (non-batch API).

Note: This does not verify whether or not the statement is explicit.

Parameters:

s - The subject (optional).

p - The predicate (optional).

o - The object (optional).

c - The context (optional and ignored unless a quad store).

hasStatement

boolean hasStatement(org.openrdf.model.Resource s,
                   org.openrdf.model.URI p,
                   org.openrdf.model.Value o)

Deprecated. by hasStatement(Resource, URI, Value, Resource)

getStatement

BigdataStatement getStatement(org.openrdf.model.Resource s,
                            org.openrdf.model.URI p,
                            org.openrdf.model.Value o,
                            org.openrdf.model.Resource c)

Return the statement from the database matching the fully bound query.

Note: If the parameters are from an AbstractTripleStore using a different lexicon then you MUST either BigdataValue.clearInternalValue() or create a new Value object which either is not aware of the term identifier or does not have its term identifier set in order to avoid lookup using the term identifier rather than indirecting through the lexicon.

Parameters:

s - The subject (required).

p - The predicate (required).

o - The object (required).

c - The context (required iff a quad store and otherwise ignored).

Returns:

The statement -or- null iff the triple is not defined in the database.

See Also:

asValue(Value)

getStatement

BigdataStatement getStatement(org.openrdf.model.Resource s,
                            org.openrdf.model.URI p,
                            org.openrdf.model.Value o)

Deprecated. by getStatement(Resource, URI, Value, Resource)

getStatements

BigdataStatementIterator getStatements(org.openrdf.model.Resource s,
                                     org.openrdf.model.URI p,
                                     org.openrdf.model.Value o,
                                     org.openrdf.model.Resource c)

Return an iterator that will visit all BigdataStatements in the database matching the triple pattern.

Parameters:

s - The subject (optional).

p - The predicate (optional).

o - The object (optional).

c - The context (optional and ignored unless a quad store).

Returns:

The iterator.

getStatements

BigdataStatementIterator getStatements(org.openrdf.model.Resource s,
                                     org.openrdf.model.URI p,
                                     org.openrdf.model.Value o)

Deprecated. by getStatements(Resource, URI, Value, Resource)

asValue

BigdataValue asValue(org.openrdf.model.Value value)

Converts a BigdataValue to a Sesame Value object.

Parameters:

value - Either a BigdataValue, a Sesame Value object, or null.

Returns:

A corresponding Sesame Value object -or- null iff value is null.

removeStatements

long removeStatements(org.openrdf.model.Resource s,
                    org.openrdf.model.URI p,
                    org.openrdf.model.Value o,
                    org.openrdf.model.Resource c)

Unconditionally removes statement(s) matching the triple pattern (NO truth maintenance).

Parameters:

s - The subject (optional).

p - The predicate (optional).

o - The object (optional).

c - The context (optional).

Returns:

The #of statements removed.

removeStatements

long removeStatements(org.openrdf.model.Resource s,
                    org.openrdf.model.URI p,
                    org.openrdf.model.Value o)

Deprecated. by removeStatements(Resource, URI, Value, Resource)

getAccessPath

IAccessPath<ISPO> getAccessPath(org.openrdf.model.Resource s,
                              org.openrdf.model.URI p,
                              org.openrdf.model.Value o,
                              org.openrdf.model.Resource c)

Returns an IAccessPath matching the triple pattern.

Parameters:

s - The subject (optional).

p - The predicate (optional).

o - The object (optional).

c - The context (optional).

Returns:

The object that may be used to read efficiently on the indices for that triple pattern. In the special case where any of the given Values is not known to the database this method will return an EmptyAccessPath.

See Also:

IAccessPath, asStatementIterator(IChunkedOrderedIterator)

getAccessPath

IAccessPath<ISPO> getAccessPath(org.openrdf.model.Resource s,
                              org.openrdf.model.URI p,
                              org.openrdf.model.Value o)

Deprecated. by getAccessPath(Resource, URI, Value, Resource)

asStatementIterator

BigdataStatementIterator asStatementIterator(IChunkedOrderedIterator<ISPO> src)

Wraps an IChunkedOrderedIterator as a BigdataStatementIterator.

Note: The object visited will be BigdataStatementImpls.

Parameters:

src - An IChunkedOrderedIterator visiting SPOs

Returns:

The BigdataStatementIterator.

See Also:

IAccessPath, getAccessPath(Resource, URI, Value)

asStatement

BigdataStatement asStatement(ISPO spo)

Convert an internal ISPO into a Sesame Statement.

Note: The object returned will be a BigdataStatement

Parameters:

spo - The ISPO.

Returns:

The Sesame Statement -or- null.

getDataLoader

DataLoader getDataLoader()

Return a DataLoader singleton configured using the properties that were used to configure the database.

See Also:

DataLoader.Options

getInferenceEngine

InferenceEngine getInferenceEngine()

Return an InferenceEngine singleton configured using the properties that were used to configure the database.

Note: The first time this object is requested it will attempt to write the axioms on the database.

See Also:

DataLoader.Options

abort

void abort()

Discard the write set.

Note: The semantics of this operation depend on whether the database is embedded (discards the write set), temporary (ignored since the store is not restart safe), or a federation (ignored since unisolated writes on the federation are atomic and auto-committed).

commit

long commit()

Commit changes on the database.

Note: The semantics of this operation depend on whether the database is embedded (does a commit), temporary (ignored), or a federation (ignored since unisolated writes on the federation are atomic and auto-committed).

Returns:

commit time if store supports commit timestamps

destroy

void destroy()

Deletes all data for the ITripleStore.

close

void close()

Close the connection to the ITripleStore.

isReadOnly

boolean isReadOnly()

True iff the database view is read-only.

isQuads

boolean isQuads()

Return true iff this is a quad store.