eu.fbk.knowledgestore

Class AbstractSession

java.lang.Object

eu.fbk.knowledgestore.AbstractSession

All Implemented Interfaces:

Session, Closeable, AutoCloseable

public abstract class AbstractSession
extends Object
implements Session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSession(Map<String,String> namespaces, String username, String password)

Method Summary

Modifier and Type	Method and Description
protected void	checkNotClosed()
void	close() Closes the Session instance, releasing any resource possibly allocated.
Operation.Count	count(org.openrdf.model.URI type) Creates a new Count operation object for counting records of the type specified.
Operation.Create	create(org.openrdf.model.URI type) Creates a new Create operation object for storing new records of the type specified.
Operation.Delete	delete(org.openrdf.model.URI type) Creates a new Delete operation object for deleting records of the type specified.
protected void	doClose()
protected abstract long	doCount(Long timeout, org.openrdf.model.URI type, XPath condition, Set<org.openrdf.model.URI> ids)
protected abstract void	doCreate(Long timeout, org.openrdf.model.URI type, Stream<? extends Record> records, Handler<? super Outcome> handler)
protected abstract void	doDelete(Long timeout, org.openrdf.model.URI type, XPath condition, Set<org.openrdf.model.URI> ids, Handler<? super Outcome> handler)
protected abstract Representation	doDownload(Long timeout, org.openrdf.model.URI id, Set<String> mimeTypes, boolean useCaches)
protected Outcome.Status	doFail(Throwable ex, AtomicReference<String> message)
protected abstract Stream<Record>	doMatch(Long timeout, Map<org.openrdf.model.URI,XPath> conditions, Map<org.openrdf.model.URI,Set<org.openrdf.model.URI>> ids, Map<org.openrdf.model.URI,Set<org.openrdf.model.URI>> properties)
protected abstract void	doMerge(Long timeout, org.openrdf.model.URI type, Stream<? extends Record> records, Criteria criteria, Handler<? super Outcome> handler)
protected abstract Stream<Record>	doRetrieve(Long timeout, org.openrdf.model.URI type, XPath condition, Set<org.openrdf.model.URI> ids, Set<org.openrdf.model.URI> properties, Long offset, Long limit)
protected abstract <T> Stream<T>	doSparql(Long timeout, Class<T> type, String expression, Set<org.openrdf.model.URI> defaultGraphs, Set<org.openrdf.model.URI> namedGraphs)
protected abstract Outcome	doSparqlDelete(Long timeout, Stream<? extends org.openrdf.model.Statement> statements)
protected abstract Outcome	doSparqlUpdate(Long timeout, Stream<? extends org.openrdf.model.Statement> statements)
protected abstract void	doUpdate(Long timeout, org.openrdf.model.URI type, XPath condition, Set<org.openrdf.model.URI> ids, Record record, Criteria criteria, Handler<? super Outcome> handler)
protected abstract Outcome	doUpload(Long timeout, org.openrdf.model.URI resourceID, Representation representation)
Operation.Download	download(org.openrdf.model.URI resourceID) Creates a new Download operation object.
protected org.openrdf.model.URI	getInvocationID()
Map<String,String>	getNamespaces() Returns the modifiable namespace map of this Session.
String	getPassword() Returns the user password, if any.
String	getUsername() Returns the username associated to this Session, if any.
boolean	isClosed() Tests whether this Session instance has been closed.
Operation.Match	match() Creates a new Match operation object for matching <resource, mention, entity, axioms> 4-tuples matching specific conditions.
Operation.Merge	merge(org.openrdf.model.URI type) Creates a new Merge operation object for merging local record description of the type specified with descriptions stored in the KnowledgeStore.
Operation.Retrieve	retrieve(org.openrdf.model.URI type) Creates a new Retrieve operation object for retrieving records of the type specified.
protected void	setInvocationID(org.openrdf.model.URI invocationID)
Operation.Sparql	sparql(String expression, Object... arguments) Creates a new Sparql operation object for evaluating a SPARQL query on crystallized axiom data.
Operation.SparqlDelete	sparqldelete()
Operation.SparqlUpdate	sparqlupdate()
String	toString()
Operation.Update	update(org.openrdf.model.URI type) Creates a new Update operation object for updating one or more properties of records of the type specified.
Operation.Upload	upload(org.openrdf.model.URI resourceID) Creates a new Upload operation object.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSession

protected AbstractSession(@Nullable
                          Map<String,String> namespaces,
                          @Nullable
                          String username,
                          @Nullable
                          String password)

Method Detail

getUsername

@Nullable
public final String getUsername()
                                   throws IllegalStateException

Description copied from interface: Session

Returns the username associated to this Session, if any.

Specified by:

getUsername in interface Session

Returns:

the username, null if the Session is anonymous

Throws:

IllegalStateException - if the Session has been closed

getPassword

public final String getPassword()
                         throws IllegalStateException

Description copied from interface: Session

Returns the user password, if any.

Specified by:

getPassword in interface Session

Returns:

the password

Throws:

IllegalStateException - if the Session has been closed

getNamespaces

public final Map<String,String> getNamespaces()
                                       throws IllegalStateException

Description copied from interface: Session

Returns the modifiable namespace map of this Session. The map is backed by the default mappings of Data#getNamespaceMap(). New mappings are stored in the Session map and may override the default mappings. Removal of mappings is performed on the Session map, and may reactivate the default mapping as a consequence.

Specified by:

getNamespaces in interface Session

Returns:

the modifiable namespace map of this Session

Throws:

IllegalStateException - if the Session has been closed

download

public final Operation.Download download(org.openrdf.model.URI resourceID)
                                  throws IllegalStateException

Description copied from interface: Session

Creates a new Download operation object.

Specified by:

download in interface Session

Parameters:

resourceID - the ID of the resource whose representation should be downloaded

Returns:

the created Download operation object

Throws:

IllegalStateException - if the Session has been closed

upload

public final Operation.Upload upload(org.openrdf.model.URI resourceID)
                              throws IllegalStateException

Description copied from interface: Session

Creates a new Upload operation object.

Specified by:

upload in interface Session

Parameters:

resourceID - the ID of the resource whose representation should be updated

Returns:

the created Upload operation object

Throws:

IllegalStateException - if the Session has been closed

count

public final Operation.Count count(org.openrdf.model.URI type)
                            throws IllegalStateException

Description copied from interface: Session

Creates a new Count operation object for counting records of the type specified.

Specified by:

count in interface Session

Parameters:

type - the URI of the type of record to count, either KS.RESOURCE, KS.MENTION, KS.ENTITY or KS.AXIOM

Returns:

the created Count operation object

Throws:

IllegalStateException - if the Session has been closed

retrieve

public final Operation.Retrieve retrieve(org.openrdf.model.URI type)
                                  throws IllegalStateException

Description copied from interface: Session

Creates a new Retrieve operation object for retrieving records of the type specified.

Specified by:

retrieve in interface Session

Parameters:

type - the URI of the type of record to retrieve, either KS.RESOURCE, KS.MENTION, KS.ENTITY or KS.AXIOM

Returns:

the created Retrieve operation object

Throws:

IllegalStateException - if the Session has been closed

create

public final Operation.Create create(org.openrdf.model.URI type)
                              throws IllegalStateException

Description copied from interface: Session

Creates a new Create operation object for storing new records of the type specified.

Specified by:

create in interface Session

Parameters:

type - the URI of the type of record to create, either KS.RESOURCE, KS.MENTION, KS.ENTITY or KS.AXIOM

Returns:

the created Create operation object

Throws:

IllegalStateException - if the Session has been closed

merge

public final Operation.Merge merge(org.openrdf.model.URI type)
                            throws IllegalStateException

Description copied from interface: Session

Creates a new Merge operation object for merging local record description of the type specified with descriptions stored in the KnowledgeStore.

Specified by:

merge in interface Session

Parameters:

type - the URI of the type of record to merge, either KS.RESOURCE, KS.MENTION, KS.ENTITY or KS.AXIOM

Returns:

the created Merge operation object

Throws:

IllegalStateException - if the Session has been closed

update

public final Operation.Update update(org.openrdf.model.URI type)
                              throws IllegalStateException

Description copied from interface: Session

Creates a new Update operation object for updating one or more properties of records of the type specified.

Specified by:

update in interface Session

Parameters:

type - the URI of the type of record to update, either KS.RESOURCE, KS.MENTION, KS.ENTITY or KS.AXIOM

Returns:

the created Update operation object

Throws:

IllegalStateException - if the Session has been closed

delete

public final Operation.Delete delete(org.openrdf.model.URI type)
                              throws IllegalStateException

Description copied from interface: Session

Creates a new Delete operation object for deleting records of the type specified.

Specified by:

delete in interface Session

Parameters:

type - the URI of the type of record to delete, either KS.RESOURCE, KS.MENTION, KS.ENTITY or KS.AXIOM

Returns:

the created Delete operation object

Throws:

IllegalStateException - if the Session has been closed

match

public final Operation.Match match()
                            throws IllegalStateException

Description copied from interface: Session

Creates a new Match operation object for matching <resource, mention, entity, axioms> 4-tuples matching specific conditions.

Specified by:

match in interface Session

Returns:

the created Match operation object

Throws:

IllegalStateException - if the Session has been closed

sparql

public final Operation.Sparql sparql(String expression,
                                     Object... arguments)
                              throws IllegalStateException

Description copied from interface: Session

Creates a new Sparql operation object for evaluating a SPARQL query on crystallized axiom data.

Specified by:

sparql in interface Session

Parameters:

expression - the SPARQL query expression, not null

arguments - arguments to be injected in $$ placeholders in the query expression; can be URIs, Literals or scalar values that can be converted to Literals (e.g., strings, integers)

Returns:

the created Sparql operation object

Throws:

IllegalStateException - if the Session has been closed

sparqlupdate

public final Operation.SparqlUpdate sparqlupdate()
                                          throws IllegalStateException

Specified by:

sparqlupdate in interface Session

Throws:

IllegalStateException

sparqldelete

public final Operation.SparqlDelete sparqldelete()
                                          throws IllegalStateException

Specified by:

sparqldelete in interface Session

Throws:

IllegalStateException

isClosed

public final boolean isClosed()

Description copied from interface: Session

Tests whether this Session instance has been closed.

Specified by:

isClosed in interface Session

Returns:

true, if this Session instance has been closed

close

public final void close()

Description copied from interface: Session

Closes the Session instance, releasing any resource possibly allocated. Calling this method additional times has no effect. After this method is called, calls to other method of the Session interface will result in IllegalStateExceptions to be thrown.

Specified by:

close in interface Session

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

toString

public String toString()

Overrides:

toString in class Object

checkNotClosed

protected final void checkNotClosed()

getInvocationID

protected final org.openrdf.model.URI getInvocationID()

setInvocationID

protected final void setInvocationID(org.openrdf.model.URI invocationID)

doFail

protected Outcome.Status doFail(Throwable ex,
                                AtomicReference<String> message)
                         throws Throwable

Throws:

Throwable

doDownload

protected abstract Representation doDownload(@Nullable
                                             Long timeout,
                                             org.openrdf.model.URI id,
                                             @Nullable
                                             Set<String> mimeTypes,
                                             boolean useCaches)
                                      throws Throwable

Throws:

Throwable

doUpload

protected abstract Outcome doUpload(@Nullable
                                    Long timeout,
                                    org.openrdf.model.URI resourceID,
                                    @Nullable
                                    Representation representation)
                             throws Throwable

Throws:

Throwable

doCount

protected abstract long doCount(@Nullable
                                Long timeout,
                                org.openrdf.model.URI type,
                                @Nullable
                                XPath condition,
                                @Nullable
                                Set<org.openrdf.model.URI> ids)
                         throws Throwable

Throws:

Throwable

doRetrieve

protected abstract Stream<Record> doRetrieve(@Nullable
                                             Long timeout,
                                             org.openrdf.model.URI type,
                                             @Nullable
                                             XPath condition,
                                             @Nullable
                                             Set<org.openrdf.model.URI> ids,
                                             @Nullable
                                             Set<org.openrdf.model.URI> properties,
                                             @Nullable
                                             Long offset,
                                             @Nullable
                                             Long limit)
                                      throws Throwable

Throws:

Throwable

doCreate

protected abstract void doCreate(@Nullable
                                 Long timeout,
                                 org.openrdf.model.URI type,
                                 @Nullable
                                 Stream<? extends Record> records,
                                 Handler<? super Outcome> handler)
                          throws Throwable

Throws:

Throwable

doMerge

protected abstract void doMerge(@Nullable
                                Long timeout,
                                org.openrdf.model.URI type,
                                @Nullable
                                Stream<? extends Record> records,
                                @Nullable
                                Criteria criteria,
                                Handler<? super Outcome> handler)
                         throws Throwable

Throws:

Throwable

doUpdate

protected abstract void doUpdate(@Nullable
                                 Long timeout,
                                 org.openrdf.model.URI type,
                                 @Nullable
                                 XPath condition,
                                 @Nullable
                                 Set<org.openrdf.model.URI> ids,
                                 @Nullable
                                 Record record,
                                 @Nullable
                                 Criteria criteria,
                                 Handler<? super Outcome> handler)
                          throws Throwable

Throws:

Throwable

doDelete

protected abstract void doDelete(@Nullable
                                 Long timeout,
                                 org.openrdf.model.URI type,
                                 @Nullable
                                 XPath condition,
                                 @Nullable
                                 Set<org.openrdf.model.URI> ids,
                                 Handler<? super Outcome> handler)
                          throws Throwable

Throws:

Throwable

doMatch

protected abstract Stream<Record> doMatch(@Nullable
                                          Long timeout,
                                          Map<org.openrdf.model.URI,XPath> conditions,
                                          Map<org.openrdf.model.URI,Set<org.openrdf.model.URI>> ids,
                                          Map<org.openrdf.model.URI,Set<org.openrdf.model.URI>> properties)
                                   throws Throwable

Throws:

Throwable

doSparql

protected abstract <T> Stream<T> doSparql(@Nullable
                                          Long timeout,
                                          Class<T> type,
                                          String expression,
                                          @Nullable
                                          Set<org.openrdf.model.URI> defaultGraphs,
                                          @Nullable
                                          Set<org.openrdf.model.URI> namedGraphs)
                                   throws Throwable

Throws:

Throwable

doSparqlUpdate

protected abstract Outcome doSparqlUpdate(@Nullable
                                          Long timeout,
                                          @Nullable
                                          Stream<? extends org.openrdf.model.Statement> statements)
                                   throws Throwable

Throws:

Throwable

doSparqlDelete

protected abstract Outcome doSparqlDelete(@Nullable
                                          Long timeout,
                                          @Nullable
                                          Stream<? extends org.openrdf.model.Statement> statements)
                                   throws Throwable

Throws:

Throwable

doClose

protected void doClose()