de.enflexit.common.ontology

Class OntologyClass

java.lang.Object

de.enflexit.common.ontology.OntologyClass

All Implemented Interfaces:

java.io.Serializable

public class OntologyClass
extends java.lang.Object
implements java.io.Serializable

This class holds detailed information of a single ontology, given by its class reference.
Furthermore, it creates the needed nodes for the tree, which displays all elements.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
OntologyClassVocabulary	ontologieVocabulary
java.util.List<java.lang.String>	ontologyAgentActionNames
java.util.List<java.lang.String>	ontologyConceptNames
java.lang.String	ontologyErrorStack
java.util.List<java.lang.String>	ontologyPredicateNames
OntologyClassTree	projectOntologieTree

Constructor Summary

Constructors

Constructor and Description
OntologyClass(java.lang.String ontologyReference) Constructor of this class.

Method Summary

Modifier and Type	Method and Description
java.lang.Class<? extends jade.content.onto.Ontology>	getOntologyClass() Returns the ontology class, if the specified ontology reference is valid.
jade.content.onto.Ontology	getOntologyInstance() This Method returns the instance of the current Ontology-Class.
java.lang.String	getOntologyMainClass() Gets the ontology main class.
java.lang.String	getOntologyName() Gets the ontology name.
java.lang.String	getOntologySourcePackage() Gets the ontology source package.
OntologyClassTree	getOntologyTree() Provides the @link OntologyClassTree - Object.
java.lang.String	getVocabularyValue(java.lang.String key) Provides a value from the ontology vocabulary, given by its public static name.
boolean	isCorrectTreeBuild() Checks if is correct tree build.
void	setCorrectTreeBuild(boolean correctTreeBuild) Sets the correct tree build.
void	setOntologyMainClass(java.lang.String currOntoMainClass) Sets the ontology main class.
void	setOntologyName(java.lang.String currOntoName) Sets the ontology name.
void	setOntologySourcePackage(java.lang.String ontologySourcePackage) Sets the ontology source package.
void	setOntologyVocabulary(java.lang.Class<?> Class) Sets the ontology vocabulary.

Methods inherited from class java.lang.Object

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

Field Detail

projectOntologieTree

public OntologyClassTree projectOntologieTree

ontologieVocabulary

public OntologyClassVocabulary ontologieVocabulary

ontologyConceptNames

public java.util.List<java.lang.String> ontologyConceptNames

ontologyAgentActionNames

public java.util.List<java.lang.String> ontologyAgentActionNames

ontologyPredicateNames

public java.util.List<java.lang.String> ontologyPredicateNames

ontologyErrorStack

public java.lang.String ontologyErrorStack

Constructor Detail

OntologyClass

public OntologyClass(java.lang.String ontologyReference)

Constructor of this class. As 'ontologyReference' two arguments can be used: a) the reference to the main-class of an known ontology b) the source-package of an ontology e. g. 'myproject.ontology'

Parameters:

ontologyReference - the ontology reference

Method Detail

isCorrectTreeBuild

public boolean isCorrectTreeBuild()

Checks if is correct tree build.

Returns:

true, if is correct tree build

setCorrectTreeBuild

public void setCorrectTreeBuild(boolean correctTreeBuild)

Sets the correct tree build.

Parameters:

correctTreeBuild - the new correct tree build

getOntologyClass

public java.lang.Class<? extends jade.content.onto.Ontology> getOntologyClass()

Returns the ontology class, if the specified ontology reference is valid.

Returns:

the ontology class

getOntologyInstance

public jade.content.onto.Ontology getOntologyInstance()

This Method returns the instance of the current Ontology-Class.

Returns:

The instance of the ontology

getOntologyTree

public OntologyClassTree getOntologyTree()

Provides the @link OntologyClassTree - Object.

Returns:

the projectOntologieTree

setOntologyVocabulary

public void setOntologyVocabulary(java.lang.Class<?> Class)

Sets the ontology vocabulary.

Parameters:

Class - the new ontology vocabulary

getVocabularyValue

public java.lang.String getVocabularyValue(java.lang.String key)

Provides a value from the ontology vocabulary, given by its public static name.

Parameters:

key - The public static name

Returns:

The Value of the public static variable

setOntologyMainClass

public void setOntologyMainClass(java.lang.String currOntoMainClass)

Sets the ontology main class.

Parameters:

currOntoMainClass - the currOntoMainClass to set

getOntologyMainClass

public java.lang.String getOntologyMainClass()

Gets the ontology main class.

Returns:

the currOntoMainClass

setOntologySourcePackage

public void setOntologySourcePackage(java.lang.String ontologySourcePackage)

Sets the ontology source package.

Parameters:

ontologySourcePackage - the currOntologySrcPackage to set

getOntologySourcePackage

public java.lang.String getOntologySourcePackage()

Gets the ontology source package.

Returns:

the currOntologySrcPackage

setOntologyName

public void setOntologyName(java.lang.String currOntoName)

Sets the ontology name.

Parameters:

currOntoName - the currOntoName to set

getOntologyName

public java.lang.String getOntologyName()

Gets the ontology name.

Returns:

the currOntoName