com.github.anno4j.schema_parsing.building

Class OntGenerationConfig

java.lang.Object

com.github.anno4j.schema_parsing.building.OntGenerationConfig

public class OntGenerationConfig
extends Object

Describes how Java classes should be built for resources. Allows to set preferences for the language used for JavaDocs and identifier names when generating Java classes from RDF.

Field Summary

Fields

Modifier and Type	Field and Description
static String	UNTYPED_LITERAL Pseudo language tag representing literals without language information.

Constructor Summary

Constructors

Constructor and Description
OntGenerationConfig() Initializes the configuration with preference for untyped literals for identifiers and JavaDoc.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	areAdderAllMethodsGenerated()
boolean	areAdderMethodsGenerated()
boolean	areRemoverAllMethodsGenerated()
boolean	areRemoverMethodsGenerated()
String	getBasePackage() Returns the package into which all generated Java files (within their respective packages) are written to.
Collection<DatatypeMapper>	getDatatypeMappers() Returns the datatype mappers that are used to map RDF datatypes (subclasses of rdfs:Datatype) to Java types.
ValidatorChain	getValidators()
boolean	isFileOrFragmentAmbiguityChecked() Identifier names for a resources are chosen from the suffix of its URI in absence of a RDFS label.
boolean	isIdentifierLanguagePreferred(String lang, String otherLang) Checks whether a language lang is preferred over another language otherLang for building Java identifier names.
boolean	isJavaDocLanguagePreferred(String lang, String otherLang) Checks whether a language lang is preferred over another language otherLang for building JavaDocs.
boolean	isPreferredForIdentifiers(CharSequence s, CharSequence other) Checks whether a string - with or without language information (see LangString) - is preferred over another string by the language preference set for building identifier names.
boolean	isPreferredForJavaDoc(CharSequence s, CharSequence other) Checks whether a string - with or without language information (see LangString) - is preferred over another string by the language preference set for building JavaDoc.
boolean	isRDFSLabelAmbiguityChecked() Identifier names for a resource are preferably chosen from its RDFS label (rdfs:label).
void	setBasePackage(String basePackage) Sets the package into which all generated Java files (within their respective packages) are written to.
void	setDatatypeMappers(Collection<DatatypeMapper> datatypeMappers) Sets the datatype mappers that are used to map RDF datatypes (subclasses of rdfs:Datatype) to Java types.
void	setDatatypeMappers(DatatypeMapper... datatypeMappers) Sets the datatype mappers that are used to map RDF datatypes (subclasses of rdfs:Datatype) to Java types.
void	setFileOrFragmentAmbiguityChecking(boolean checkFileOrFragmentAmbiguity) Identifier names for a resources are chosen from the suffix of its URI in absence of a RDFS label.
void	setIdentifierLanguagePreference(List<String> preference) Sets the preference for languages when building Identifier names.
void	setIdentifierLanguagePreference(String... preference) Sets the preference for languages when building Identifier names.
void	setJavaDocLanguagePreference(List<String> preference) Sets the preference for languages when generating JavaDoc.
void	setJavaDocLanguagePreference(String... preference) Sets the preference for languages when building Identifier names.
void	setRDFSLabelAmbiguityChecking(boolean checkRDFSLabelAmbiguity) Identifier names for a resource are preferably chosen from its RDFS label (rdfs:label).
void	setValidators(ValidatorChain validators)
void	useAdderAllMethodGeneration(boolean doGenerateAdderAll)
void	useAdderMethodGeneration(boolean doGenerateAdder)
void	useRemoverAllMethodGeneration(boolean doGenerateRemoverAll)
void	useRemoverMethodGeneration(boolean doGenerateRemover)

Methods inherited from class java.lang.Object

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

Field Detail

UNTYPED_LITERAL

public static final String UNTYPED_LITERAL

Pseudo language tag representing literals without language information.

Constructor Detail

OntGenerationConfig

public OntGenerationConfig()

Initializes the configuration with preference for untyped literals for identifiers and JavaDoc. Uses the default validator chain for RDFS (see ValidatorChain.getRDFSDefault()).

Method Detail

setIdentifierLanguagePreference

public void setIdentifierLanguagePreference(List<String> preference)

Sets the preference for languages when building Identifier names. Literals with a language tag occurring in the given list before another are preferred over the latter for generating a Java identifier. The entries in the preference list must be valid language tags as described in BCP47 or UNTYPED_LITERAL. Note that the latter represents preference for an untyped literal, i.e. a literal without language information.

Parameters:

preference - The preference sequence to use for identifier names.

setIdentifierLanguagePreference

public void setIdentifierLanguagePreference(String... preference)

Sets the preference for languages when building Identifier names. Literals with a language tag occurring in the given list before another are preferred over the latter for generating a Java identifier. The entries in the preference list must be valid language tags as described in BCP47 or UNTYPED_LITERAL. Note that the latter represents preference for an untyped literal, i.e. a literal without language information.

Parameters:

preference - The preference sequence to use for identifier names.

setJavaDocLanguagePreference

public void setJavaDocLanguagePreference(List<String> preference)

Sets the preference for languages when generating JavaDoc. Literals with a language tag occurring in the given list before another are preferred over the latter for generating a Java identifier. The entries in the preference list must be valid language tags as described in BCP47 or UNTYPED_LITERAL. Note that the latter represents preference for an untyped literal, i.e. a literal without language information.

Parameters:

preference - The preference sequence to use for identifier names.

setJavaDocLanguagePreference

public void setJavaDocLanguagePreference(String... preference)

Sets the preference for languages when building Identifier names. Literals with a language tag occurring in the given list before another are preferred over the latter for generating a Java identifier. The entries in the preference list must be valid language tags as described in BCP47 or UNTYPED_LITERAL. Note that the latter represents preference for an untyped literal, i.e. a literal without language information.

Parameters:

preference - The preference sequence to use for identifier names.

getValidators

public ValidatorChain getValidators()

Returns:

The validator chain used for checking that arguments of resource object set- and add-methods comply to the value space of their datatype.

setValidators

public void setValidators(ValidatorChain validators)

Parameters:

validators - The validator chain used for checking that arguments of resource object set- and add-methods comply to the value space of their datatype.

isIdentifierLanguagePreferred

public boolean isIdentifierLanguagePreferred(String lang,
                                    String otherLang)

Checks whether a language lang is preferred over another language otherLang for building Java identifier names. Note that the UNTYPED_LITERAL value for the language tags is allowed, representing untyped literals.

Parameters:

lang - The language to decide preference for. Must be a valid language tag as defined in BCP47 or UNTYPED_LITERAL for unknown language.

otherLang - The language to compare to. Must be a valid language tag as defined in BCP47 or UNTYPED_LITERAL for unknown language.

Returns:

Returns true if lang is preferred over otherLang or it is in the preference list for identifier names and otherLang is not. Returns false if lang is not in the preference list.

isPreferredForIdentifiers

public boolean isPreferredForIdentifiers(CharSequence s,
                                CharSequence other)

Checks whether a string - with or without language information (see LangString) - is preferred over another string by the language preference set for building identifier names.

Parameters:

s - The string to decide preference for.

other - The string to compare to.

Returns:

Returns true if the language of s is preferred over the one of other or its language is in the preference list for building identifier names and the one of other is not. Returns false if the language of s is not in the preference list.

isJavaDocLanguagePreferred

public boolean isJavaDocLanguagePreferred(String lang,
                                 String otherLang)

Checks whether a language lang is preferred over another language otherLang for building JavaDocs. Note that the UNTYPED_LITERAL value for the language tags is allowed, representing untyped literals.

Parameters:

lang - The language to decide preference for. Must be a valid language tag as defined in BCP47 or UNTYPED_LITERAL for unknown language.

otherLang - The language to compare to. Must be a valid language tag as defined in BCP47 or UNTYPED_LITERAL for unknown language.

Returns:

Returns true if lang is preferred over otherLang or it is in the preference list for JavaDocs and otherLang is not. Returns false if lang is not in the preference list.

isPreferredForJavaDoc

public boolean isPreferredForJavaDoc(CharSequence s,
                            CharSequence other)

Checks whether a string - with or without language information (see LangString) - is preferred over another string by the language preference set for building JavaDoc.

Parameters:

s - The string to decide preference for.

other - The string to compare to.

Returns:

Returns true if the language of s is preferred over the one of other or its language is in the preference list for building JavaDocs and the one of other is not. Returns false if the language of s is not in the preference list.

getDatatypeMappers

public Collection<DatatypeMapper> getDatatypeMappers()

Returns the datatype mappers that are used to map RDF datatypes (subclasses of rdfs:Datatype) to Java types.

Returns:

The mappers to be used during Java file generation.

setDatatypeMappers

public void setDatatypeMappers(Collection<DatatypeMapper> datatypeMappers)

Sets the datatype mappers that are used to map RDF datatypes (subclasses of rdfs:Datatype) to Java types.

Parameters:

datatypeMappers - The mappers to be used during Java file generation.

setDatatypeMappers

public void setDatatypeMappers(DatatypeMapper... datatypeMappers)

Sets the datatype mappers that are used to map RDF datatypes (subclasses of rdfs:Datatype) to Java types.

Parameters:

datatypeMappers - The mappers to be used during Java file generation.

isRDFSLabelAmbiguityChecked

public boolean isRDFSLabelAmbiguityChecked()

Identifier names for a resource are preferably chosen from its RDFS label (rdfs:label). If the ambiguity check is enabled all other labels will be checked for being possibly in conflict when a identifier name is generated, i.e. would result in the same identifier name. In case of a conflict the identifier is picked from the resources URI (also see isFileOrFragmentAmbiguityChecked()) for this.

Returns:

Returns true if ambiguity checks will be performed.

setRDFSLabelAmbiguityChecking

public void setRDFSLabelAmbiguityChecking(boolean checkRDFSLabelAmbiguity)

Identifier names for a resource are preferably chosen from its RDFS label (rdfs:label). If the ambiguity check is enabled all other labels will be checked for being possibly in conflict when a identifier name is generated, i.e. would result in the same identifier name. In case of a conflict the identifier is picked from the resources URI (also see isFileOrFragmentAmbiguityChecked()) for this.

Parameters:

checkRDFSLabelAmbiguity - Whether to perform the above check and fallback mechanism.

isFileOrFragmentAmbiguityChecked

public boolean isFileOrFragmentAmbiguityChecked()

Identifier names for a resources are chosen from the suffix of its URI in absence of a RDFS label. If the ambiguity check is enabled all other resources will be checked for their URIs being possibly in conflict with the suffix of the URI of the resource to generate an identifier for. In case of a conflict the identifier is still picked in an unique way, but it may be less readable. Also see IdentifierBuilder for this.
Example:
Consider the class resources http://example.de/ont#Main_Dish and http://example.de/ont#MainDish. If the ambiguity check is turned off, the generated classes will both be named MainDish which will lead to Java compile errors. If the check is enabled the class names will receive an unique number so they can be distinguished.

Returns:

Returns whether the above check is turned on.

setFileOrFragmentAmbiguityChecking

public void setFileOrFragmentAmbiguityChecking(boolean checkFileOrFragmentAmbiguity)

Identifier names for a resources are chosen from the suffix of its URI in absence of a RDFS label. If the ambiguity check is enabled all other resources will be checked for their URIs being possibly in conflict with the suffix of the URI of the resource to generate an identifier for. In case of a conflict the identifier is still picked in an unique way, but it may be less readable. Also see IdentifierBuilder for this.
Example:
Consider the class resources http://example.de/ont#Main_Dish and http://example.de/ont#MainDish. If the ambiguity check is turned off, the generated classes will both be named MainDish which will lead to Java compile errors. If the check is enabled the class names will receive an unique number so they can be distinguished.

Parameters:

checkFileOrFragmentAmbiguity - Whether the above check should be turned on.

getBasePackage

public String getBasePackage()

Returns the package into which all generated Java files (within their respective packages) are written to.

Example:
If the files should be put in your existing projects package com.yourproject.model specify the base package that way and JavaFileGenerator will write Java files into subpackages (determined by the class URIs) and adopt the package declaration within the source files, e.g. package com.yourproject.model.org.dbpedia.

Returns:

Returns the base package.

setBasePackage

public void setBasePackage(String basePackage)

Sets the package into which all generated Java files (within their respective packages) are written to.

Example:
If the files should be put in your existing projects package com.yourproject.model specify the base package that way and JavaFileGenerator will write Java files into subpackages (determined by the class URIs) and adopt the package declaration within the source files, e.g. package com.yourproject.model.org.dbpedia.

Parameters:

basePackage - The base package.

areAdderMethodsGenerated

public boolean areAdderMethodsGenerated()

Returns:

Whether methods for adding a single value to the value set of an objects property should be generated.

useAdderMethodGeneration

public void useAdderMethodGeneration(boolean doGenerateAdder)

Parameters:

doGenerateAdder - Whether methods for adding a single value to the value set of an objects property should be generated.

areAdderAllMethodsGenerated

public boolean areAdderAllMethodsGenerated()

Returns:

Whether methods for adding a multiple values to the value set of an objects property should be generated.

useAdderAllMethodGeneration

public void useAdderAllMethodGeneration(boolean doGenerateAdderAll)

Parameters:

doGenerateAdderAll - Whether methods for adding a multiple values to the value set of an objects property should be generated.

areRemoverMethodsGenerated

public boolean areRemoverMethodsGenerated()

Returns:

Whether methods for removing a single value from the value set of an objects property should be generated.

useRemoverMethodGeneration

public void useRemoverMethodGeneration(boolean doGenerateRemover)

Parameters:

doGenerateRemover - Whether methods for removing a single value from the value set of an objects property should be generated.

areRemoverAllMethodsGenerated

public boolean areRemoverAllMethodsGenerated()

Returns:

Whether methods for removing a multiple values from the value set of an objects property should be generated.

useRemoverAllMethodGeneration

public void useRemoverAllMethodGeneration(boolean doGenerateRemoverAll)

Parameters:

doGenerateRemoverAll - Whether methods for removing a multiple values from the value set of an objects property should be generated.