com.github.anno4j.schema_parsing.building

Interface OntologyModelBuilder

All Known Implementing Classes:

OWLJavaFileGenerator

public interface OntologyModelBuilder

Builds an ontology model from the RDF data provided. The classes and properties can be queried after a call to build().

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OntologyModelBuilder.RDFSModelBuildingException Signalizes an error while building the ontology model from a set of RDF statements.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRDF(InputStream rdfInput, String base) Adds RDF statements to the model.
void	addRDF(InputStream rdfInput, String base, String format) Adds RDF statements to the model.
void	addRDF(String url) Adds RDF statements to the underlying model.
void	addRDF(String url, String base) Adds RDF statements to the model.
void	addRDF(String url, String base, String format) Adds RDF statements to the model.
void	build() Builds an ontology model for the RDF data added before using addRDF methods.
Collection<BuildableRDFSClazz>	getClazzes() Returns the extended resource objects of RDFS classes that were found during the last call to build().
ObjectConnection	getConnection() Returns a connection to the object repository that receives the ontology information during a call to build().
Collection<BuildableRDFSProperty>	getProperties() Returns the extended resource objects of RDFS properties that were found during the last call to build().
com.hp.hpl.jena.reasoner.ValidityReport	validate() Returns a validity report for the model build during the last call of build().

Method Detail

addRDF

void addRDF(InputStream rdfInput,
          String base)

Adds RDF statements to the model. A subsequent call to build() is required for committing the data to the model.

Parameters:

rdfInput - An input stream to RDF/XML data.

base - The base uri to be used when converting relative URI's to absolute URI's.

addRDF

void addRDF(String url,
          String base)

Adds RDF statements to the model. A subsequent call to build() is required for committing the data to the model.

Parameters:

url - An URL to RDF data in RDF/XML format.

base - The base uri to be used when converting relative URI's to absolute URI's.

addRDF

void addRDF(InputStream rdfInput,
          String base,
          String format)

Adds RDF statements to the model. A subsequent call to build() is required for committing the data to the model.

Parameters:

rdfInput - An input stream to the RDF data. Its format is defined by the format parameter.

base - The base uri to be used when converting relative URI's to absolute URI's.

format - The format of the RDF data. One of "RDF/XML", "N-TRIPLE", "TURTLE" (or "TTL") and "N3" or null for the default format.

addRDF

void addRDF(String url,
          String base,
          String format)

Adds RDF statements to the model. A subsequent call to build() is required for committing the data to the model.

Parameters:

url - An URL to RDF data in the specified format.

base - The base uri to be used when converting relative URI's to absolute URI's.

format - The format of the RDF data. One of "RDF/XML", "N-TRIPLE", "TURTLE" (or "TTL") and "N3" or null for the default format.

addRDF

void addRDF(String url)

Adds RDF statements to the underlying model.

Parameters:

url - URL to a RDF/XML file containing the RDF data to be added.

getClazzes

Collection<BuildableRDFSClazz> getClazzes()
                                          throws org.openrdf.repository.RepositoryException

Returns the extended resource objects of RDFS classes that were found during the last call to build().

Returns:

Returns the RDFS classes in the model built.

Throws:

org.openrdf.repository.RepositoryException

getProperties

Collection<BuildableRDFSProperty> getProperties()
                                                throws org.openrdf.repository.RepositoryException

Returns the extended resource objects of RDFS properties that were found during the last call to build().

Returns:

Returns the RDFS properties in the model built.

Throws:

org.openrdf.repository.RepositoryException

validate

com.hp.hpl.jena.reasoner.ValidityReport validate()

Returns a validity report for the model build during the last call of build().

Returns:

The validity report for the model. Use ValidityReport.isValid() to check if the model built is valid.

Throws:

IllegalStateException - Thrown if the model was not previously built.

getConnection

ObjectConnection getConnection()
                               throws org.openrdf.repository.RepositoryException

Returns a connection to the object repository that receives the ontology information during a call to build().

Returns:

Returns a object connection to the repository.

Throws:

org.openrdf.repository.RepositoryException - Thrown if no connection could be established.

build

void build()
           throws OntologyModelBuilder.RDFSModelBuildingException

Builds an ontology model for the RDF data added before using addRDF methods. After a call to this method, the classes and properties in the model can be queried using getClazzes() and getProperties() respectively.

Throws:

OntologyModelBuilder.RDFSModelBuildingException - Thrown if an error occurs during building the model.