com.github.anno4j

Class Anno4j

java.lang.Object

com.github.anno4j.Anno4j

All Implemented Interfaces:

TransactionCommands

@NotThreadSafe
public class Anno4j
extends Object
implements TransactionCommands

Read and write API for W3C Web Annotation Data Model (http://www.w3.org/TR/annotation-model/) and W3C Open Annotation Data Model (http://www.openannotation.org/spec/core/).

Anno4j can be configured by using the specific setter-methodes (e.g. setIdGenerator, setRepository). A default configuration (in-memory SPARQL endpoint) will be used if no configuration is set.

Anno4j methods are not thread-safe. Use Anno4j transactions in threaded environment.

Constructor Summary

Constructors

Constructor and Description
Anno4j()
Anno4j(IDGenerator idGenerator)
Anno4j(IDGenerator idGenerator, org.openrdf.model.URI defaultContext)
Anno4j(org.openrdf.repository.Repository repository)
Anno4j(org.openrdf.repository.Repository repository, IDGenerator idGenerator)
Anno4j(org.openrdf.repository.Repository repository, IDGenerator idGenerator, org.openrdf.model.URI defaultContext, boolean persistSchemaAnnotations)
Anno4j(org.openrdf.repository.Repository repository, IDGenerator idGenerator, org.openrdf.model.URI defaultContext, boolean persistSchemaAnnotations, Set<URL> additionalClasses)
Anno4j(org.openrdf.repository.Repository repository, org.openrdf.model.URI defaultContext)
Anno4j(org.openrdf.repository.Repository repository, org.openrdf.model.URI defaultContext, boolean persistSchemaAnnotations)
Anno4j(org.openrdf.model.URI defaultContext)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearContext(String context) Removes all triples from the given context.
void	clearContext(org.openrdf.model.URI context) Removes all triples from the given context.
<T> T	createObject(Class<T> clazz)
<T> T	createObject(Class<T> clazz, org.openrdf.model.Resource id)
<T> T	createObject(Class<T> clazz, org.openrdf.model.URI context) Creates a instance of the given class.
<T> T	createObject(Class<T> clazz, org.openrdf.model.URI context, org.openrdf.model.Resource id)
QueryService	createQueryService() Create query service
QueryService	createQueryService(org.openrdf.model.URI context) Create query service
Transaction	createTransaction()
Transaction	createTransaction(org.openrdf.model.URI context) Creates a transaction operating on the given context.
ValidatedTransaction	createValidatedTransaction() Creates a new transaction which provides schema validation services at commit time.
ValidatedTransaction	createValidatedTransaction(org.openrdf.model.URI context) Creates a new transaction which provides schema validation services at commit time.
<T extends ResourceObject> List<T>	findAll(Class<T> type) Queries for all instances of the RDF class connected with the given class
<T extends ResourceObject> List<T>	findAll(Class<T> type, org.openrdf.model.URI context)
<T extends ResourceObject> T	findByID(Class<T> type, String id)
<T extends ResourceObject> T	findByID(Class<T> type, org.openrdf.model.URI id)
org.openrdf.model.URI	getDefaultContext()
IDGenerator	getIdGenerator()
ObjectRepository	getObjectRepository() Getter for configured ObjectRepository (openrdf/alibaba wrapper for the internal Repository).
org.openrdf.repository.Repository	getRepository() Getter for the configured Repository instance (Connector for local/remote SPARQL repository).
Set<URL>	getScannedClasspath() Returns the classpath that is scanned for Iri and Partial annotated classes.
void	persist(ResourceObject resource) Writes the resource object to the configured SPARQL endpoint with a corresponding INSERT query.
void	persist(ResourceObject resource, org.openrdf.model.URI context) Writes the resource object to the configured SPARQL endpoint with a corresponding INSERT query.
void	setIdGenerator(IDGenerator idGenerator)
void	setRepository(org.openrdf.repository.Repository repository) Configures the Repository (Connector for local/remote SPARQL repository) to use in Anno4j.
void	setRepository(org.openrdf.repository.Repository repository, Set<URL> conceptJars, Set<URL> behaviourJars) Configures the Repository (Connector for local/remote SPARQL repository) to use in Anno4j.

Methods inherited from class java.lang.Object

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

Constructor Detail

Anno4j

public Anno4j()
       throws org.openrdf.repository.RepositoryException,
              org.openrdf.repository.config.RepositoryConfigException

Throws:

org.openrdf.repository.RepositoryException

org.openrdf.repository.config.RepositoryConfigException

Anno4j

public Anno4j(org.openrdf.model.URI defaultContext)
       throws org.openrdf.repository.RepositoryException,
              org.openrdf.repository.config.RepositoryConfigException

Throws:

org.openrdf.repository.RepositoryException

org.openrdf.repository.config.RepositoryConfigException

Anno4j

public Anno4j(IDGenerator idGenerator)
       throws org.openrdf.repository.RepositoryException,
              org.openrdf.repository.config.RepositoryConfigException

Throws:

org.openrdf.repository.RepositoryException

org.openrdf.repository.config.RepositoryConfigException

Anno4j

public Anno4j(IDGenerator idGenerator,
      org.openrdf.model.URI defaultContext)
       throws org.openrdf.repository.RepositoryException,
              org.openrdf.repository.config.RepositoryConfigException

Throws:

org.openrdf.repository.RepositoryException

org.openrdf.repository.config.RepositoryConfigException

Anno4j

public Anno4j(org.openrdf.repository.Repository repository)
       throws org.openrdf.repository.RepositoryException,
              org.openrdf.repository.config.RepositoryConfigException

Throws:

org.openrdf.repository.RepositoryException

org.openrdf.repository.config.RepositoryConfigException

Anno4j

public Anno4j(org.openrdf.repository.Repository repository,
      IDGenerator idGenerator)
       throws org.openrdf.repository.RepositoryException,
              org.openrdf.repository.config.RepositoryConfigException

Throws:

org.openrdf.repository.RepositoryException

org.openrdf.repository.config.RepositoryConfigException

Anno4j

public Anno4j(org.openrdf.repository.Repository repository,
      org.openrdf.model.URI defaultContext)
       throws org.openrdf.repository.RepositoryException,
              org.openrdf.repository.config.RepositoryConfigException

Throws:

org.openrdf.repository.RepositoryException

org.openrdf.repository.config.RepositoryConfigException

Anno4j

public Anno4j(org.openrdf.repository.Repository repository,
      org.openrdf.model.URI defaultContext,
      boolean persistSchemaAnnotations)
       throws org.openrdf.repository.RepositoryException,
              org.openrdf.repository.config.RepositoryConfigException

Throws:

org.openrdf.repository.RepositoryException

org.openrdf.repository.config.RepositoryConfigException

Anno4j

public Anno4j(org.openrdf.repository.Repository repository,
      IDGenerator idGenerator,
      org.openrdf.model.URI defaultContext,
      boolean persistSchemaAnnotations)
       throws org.openrdf.repository.config.RepositoryConfigException,
              org.openrdf.repository.RepositoryException

Throws:

org.openrdf.repository.config.RepositoryConfigException

org.openrdf.repository.RepositoryException

Anno4j

public Anno4j(org.openrdf.repository.Repository repository,
      IDGenerator idGenerator,
      org.openrdf.model.URI defaultContext,
      boolean persistSchemaAnnotations,
      Set<URL> additionalClasses)
       throws org.openrdf.repository.config.RepositoryConfigException,
              org.openrdf.repository.RepositoryException

Throws:

org.openrdf.repository.config.RepositoryConfigException

org.openrdf.repository.RepositoryException

Method Detail

persist

public void persist(ResourceObject resource)
             throws org.openrdf.repository.RepositoryException

Writes the resource object to the configured SPARQL endpoint with a corresponding INSERT query.

Specified by:

persist in interface TransactionCommands

Parameters:

resource - resource object to write to the SPARQL endpoint

Throws:

org.openrdf.repository.RepositoryException

persist

public void persist(ResourceObject resource,
           org.openrdf.model.URI context)
             throws org.openrdf.repository.RepositoryException

Writes the resource object to the configured SPARQL endpoint with a corresponding INSERT query.

Parameters:

resource - resource object to write to the SPARQL endpoint

context - Graph context to query

Throws:

org.openrdf.repository.RepositoryException

findByID

public <T extends ResourceObject> T findByID(Class<T> type,
                                    String id)
                                  throws org.openrdf.repository.RepositoryException

Specified by:

findByID in interface TransactionCommands

Throws:

org.openrdf.repository.RepositoryException

findByID

public <T extends ResourceObject> T findByID(Class<T> type,
                                    org.openrdf.model.URI id)
                                  throws org.openrdf.repository.RepositoryException

Specified by:

findByID in interface TransactionCommands

Throws:

org.openrdf.repository.RepositoryException

clearContext

public void clearContext(org.openrdf.model.URI context)
                  throws org.openrdf.repository.RepositoryException

Removes all triples from the given context.

Specified by:

clearContext in interface TransactionCommands

Parameters:

context - context to clear

Throws:

org.openrdf.repository.RepositoryException

clearContext

public void clearContext(String context)
                  throws org.openrdf.repository.RepositoryException

Removes all triples from the given context.

Specified by:

clearContext in interface TransactionCommands

Parameters:

context - context to clear

Throws:

org.openrdf.repository.RepositoryException

findAll

public <T extends ResourceObject> List<T> findAll(Class<T> type)
                                       throws org.openrdf.repository.RepositoryException

Queries for all instances of the RDF class connected with the given class

Specified by:

findAll in interface TransactionCommands

Parameters:

type - Class with connected RDF type

Returns:

All instances of the given RDF type

Throws:

org.openrdf.repository.RepositoryException

findAll

public <T extends ResourceObject> List<T> findAll(Class<T> type,
                                         org.openrdf.model.URI context)
                                       throws org.openrdf.repository.RepositoryException

Throws:

org.openrdf.repository.RepositoryException

createObject

public <T> T createObject(Class<T> clazz)
               throws org.openrdf.repository.RepositoryException,
                      IllegalAccessException,
                      InstantiationException

Specified by:

createObject in interface TransactionCommands

Throws:

org.openrdf.repository.RepositoryException

IllegalAccessException

InstantiationException

createObject

public <T> T createObject(Class<T> clazz,
                 org.openrdf.model.Resource id)
               throws org.openrdf.repository.RepositoryException,
                      IllegalAccessException,
                      InstantiationException

Specified by:

createObject in interface TransactionCommands

Throws:

org.openrdf.repository.RepositoryException

IllegalAccessException

InstantiationException

createObject

public <T> T createObject(Class<T> clazz,
                 org.openrdf.model.URI context)
               throws org.openrdf.repository.RepositoryException,
                      IllegalAccessException,
                      InstantiationException

Creates a instance of the given class.

Parameters:

clazz - Class of the instance to create. Can be an annotated interface.

context - The graph context where the triples are inserted into. can be null for default graph.

Returns:

A instance of the given class.

Throws:

org.openrdf.repository.RepositoryException

IllegalAccessException

InstantiationException

createObject

public <T> T createObject(Class<T> clazz,
                 org.openrdf.model.URI context,
                 org.openrdf.model.Resource id)
               throws org.openrdf.repository.RepositoryException,
                      IllegalAccessException,
                      InstantiationException

Throws:

org.openrdf.repository.RepositoryException

IllegalAccessException

InstantiationException

createQueryService

public QueryService createQueryService()
                                throws org.openrdf.repository.RepositoryException

Create query service

Specified by:

createQueryService in interface TransactionCommands

Returns:

query service object for specified type

Throws:

org.openrdf.repository.RepositoryException

createQueryService

public QueryService createQueryService(org.openrdf.model.URI context)
                                throws org.openrdf.repository.RepositoryException

Create query service

Parameters:

context - context to query

Returns:

query service object for specified type

Throws:

org.openrdf.repository.RepositoryException

getRepository

public org.openrdf.repository.Repository getRepository()

Getter for the configured Repository instance (Connector for local/remote SPARQL repository).

Returns:

configured Repository instance

setRepository

public void setRepository(org.openrdf.repository.Repository repository)
                   throws org.openrdf.repository.RepositoryException,
                          org.openrdf.repository.config.RepositoryConfigException

Configures the Repository (Connector for local/remote SPARQL repository) to use in Anno4j.

Parameters:

repository - Repository to use in Anno4j.

Throws:

org.openrdf.repository.RepositoryException

org.openrdf.repository.config.RepositoryConfigException

setRepository

public void setRepository(org.openrdf.repository.Repository repository,
                 Set<URL> conceptJars,
                 Set<URL> behaviourJars)
                   throws org.openrdf.repository.RepositoryException,
                          org.openrdf.repository.config.RepositoryConfigException

Configures the Repository (Connector for local/remote SPARQL repository) to use in Anno4j.

Parameters:

repository - Repository to use in Anno4j.

conceptJars - URLs of JAR-files that are scanned for concepts.

behaviourJars - URLs of JAR-files that are scanned for behaviours.

Throws:

org.openrdf.repository.RepositoryException

org.openrdf.repository.config.RepositoryConfigException

getObjectRepository

public ObjectRepository getObjectRepository()

Getter for configured ObjectRepository (openrdf/alibaba wrapper for the internal Repository).

Returns:

configured ObjectRepository.

getIdGenerator

public IDGenerator getIdGenerator()

setIdGenerator

public void setIdGenerator(IDGenerator idGenerator)

getDefaultContext

public org.openrdf.model.URI getDefaultContext()

createTransaction

public Transaction createTransaction()
                              throws org.openrdf.repository.RepositoryException

Throws:

org.openrdf.repository.RepositoryException

createTransaction

public Transaction createTransaction(org.openrdf.model.URI context)
                              throws org.openrdf.repository.RepositoryException

Creates a transaction operating on the given context.

Parameters:

context - The context the transaction should operate on.

Returns:

Returns the transaction.

Throws:

org.openrdf.repository.RepositoryException - Thrown if an error occurs regarding the connection to the triplestore.

createValidatedTransaction

public ValidatedTransaction createValidatedTransaction()
                                                throws org.openrdf.repository.RepositoryException

Creates a new transaction which provides schema validation services at commit time. Note that the validation assumes that the state present is valid when Transaction.begin() is called. Schema annotations made at ResourceObject classes will be scanned the first time a validated transaction is created.

Returns:

The validated transaction. Transaction.begin() must be called afterwards.

Throws:

org.openrdf.repository.RepositoryException - Thrown if an error occurs regarding the connection to the triplestore.

createValidatedTransaction

public ValidatedTransaction createValidatedTransaction(org.openrdf.model.URI context)
                                                throws org.openrdf.repository.RepositoryException

Creates a new transaction which provides schema validation services at commit time. Note that the validation assumes that the state present is valid when Transaction.begin() is called. Schema annotations made at ResourceObject classes will be scanned the first time a validated transaction is created.

Parameters:

context - The context on which the transaction will operate on.

Returns:

The validated transaction. Transaction.begin() must be called afterwards.

Throws:

org.openrdf.repository.RepositoryException - Thrown if an error occurs regarding the connection to the triplestore.

getScannedClasspath

public Set<URL> getScannedClasspath()

Returns the classpath that is scanned for Iri and Partial annotated classes.

Returns:

Returns the classpath scanned.