JADE_SL.onto
Interface Introspector

All Known Implementing Classes:

BasicIntrospector, BCReflectiveIntrospector, MicroIntrospector, ReflectiveIntrospector

public interface Introspector

Author:

Federico Bergenti - Universita` di Parma

Method Summary

void	checkClass(ObjectSchema schema, java.lang.Class javaClass) Check the structure of a java class associated to an ontological element to ensure that translations to/from abstract descriptors and java objects (instances of that class) can be accomplished by this introspector.
AbsObject	externalise(Ontology onto, Ontology referenceOnto, java.lang.Object obj) Translate an object of a class representing an element in an ontology into a proper abstract descriptor
java.lang.Object	internalise(Ontology onto, Ontology referenceOnto, AbsObject abs) Translate an abstract descriptor into an object of a proper class representing an element in an ontology

Method Detail

externalise

public AbsObject externalise(Ontology onto,
                             Ontology referenceOnto,
                             java.lang.Object obj)
                      throws UnknownSchemaException,
                             OntologyException

Translate an object of a class representing an element in an ontology into a proper abstract descriptor

Parameters:

onto - The ontology that uses this Introspector.

referenceOnto - The reference ontology in the context of this translation i.e. the most extended ontology that extends onto (directly or indirectly).

obj - The Object to be translated

Returns:

The Abstract descriptor produced by the translation

Throws:

UnknownSchemaException - If no schema for the object to be translated is defined in the ontology that uses this Introspector

OntologyException - If some error occurs during the translation

internalise

public java.lang.Object internalise(Ontology onto,
                                    Ontology referenceOnto,
                                    AbsObject abs)
                             throws UngroundedException,
                                    UnknownSchemaException,
                                    OntologyException

Translate an abstract descriptor into an object of a proper class representing an element in an ontology

Parameters:

onto - The ontology that uses this Introspector.

referenceOnto - The reference ontology in the context of this translation i.e. the most extended ontology that extends onto (directly or indirectly).

abs - The abstract descriptor to be translated

Returns:

The Java object produced by the translation

Throws:

UngroundedException - If the abstract descriptor to be translated contains a variable

UnknownSchemaException - If no schema for the abstract descriptor to be translated is defined in the ontology that uses this Introspector

OntologyException - If some error occurs during the translation

checkClass

public void checkClass(ObjectSchema schema,
                       java.lang.Class javaClass)
                throws OntologyException

Check the structure of a java class associated to an ontological element to ensure that translations to/from abstract descriptors and java objects (instances of that class) can be accomplished by this introspector.

Parameters:

schema - The schema of the ontological element

javaClass - The java class associated to the ontologcal element

Throws:

OntologyException - if the java class does not have the correct structure