com.github.anno4j.schema_parsing.building

Class OWLJavaFileGenerator

java.lang.Object

com.github.anno4j.schema_parsing.building.OWLJavaFileGenerator

All Implemented Interfaces:

OntologyModelBuilder, JavaFileGenerator

public class OWLJavaFileGenerator
extends Object
implements OntologyModelBuilder, JavaFileGenerator

This class takes an RDFS or OWL DL ontology and generates Java files that can afterwards be used with Anno4j. RDF ontology information can be added by calls to addRDF methods. Afterwards Java files can be generated by a call to generateJavaFiles(OntGenerationConfig, File) providing an appropriate configuration (see OntGenerationConfig). All implicit information about the ontology is inferred before the files are generated.

Example:
OntGenerationConfig config = new OntGenerationConfig(); // Adopt your config here... JavaFileGenerator generator = new OWLJavaFileGenerator(); generator.addRDF("http://example.de/my_ontology.rdf.xml"); File outputDir = new File("out"); generator.generateJavaFiles(config, outputDir);

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.anno4j.schema_parsing.building.OntologyModelBuilder

OntologyModelBuilder.RDFSModelBuildingException

Nested classes/interfaces inherited from interface com.github.anno4j.schema_parsing.generation.JavaFileGenerator

JavaFileGenerator.InvalidOntologyException, JavaFileGenerator.JavaFileGenerationException

Constructor Summary

Constructors

Constructor and Description
OWLJavaFileGenerator() Initializes the generator without a connection to an external repository, i.e.
OWLJavaFileGenerator(Anno4j anno4j) Initializes the generator with an Anno4j instance which connected repository will receive the ontology information (including inferred statements) after a call to build() or generateJavaFiles(OntGenerationConfig, File).

Method Summary

Methods

Modifier and Type	Method and Description
void	addRDF(InputStream rdfInput, String format) 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 format) 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.
void	generateJavaFiles(OntGenerationConfig config, File outputDirectory) Generates .java files of resource objects (see ResourceObject) and support classes (see ResourceObjectSupport) for the classes defined in a ontology.
Collection<BuildableRDFSClazz>	getClazzes() Returns the buildable named 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 OntologyModelBuilder.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().

Methods inherited from class java.lang.Object

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

Constructor Detail

OWLJavaFileGenerator

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

Initializes the generator without a connection to an external repository, i.e. no ontology information is persisted.

Throws:

org.openrdf.repository.config.RepositoryConfigException - Thrown if the internal repository is not correctly configured.

org.openrdf.repository.RepositoryException - Thrown if an error occurs regarding the setup of the internal repository.

OWLJavaFileGenerator

public OWLJavaFileGenerator(Anno4j anno4j)

Initializes the generator with an Anno4j instance which connected repository will receive the ontology information (including inferred statements) after a call to build() or generateJavaFiles(OntGenerationConfig, File).

Parameters:

anno4j - The Anno4j instance that will receive ontology information.

Method Detail

addRDF

public void addRDF(InputStream rdfInput,
          String format)

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

Specified by:

addRDF in interface OntologyModelBuilder

Specified by:

addRDF in interface JavaFileGenerator

Parameters:

rdfInput - An input stream to RDF/XML data.

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

addRDF

public void addRDF(String url,
          String format)

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

Specified by:

addRDF in interface OntologyModelBuilder

Specified by:

addRDF in interface JavaFileGenerator

Parameters:

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

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

addRDF

public 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.

Specified by:

addRDF in interface OntologyModelBuilder

Specified by:

addRDF in interface JavaFileGenerator

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"

addRDF

public 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.

Specified by:

addRDF in interface OntologyModelBuilder

Specified by:

addRDF in interface JavaFileGenerator

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"

addRDF

public void addRDF(String url)

Adds RDF statements to the underlying model.

Specified by:

addRDF in interface OntologyModelBuilder

Parameters:

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

getClazzes

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

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

Specified by:

getClazzes in interface OntologyModelBuilder

Returns:

Returns the RDFS classes in the model built.

Throws:

org.openrdf.repository.RepositoryException

getProperties

public 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().

Specified by:

getProperties in interface OntologyModelBuilder

Returns:

Returns the RDFS properties in the model built.

Throws:

org.openrdf.repository.RepositoryException

validate

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

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

Specified by:

validate in interface OntologyModelBuilder

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.

build

public 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.

Specified by:

build in interface OntologyModelBuilder

Throws:

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

OntologyModelBuilder.RDFSModelBuildingException

getConnection

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

Description copied from interface: OntologyModelBuilder

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

Specified by:

getConnection in interface OntologyModelBuilder

Returns:

Returns a object connection to the repository.

Throws:

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

generateJavaFiles

public void generateJavaFiles(OntGenerationConfig config,
                     File outputDirectory)
                       throws JavaFileGenerator.JavaFileGenerationException,
                              IOException,
                              org.openrdf.repository.RepositoryException

Description copied from interface: JavaFileGenerator

Generates .java files of resource objects (see ResourceObject) and support classes (see ResourceObjectSupport) for the classes defined in a ontology. Information about this ontology must be previously added with the addRDF methods.

Specified by:

generateJavaFiles in interface JavaFileGenerator

Parameters:

config - The configuration object defining how java classes are generated from an ontology. For example a preference for the language of generated JavaDoc can be set.

outputDirectory - The directory where the generated .java files (or their package directories respectively) are stored. Will be created if it does not exist. If the directory is not empty then existing files may be overwritten.

Throws:

JavaFileGenerator.JavaFileGenerationException - Thrown if an error occurred during file generation.

IOException - Thrown if an error occurs while writing the generated files.

org.openrdf.repository.RepositoryException - Thrown if an error occurs while querying the repository.