com.github.anno4j.schema_parsing.building

Interface BuildableOntologyClazz

All Known Subinterfaces:

BuildableRDFSClazz

All Known Implementing Classes:

BuildableRDFSClazzSupport, ClazzBuildingSupport, InterfaceTypeSpecSupport, SupportTypeSpecSupport

public interface BuildableOntologyClazz

Provides support for transforming a ontology class to a Anno4j resource object and a corresponding support object.

Method Summary

Methods

Modifier and Type	Method and Description
com.squareup.javapoet.TypeSpec	buildSupportTypeSpec(OntGenerationConfig config) Generates a JavaPoet TypeSpec of a support class for this RDFS class.
com.squareup.javapoet.TypeSpec	buildTypeSpec(OntGenerationConfig config) Generates a JavaPoet TypeSpec of a resource object interface for this RDFS class.
String	getJavaPackageName(OntGenerationConfig config) Resolves a package name for a Java class representing this RDFS class.
com.squareup.javapoet.ClassName	getJavaPoetClassName(OntGenerationConfig config) Returns a JavaPoet ClassName object of a Java class for this RDFS class.

Method Detail

getJavaPackageName

String getJavaPackageName(OntGenerationConfig config)

Resolves a package name for a Java class representing this RDFS class. The package name will be extraced from the hostname portion of the resources URI.

Parameters:

config - Configuration for the generation of Java classes.

Returns:

The package name for this class or the default package (OntGenerationConfig.getBasePackage() of config) if no package name can be extracted from the resources URI (e.g. because it is a blank node).

getJavaPoetClassName

com.squareup.javapoet.ClassName getJavaPoetClassName(OntGenerationConfig config)
                                                     throws org.openrdf.repository.RepositoryException

Returns a JavaPoet ClassName object of a Java class for this RDFS class. Tries to resolve a package name and a identifier name from the classes URI. The generation of the classes name is enhanced by specifying a rdfs:label literal for the resource with RDFSSchemaResource.setLabels(Set). If no package name can be extracted for this resource (e.g. because it is a blank node) then the default package is set.

Parameters:

config - The configuration for building the class name (see OntGenerationConfig.setIdentifierLanguagePreference(List)).

Returns:

The class name of a Java class for this RDFS class.

Throws:

IllegalMappingException - Thrown if a DatatypeMapper returns a Java type that is not supported by Anno4j.

org.openrdf.repository.RepositoryException

buildTypeSpec

com.squareup.javapoet.TypeSpec buildTypeSpec(OntGenerationConfig config)
                                             throws org.openrdf.repository.RepositoryException

Generates a JavaPoet TypeSpec of a resource object interface for this RDFS class. The interface receives appropriate Iri annotations on both the interface itself and all methods representing properties which this class is domain of.

Parameters:

config - Configuration for the generation. E.g. specifies which language to use for JavaDoc.

Returns:

The type specification for a resource object interface for this RDFS class.

Throws:

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

buildSupportTypeSpec

com.squareup.javapoet.TypeSpec buildSupportTypeSpec(OntGenerationConfig config)
                                                    throws org.openrdf.repository.RepositoryException

Generates a JavaPoet TypeSpec of a support class for this RDFS class. The set* and add* methods implement checks for range validity if such a constraint is imposed by e.g. a XSD datatype.

Parameters:

config - Configuration for the generation. E.g. specifies which language to use for JavaDoc.

Returns:

The type specification for a support class for this RDFS class.

Throws:

org.openrdf.repository.RepositoryException