org.openimaj.rdf.owl2java

Class ClassDef

java.lang.Object

org.openimaj.rdf.owl2java.ClassDef

public class ClassDef
extends Object

Represents the definition of an ontology class.

Version:

$Author$, $Revision$, $Date$

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk), David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

29 Oct 2012

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<org.openrdf.model.URI,Set<org.openrdf.model.URI>>	allSuperclasses List of the all the ancestral superclasses to each of the direct superclasses
protected String	comment The description of the class from the RDF comment
protected Set<org.openrdf.model.URI>	directSuperclasses A list of the direct superclasses of this class
protected Set<PropertyDef>	properties List of the properties in this class
protected org.openrdf.model.URI	uri The URI of the class

Constructor Summary

Constructors

Constructor and Description
ClassDef()

Method Summary

Modifier and Type	Method and Description
void	generateClass(File targetDir, Map<org.openrdf.model.URI,String> pkgs, Map<org.openrdf.model.URI,ClassDef> classes, boolean flattenClassStructure, boolean generateAnnotations, boolean separateImplementations) Generates a Java file in the target directory
void	generateInterface(File targetDir, Map<org.openrdf.model.URI,String> pkgs, Map<org.openrdf.model.URI,ClassDef> classes) Generates a Java interface file in the target directory
Map<org.openrdf.model.URI,Set<org.openrdf.model.URI>>	getAllSuperclasses(org.openrdf.repository.RepositoryConnection conn) Traverses up the tree from this class to find all ancestor allSuperclasses.
static Map<org.openrdf.model.URI,ClassDef>	loadClasses(Generator.GeneratorOptions go, org.openrdf.repository.RepositoryConnection conn) Loads all the class definitions from the given repository
String	toString() Outputs the Java class definition for this class def

Methods inherited from class java.lang.Object

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

Field Detail

comment

protected String comment

The description of the class from the RDF comment

uri

protected org.openrdf.model.URI uri

The URI of the class

allSuperclasses

protected Map<org.openrdf.model.URI,Set<org.openrdf.model.URI>> allSuperclasses

List of the all the ancestral superclasses to each of the direct superclasses

directSuperclasses

protected Set<org.openrdf.model.URI> directSuperclasses

A list of the direct superclasses of this class

properties

protected Set<PropertyDef> properties

List of the properties in this class

Constructor Detail

ClassDef

public ClassDef()

Method Detail

toString

public String toString()

Outputs the Java class definition for this class def

Overrides:

toString in class Object

See Also:

Object.toString()

loadClasses

public static Map<org.openrdf.model.URI,ClassDef> loadClasses(Generator.GeneratorOptions go,
                                                              org.openrdf.repository.RepositoryConnection conn)
                                                       throws org.openrdf.repository.RepositoryException,
                                                              org.openrdf.query.MalformedQueryException,
                                                              org.openrdf.query.QueryEvaluationException

Loads all the class definitions from the given repository

Parameters:

conn - The repository connection from where to get the classes

go -

Returns:

a Map that maps class URIs to ClassDef objects

Throws:

org.openrdf.repository.RepositoryException

org.openrdf.query.MalformedQueryException

org.openrdf.query.QueryEvaluationException

generateClass

public void generateClass(File targetDir,
                          Map<org.openrdf.model.URI,String> pkgs,
                          Map<org.openrdf.model.URI,ClassDef> classes,
                          boolean flattenClassStructure,
                          boolean generateAnnotations,
                          boolean separateImplementations)
                   throws FileNotFoundException

Generates a Java file in the target directory

Parameters:

targetDir - The target directory

pkgs - A map of package mappings to class URIs

classes - A map of class URIs to ClassDefs

flattenClassStructure - Whether to flatten the class structure

generateAnnotations - Whether to generate OpenIMAJ RDF annotations for the properties

separateImplementations -

Throws:

FileNotFoundException

generateInterface

public void generateInterface(File targetDir,
                              Map<org.openrdf.model.URI,String> pkgs,
                              Map<org.openrdf.model.URI,ClassDef> classes)
                       throws FileNotFoundException

Generates a Java interface file in the target directory

Parameters:

targetDir - The target directory

pkgs - A list of package mappings to class URIs

classes - The URI to class definition map.

Throws:

FileNotFoundException

getAllSuperclasses

public Map<org.openrdf.model.URI,Set<org.openrdf.model.URI>> getAllSuperclasses(org.openrdf.repository.RepositoryConnection conn)

Traverses up the tree from this class to find all ancestor allSuperclasses.

Parameters:

conn - A connection to a triple-store repository

Returns:

A list of URIs representing the superclass ancestors of this class