com.github.anno4j.schema_parsing.building

Interface BuildableOntologyProperty

All Known Subinterfaces:

BuildableRDFSProperty

All Known Implementing Classes:

AdderAllImplementationSupport, AdderAllSupport, AdderImplementationSupport, AdderSupport, BuildableRDFSPropertySupport, GetterSupport, PropertyBuildingSupport, RemoverAllImplementationSupport, RemoverAllSupport, RemoverImplementationSupport, RemoverSupport, SetterBuildingSupport, SetterSupport, VarArgSetterImplementationSupport, VarArgSetterSupport

public interface BuildableOntologyProperty

Provides support for building Java methods for RDF properties.

Method Summary

Methods

Modifier and Type	Method and Description
com.squareup.javapoet.MethodSpec	buildAdder(RDFSClazz domainClazz, OntGenerationConfig config) Generates a JavaPoet method specification for a Anno4j resource object add-method for this property.
com.squareup.javapoet.MethodSpec	buildAdderAll(RDFSClazz domainClazz, OntGenerationConfig config) Generates a JavaPoet method specification for a Anno4j resource object add-method for this property.
com.squareup.javapoet.MethodSpec	buildAdderAllImplementation(RDFSClazz domainClazz, OntGenerationConfig config) Generates a JavaPoet method specification for a Support class add-method for this property.
com.squareup.javapoet.MethodSpec	buildAdderImplementation(RDFSClazz domainClazz, OntGenerationConfig config) Generates a JavaPoet method specification for a Support class add-method for this property.
com.squareup.javapoet.MethodSpec	buildGetter(RDFSClazz domainClazz, OntGenerationConfig config) Generates a JavaPoet method specification for a Anno4j resource object getter for this property.
com.squareup.javapoet.MethodSpec	buildRemover(RDFSClazz domainClazz, OntGenerationConfig config) Generates a JavaPoet method specification for a Anno4j resource object remove-method for this property.
com.squareup.javapoet.MethodSpec	buildRemoverAll(RDFSClazz domainClazz, OntGenerationConfig config) Generates a JavaPoet method specification for a Anno4j resource object removeAll-method for this property.
com.squareup.javapoet.MethodSpec	buildRemoverAllImplementation(RDFSClazz domainClazz, OntGenerationConfig config) Generates a JavaPoet method specification for a Support class removeAll-method for this property.
com.squareup.javapoet.MethodSpec	buildRemoverImplementation(RDFSClazz domainClazz, OntGenerationConfig config) Generates a JavaPoet method specification for a Support class remove-method for this property.
com.squareup.javapoet.MethodSpec	buildSetter(RDFSClazz domainClazz, OntGenerationConfig config) Generates a JavaPoet method specification for a Anno4j resource object setter for this property.
com.squareup.javapoet.MethodSpec	buildVarArgSetter(RDFSClazz domainClazz, OntGenerationConfig config) Generates a JavaPoet method specification for a Anno4j resource object variable argument setter for this property.
com.squareup.javapoet.MethodSpec	buildVarArgSetterImplementation(RDFSClazz domainClazz, OntGenerationConfig config) Generates a JavaPoet method specification for a Support class variable argument setter for this property.
String	getCapitalizedIdentifier(OntGenerationConfig config, boolean plural) Generates a uppercase identifier for this property based on the natural language preferences set in config.
com.squareup.javapoet.ClassName	getDomainJavaPoetClassName(OntGenerationConfig config) Returns the JavaPoet class name of the most specific common superclass of all classes defined as the domain of this property.
String	getLowercaseIdentifier(OntGenerationConfig config, boolean plural) Generates a lowercase identifier for this property based on the natural language preferences set in config.
com.squareup.javapoet.ClassName	getRangeJavaPoetClassName(OntGenerationConfig config) Returns the JavaPoet class name of the most specific common superclass of all classes defined as the range of this property.

Method Detail

getDomainJavaPoetClassName

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

Returns the JavaPoet class name of the most specific common superclass of all classes defined as the domain of this property.

Parameters:

config - The configuration for building the class name.

Returns:

The class name of the properties domains common superclass based on config or null if no such class can be determined.

Throws:

org.openrdf.repository.RepositoryException

getRangeJavaPoetClassName

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

Returns the JavaPoet class name of the most specific common superclass of all classes defined as the range of this property.

Parameters:

config - The configuration for building the class name.

Returns:

The class name of the properties ranges common superclass based on config or null if no such class can be determined.

Throws:

org.openrdf.repository.RepositoryException

getLowercaseIdentifier

String getLowercaseIdentifier(OntGenerationConfig config,
                            boolean plural)
                              throws org.openrdf.repository.RepositoryException

Generates a lowercase identifier for this property based on the natural language preferences set in config.

Parameters:

config - The configuration object on basis of which the identifier will be built.

plural - Whether the identifier should be in plural form.

Returns:

A lowercase identifier for this property suiting the preferences made in config.

Throws:

org.openrdf.repository.RepositoryException

getCapitalizedIdentifier

String getCapitalizedIdentifier(OntGenerationConfig config,
                              boolean plural)
                                throws org.openrdf.repository.RepositoryException

Generates a uppercase identifier for this property based on the natural language preferences set in config.

Parameters:

config - The configuration object on basis of which the identifier will be built.

plural - Whether the identifier should be in plural form.

Returns:

A uppercase identifier for this property suiting the preferences made in config.

Throws:

org.openrdf.repository.RepositoryException

buildGetter

com.squareup.javapoet.MethodSpec buildGetter(RDFSClazz domainClazz,
                                           OntGenerationConfig config)
                                             throws org.openrdf.repository.RepositoryException

Generates a JavaPoet method specification for a Anno4j resource object getter for this property. JavaDoc and method name are picked from rdfs:comment/rdfs:label according to the configuration provided.

Parameters:

domainClazz - The class in which context the method should be generated.

config - The configuration for building the method specification.

Returns:

The JavaPoet method specification for this property or null if no range was provided for this property.

Throws:

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

buildSetter

com.squareup.javapoet.MethodSpec buildSetter(RDFSClazz domainClazz,
                                           OntGenerationConfig config)
                                             throws org.openrdf.repository.RepositoryException

Generates a JavaPoet method specification for a Anno4j resource object setter for this property. JavaDoc and method name are picked from rdfs:comment/rdfs:label according to the configuration provided.

Parameters:

domainClazz - The class in which context the method should be generated.

config - The configuration for building the method specification.

Returns:

The JavaPoet method specification for this property or null if no range was provided for this property.

Throws:

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

buildVarArgSetter

com.squareup.javapoet.MethodSpec buildVarArgSetter(RDFSClazz domainClazz,
                                                 OntGenerationConfig config)
                                                   throws org.openrdf.repository.RepositoryException

Generates a JavaPoet method specification for a Anno4j resource object variable argument setter for this property. JavaDoc and method name are picked from rdfs:comment/rdfs:label according to the configuration provided.

Parameters:

domainClazz - The class in which context the method should be generated.

config - The configuration for building the method specification.

Returns:

The JavaPoet method specification for this property or null if no range was provided for this property.

Throws:

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

buildVarArgSetterImplementation

com.squareup.javapoet.MethodSpec buildVarArgSetterImplementation(RDFSClazz domainClazz,
                                                               OntGenerationConfig config)
                                                                 throws org.openrdf.repository.RepositoryException

Generates a JavaPoet method specification for a Support class variable argument setter for this property. Checks whether the provided values are in range are added to the methods definition.

Parameters:

domainClazz - The class in which context the method should be generated.

config - The configuration for building the method specification.

Returns:

The JavaPoet method specification for this property or null if no range was provided for this property.

Throws:

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

buildAdder

com.squareup.javapoet.MethodSpec buildAdder(RDFSClazz domainClazz,
                                          OntGenerationConfig config)
                                            throws org.openrdf.repository.RepositoryException

Generates a JavaPoet method specification for a Anno4j resource object add-method for this property. JavaDoc and method name are picked from rdfs:comment/rdfs:label according to the configuration provided.

Parameters:

domainClazz - The class in which context the method should be generated.

config - The configuration for building the method specification.

Returns:

The JavaPoet method specification for this property or null if no range was provided for this property.

Throws:

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

buildAdderImplementation

com.squareup.javapoet.MethodSpec buildAdderImplementation(RDFSClazz domainClazz,
                                                        OntGenerationConfig config)
                                                          throws org.openrdf.repository.RepositoryException

Generates a JavaPoet method specification for a Support class add-method for this property. JavaDoc and method name are picked from rdfs:comment/rdfs:label according to the configuration provided.

Parameters:

domainClazz - The class in which context the method should be generated.

config - The configuration for building the method specification.

Returns:

The JavaPoet method specification for this property or null if no range was provided for this property or an error occurs.

Throws:

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

buildAdderAll

com.squareup.javapoet.MethodSpec buildAdderAll(RDFSClazz domainClazz,
                                             OntGenerationConfig config)
                                               throws org.openrdf.repository.RepositoryException

Generates a JavaPoet method specification for a Anno4j resource object add-method for this property. JavaDoc and method name are picked from rdfs:comment/rdfs:label according to the configuration provided.

Parameters:

domainClazz - The class in which context the method should be generated.

config - The configuration for building the method specification.

Returns:

The JavaPoet method specification for this property or null if no range was provided for this property.

Throws:

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

buildAdderAllImplementation

com.squareup.javapoet.MethodSpec buildAdderAllImplementation(RDFSClazz domainClazz,
                                                           OntGenerationConfig config)
                                                             throws org.openrdf.repository.RepositoryException

Generates a JavaPoet method specification for a Support class add-method for this property. JavaDoc and method name are picked from rdfs:comment/rdfs:label according to the configuration provided.

Parameters:

domainClazz - The class in which context the method should be generated.

config - The configuration for building the method specification.

Returns:

The JavaPoet method specification for this property or null if no range was provided for this property or an error occurs.

Throws:

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

buildRemover

com.squareup.javapoet.MethodSpec buildRemover(RDFSClazz domainClazz,
                                            OntGenerationConfig config)
                                              throws org.openrdf.repository.RepositoryException

Generates a JavaPoet method specification for a Anno4j resource object remove-method for this property. JavaDoc and method name are picked from rdfs:comment/rdfs:label according to the configuration provided.

Parameters:

config - The configuration for building the method specification.

Returns:

The JavaPoet method specification for this property or null if no range was provided for this property.

Throws:

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

buildRemoverImplementation

com.squareup.javapoet.MethodSpec buildRemoverImplementation(RDFSClazz domainClazz,
                                                          OntGenerationConfig config)
                                                            throws org.openrdf.repository.RepositoryException

Generates a JavaPoet method specification for a Support class remove-method for this property. JavaDoc and method name are picked from rdfs:comment/rdfs:label according to the configuration provided.

Parameters:

domainClazz - The class in which context the method should be generated.

config - The configuration for building the method specification.

Returns:

The JavaPoet method specification for this property or null if no range was provided for this property or an error occurs.

Throws:

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

buildRemoverAll

com.squareup.javapoet.MethodSpec buildRemoverAll(RDFSClazz domainClazz,
                                               OntGenerationConfig config)
                                                 throws org.openrdf.repository.RepositoryException

Generates a JavaPoet method specification for a Anno4j resource object removeAll-method for this property. JavaDoc and method name are picked from rdfs:comment/rdfs:label according to the configuration provided.

Parameters:

domainClazz - The class in which context the method should be generated.

config - The configuration for building the method specification.

Returns:

The JavaPoet method specification for this property or null if no range was provided for this property.

Throws:

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

buildRemoverAllImplementation

com.squareup.javapoet.MethodSpec buildRemoverAllImplementation(RDFSClazz domainClazz,
                                                             OntGenerationConfig config)
                                                               throws org.openrdf.repository.RepositoryException

Generates a JavaPoet method specification for a Support class removeAll-method for this property. JavaDoc and method name are picked from rdfs:comment/rdfs:label according to the configuration provided.

Parameters:

domainClazz - The class in which context the method should be generated.

config - The configuration for building the method specification.

Returns:

The JavaPoet method specification for this property or null if no range was provided for this property or an error occurs.

Throws:

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