Package cz.cvut.kbss.jopa.owl2java.cli

Enum Class Option

java.lang.Object

java.lang.Enum<Option>

cz.cvut.kbss.jopa.owl2java.cli.Option

All Implemented Interfaces:

Serializable, Comparable<Option>, java.lang.constant.Constable

public enum Option
extends Enum<Option>

Command line options for configuring the transformation/vocabulary generation.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS_USE_ONTOLOGY_PREFIX	Specifies whether to always use ontology prefix (if available) when generating vocabulary and model.
CONTEXT	Name of context which should be processed by the tool.
GENERATE_ANNOTATION_FIELDS	Whether to automatically generate name (rdfs:label) and description (dc:description) fields.
GENERATE_JAVADOC_FROM_COMMENT	Whether to generate Javadoc from values of rdfs:comment annotations.
GENERATE_THING	Whether to automatically generate an entity class corresponding to owl:Thing.
IGNORE_FAILED_IMPORTS	Whether to ignore failed imports.
JAVA_CLASSNAME_ANNOTATION	Configures annotation whose value should be used as name of the target Java class.
MAPPING_FILE	Mapping file path.
ONTOLOGY_PREFIX_PROPERTY	Property whose value represents the ontology IRI prefix.
PACKAGE	Target package for the generated classes.
PREFER_MULTILINGUAL_STRINGS	Configures whether properties with RDF langString range should be mapped to MultilingualString typed fields.
PREFIX_MAPPING_FILE	Specifies file containing ontology prefix mapping.
PROPERTIES_TYPE	Generic type of the Properties attribute.
TARGET_DIR	Output directory name.
WHOLE_ONTOLOGY_AS_IC	Whether to interpret the whole ontology as integrity constraints.
WITH_IRIS	Whether to generate vocabulary constants as instances of OWLAPI IRI.

Field Summary

Fields

Modifier and Type	Field	Description
final String	arg

Method Summary

Modifier and Type	Method	Description
static Option	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Option[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MAPPING_FILE

public static final Option MAPPING_FILE

Mapping file path.

Mapping file allows to map logical ontology IRI to its physical location (e.g. IRI to a local file path)

CONTEXT

public static final Option CONTEXT

Name of context which should be processed by the tool.

Context is specified by annotating an axiom with Constants.P_IS_INTEGRITY_CONSTRAINT_FOR containing the name of the context. When it is specified, only axioms annotated with the context name are considered for transformation/vocabulary generation.

WITH_IRIS

public static final Option WITH_IRIS

Whether to generate vocabulary constants as instances of OWLAPI IRI.

By default, they are String.

TARGET_DIR

public static final Option TARGET_DIR

Output directory name.

Note that the generator will create subdirectories corresponding to the package into which the target classes are generated.

PACKAGE

public static final Option PACKAGE

Target package for the generated classes.

Note that when generating the model, a Constants.MODEL_PACKAGE subpackage is put into the configured package for model classes. E.g., when generating into cz.cvut.kbss, the Vocabulary will be in this package, but the model classes will be in cz.cvut.kbss.model.

WHOLE_ONTOLOGY_AS_IC

public static final Option WHOLE_ONTOLOGY_AS_IC

Whether to interpret the whole ontology as integrity constraints.

This supersedes CONTEXT and processes all axioms in the ontology.

IGNORE_FAILED_IMPORTS

public static final Option IGNORE_FAILED_IMPORTS

Whether to ignore failed imports.

By default, the transformation/vocabulary generation will fail if an import cannot be resolved.

JAVA_CLASSNAME_ANNOTATION

public static final Option JAVA_CLASSNAME_ANNOTATION

Configures annotation whose value should be used as name of the target Java class.

By default, the Java class name is derived from the class IRI.

PREFER_MULTILINGUAL_STRINGS

public static final Option PREFER_MULTILINGUAL_STRINGS

Configures whether properties with RDF langString range should be mapped to MultilingualString typed fields.

Defaults to Defaults.PREFER_MULTILINGUAL_STRINGS. If false, the fields will have type String.

PROPERTIES_TYPE

public static final Option PROPERTIES_TYPE

Generic type of the Properties attribute.

Possible options are PropertiesType.string for <String, Set<String>> or PropertiesType.object for <String, Set<Object>>.

GENERATE_JAVADOC_FROM_COMMENT

public static final Option GENERATE_JAVADOC_FROM_COMMENT

Whether to generate Javadoc from values of rdfs:comment annotations.

By default, OWL2Java will generate Javadoc from the first rdfs:comment it finds for each axiom. This leads to documentation being created for classes, their attributes and vocabulary constants.

GENERATE_ANNOTATION_FIELDS

public static final Option GENERATE_ANNOTATION_FIELDS

Whether to automatically generate name (rdfs:label) and description (dc:description) fields.

GENERATE_THING

public static final Option GENERATE_THING

Whether to automatically generate an entity class corresponding to owl:Thing.

ONTOLOGY_PREFIX_PROPERTY

public static final Option ONTOLOGY_PREFIX_PROPERTY

Property whose value represents the ontology IRI prefix.

ALWAYS_USE_ONTOLOGY_PREFIX

public static final Option ALWAYS_USE_ONTOLOGY_PREFIX

Specifies whether to always use ontology prefix (if available) when generating vocabulary and model.

PREFIX_MAPPING_FILE

public static final Option PREFIX_MAPPING_FILE

Specifies file containing ontology prefix mapping.

Field Details

arg

public final String arg

Method Details

values

public static Option[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Option valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null