jade.content.schema

Class VariableSchema

java.lang.Object

jade.content.schema.ObjectSchema

jade.content.schema.ObjectSchemaImpl

jade.content.schema.TermSchema

jade.content.schema.VariableSchema

All Implemented Interfaces:

Serializable

public class VariableSchema
extends TermSchema

This class represents the schema of a variable.

Author:

Federico Bergenti - Universita` di Parma

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_NAME
private static VariableSchema	baseSchema
static String	NAME
static String	VALUE_TYPE

Fields inherited from class jade.content.schema.ObjectSchemaImpl

RESULT_SLOT_NAME

Fields inherited from class jade.content.schema.ObjectSchema

encodingByOrder, MANDATORY, OPTIONAL, UNLIMITED

Constructor Summary

Constructors

Modifier	Constructor and Description
private	VariableSchema() Construct a schema that vinculates an entity to be a generic variable.

Method Summary

Modifier and Type	Method and Description
protected boolean	descendsFrom(ObjectSchema s) Return true if - s is the base schema for the XXXSchema class this schema is an instance of (e.g.
static ObjectSchema	getBaseSchema() Retrieve the generic base schema for all variables.
boolean	isCompatibleWith(ObjectSchema s) A variable can be put whereever a term of whatever type is required --> A VariableSchema is compatible with s if s descends from TermSchema.getBaseSchema()
AbsObject	newInstance() Creates an Abstract descriptor to hold a variable
void	validate(AbsObject abs, Ontology onto) Check whether a given abstract descriptor complies with this schema.

Methods inherited from class jade.content.schema.ObjectSchemaImpl

add, add, add, add, addFacet, addSuperSchema, containsSlot, equals, getAllFacets, getFacets, getNames, getOwnNames, getSchema, getSuperSchemas, getTypeName, isAssignableFrom, isMandatory, isOwnSlot, toString, validateSlots

Methods inherited from class jade.content.schema.ObjectSchema

getEncodingByOrder, setEncodingByOrder

Methods inherited from class java.lang.Object

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

Field Detail

BASE_NAME

public static final String BASE_NAME

See Also:

Constant Field Values

baseSchema

private static VariableSchema baseSchema

NAME

public static final String NAME

See Also:

Constant Field Values

VALUE_TYPE

public static final String VALUE_TYPE

See Also:

Constant Field Values

Constructor Detail

VariableSchema

private VariableSchema()

Construct a schema that vinculates an entity to be a generic variable. Note that there are no different types of variable as it happens for concepts (e.g. Person, Address...), IREs (e.g. IOTA, ANY, ALL...) and the like. Therefore there is no VariableSchema constructor that takes a String parameter. Not also that the type of the values that can be assumed by the variable is another story and is defined by the VARIABLE_VALUE_TYPE slot of the VariableSchema

Method Detail

getBaseSchema

public static ObjectSchema getBaseSchema()

Retrieve the generic base schema for all variables.

Returns:

the generic base schema for all variables.

newInstance

public AbsObject newInstance()
                      throws OntologyException

Creates an Abstract descriptor to hold a variable

Overrides:

newInstance in class TermSchema

Throws:

OntologyException

validate

public void validate(AbsObject abs,
                     Ontology onto)
              throws OntologyException

Check whether a given abstract descriptor complies with this schema.

Overrides:

validate in class ObjectSchemaImpl

Parameters:

abs - The abstract descriptor to be checked

Throws:

OntologyException - If the abstract descriptor does not complies with this schema

isCompatibleWith

public boolean isCompatibleWith(ObjectSchema s)

A variable can be put whereever a term of whatever type is required --> A VariableSchema is compatible with s if s descends from TermSchema.getBaseSchema()

Overrides:

isCompatibleWith in class ObjectSchemaImpl

descendsFrom

protected boolean descendsFrom(ObjectSchema s)

Return true if - s is the base schema for the XXXSchema class this schema is an instance of (e.g. s is ConceptSchema.getBaseSchema() and this schema is an instance of ConceptSchema) - s is the base schema for a super-class of the XXXSchema class this schema is an instance of (e.g. s is TermSchema.getBaseSchema() and this schema is an instance of ConceptSchema)

Overrides:

descendsFrom in class TermSchema