jade.content.onto

Class BasicOntology

java.lang.Object

jade.content.onto.Ontology

jade.content.onto.BasicOntology

All Implemented Interfaces:

SL0Vocabulary, Serializable

public class BasicOntology
extends Ontology
implements SL0Vocabulary

This class implements an ontology containing schemas for Primitive types and SL0 operators i.e. basic ontological elements required for minimal agent interaction. Users should always extend this ontology when defining their ontologies.

Author:

Federico Bergenti - Universita` di Parma, Giovanni Caire - TILAB

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	BOOLEAN
static String	BYTE_SEQUENCE
static String	CONTENT_ELEMENT_LIST
static String	DATE
static String	FLOAT
static String	INTEGER
private Map	primitiveSchemas
static String	STRING
private static BasicOntology	theInstance

Fields inherited from interface jade.content.lang.sl.SL0Vocabulary

ACLMSG, ACLMSG_BYTE_SEQUENCE_CONTENT, ACLMSG_CONTENT, ACLMSG_CONVERSATION_ID, ACLMSG_ENCODING, ACLMSG_IN_REPLY_TO, ACLMSG_LANGUAGE, ACLMSG_ONTOLOGY, ACLMSG_PERFORMATIVE, ACLMSG_PROTOCOL, ACLMSG_RECEIVERS, ACLMSG_REPLY_BY, ACLMSG_REPLY_TO, ACLMSG_REPLY_WITH, ACLMSG_SENDER, ACTION, ACTION_ACTION, ACTION_ACTOR, AID, AID_ADDRESSES, AID_NAME, AID_RESOLVERS, DONE, DONE_ACTION, DONE_CONDITION, EQUALS, EQUALS_LEFT, EQUALS_RIGHT, FALSE_PROPOSITION, RESULT, RESULT_ACTION, RESULT_ITEMS, RESULT_VALUE, SEQUENCE, SET, TRUE_PROPOSITION

Constructor Summary

Constructors

Modifier	Constructor and Description
private	BasicOntology() Constructor

Method Summary

Modifier and Type	Method and Description
static Object	adjustPrimitiveValue(Object srcValue, Class destClass) Convert, if possible, the numeric value srcValue into an instance of destClass
private ObjectSchema	createMsgSchema(String performative) Note that we don't want to keep 22 different schemas for the 22 FIPA communicative acts --> We generate the schemas for communicative acts on the fly as needed.
private void	fillPrimitiveSchemas()
protected AbsObject	fromObject(Object obj, Ontology referenceOnto) This method is redefined as BasicOntology does not use an Introspector for performance reason
static Ontology	getInstance() Returns the singleton instance of the BasicOntology.
ObjectSchema	getSchema(Class clazz) Redefine the getSchema() method to take into account java primitives.
ObjectSchema	getSchema(String name) Redefine the getSchema() method to take into account ACL performatives.
private void	initialize()
private void	readObject(ObjectInputStream in)
static Object	resolveNumericValue(Object srcValue, Class destClass) Deprecated. Use adjustPrimitiveValue() instead
protected Object	toObject(AbsObject abs, String lcType, Ontology referenceOnto) This method is redefined as BasicOntology does not use an Introspector for performance reason

Methods inherited from class jade.content.onto.Ontology

add, add, checkIsTerm, createConceptSlotFunction, externalize, externalizeSlotValue, fromObject, getActionNames, getClassForElement, getConceptNames, getIntrospector, getName, getOwnActionNames, getOwnConceptNames, getOwnPredicateNames, getPredicateNames, getSlotValue, internalize, internalizeSlotValue, setSlotValue, toObject, toString, useConceptSlotsAsFunctions

Methods inherited from class java.lang.Object

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

Field Detail

theInstance

private static final BasicOntology theInstance

STRING

public static final String STRING

See Also:

Constant Field Values

FLOAT

public static final String FLOAT

See Also:

Constant Field Values

INTEGER

public static final String INTEGER

See Also:

Constant Field Values

BOOLEAN

public static final String BOOLEAN

See Also:

Constant Field Values

DATE

public static final String DATE

See Also:

Constant Field Values

BYTE_SEQUENCE

public static final String BYTE_SEQUENCE

See Also:

Constant Field Values

CONTENT_ELEMENT_LIST

public static final String CONTENT_ELEMENT_LIST

See Also:

Constant Field Values

primitiveSchemas

private transient Map primitiveSchemas

Constructor Detail

BasicOntology

private BasicOntology()

Constructor

Method Detail

initialize

private void initialize()

fillPrimitiveSchemas

private void fillPrimitiveSchemas()
                           throws OntologyException

Throws:

OntologyException

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException

Throws:

IOException

ClassNotFoundException

getInstance

public static Ontology getInstance()

Returns the singleton instance of the BasicOntology.

Returns:

the singleton instance of the BasicOntology

toObject

protected Object toObject(AbsObject abs,
                          String lcType,
                          Ontology referenceOnto)
                   throws UngroundedException,
                          OntologyException

This method is redefined as BasicOntology does not use an Introspector for performance reason

Overrides:

toObject in class Ontology

Parameters:

abs - the abstract descriptor.

lcType - the type of the abstract descriptor to be translated aconverted into lower case. This is passed as parameters to avoid making the conversion to lower case for each base ontology.

referenceOnto - The ontology this ontology is part of (i.e. the ontology that extends this ontology).

Returns:

the object

Throws:

UngroundedException - if the abstract descriptor contains a variable

UnknownSchemaException - If no schema for the abs descriptor to be translated is defined in this ontology.

OntologyException - if some mismatch with the schema is found * ontology. In this case UnknownSchema

See Also:

Ontology.toObject(AbsObject)

fromObject

protected AbsObject fromObject(Object obj,
                               Ontology referenceOnto)
                        throws OntologyException

This method is redefined as BasicOntology does not use an Introspector for performance reason

Overrides:

fromObject in class Ontology

Parameters:

obj - the object

referenceOnto - The ontology this ontology is part of (i.e. the ontology that extends this ontology).

Returns:

the abstract descriptor.

Throws:

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

OntologyException - if some mismatch with the schema is found

See Also:

Ontology.toObject(AbsObject)

getSchema

public ObjectSchema getSchema(String name)
                       throws OntologyException

Redefine the getSchema() method to take into account ACL performatives.

Overrides:

getSchema in class Ontology

Parameters:

name - the name of the schema in the vocabulary.

Returns:

the schema or null if the schema is not found.

Throws:

OntologyException

getSchema

public ObjectSchema getSchema(Class clazz)
                       throws OntologyException

Redefine the getSchema() method to take into account java primitives.

Overrides:

getSchema in class Ontology

Parameters:

clazz - the class whose associated schema must be retrieved.

Returns:

the schema associated to the given class or null if the schema is not found.

Throws:

OntologyException

createMsgSchema

private ObjectSchema createMsgSchema(String performative)
                              throws OntologyException

Note that we don't want to keep 22 different schemas for the 22 FIPA communicative acts --> We generate the schemas for communicative acts on the fly as needed.

Throws:

OntologyException

adjustPrimitiveValue

public static Object adjustPrimitiveValue(Object srcValue,
                                          Class destClass)

Convert, if possible, the numeric value srcValue into an instance of destClass

resolveNumericValue

public static Object resolveNumericValue(Object srcValue,
                                         Class destClass)

Deprecated. Use adjustPrimitiveValue() instead