org.eclipse.higgins.idas.api.model
Interface IContextModel

All Superinterfaces:

IModel

public interface IContextModel

extends IModel

Represents a model of the context object as it defined in the context's ontology model. Since context's ontology model is defined in OWL DL format this interface is designed to simlify query and interpretation of the context's ontology model.

The URI returned by IModel.getType() could be used to retrieve an URL of the OWL ontology where this context's model is defined.

See Also:

IContext

Method Summary

IAttributeModel	getAttributeModel(URI attrID) Returns IAttributeModel for the specified attribute ID
Iterator	getAttributeModels() Returns IAttributeModels for the attributes which are defined (allowed) by this context's model.
IEntityModel	getEntityModel(URI entityType) Returns the IEntityModel for the specified entity type
Iterator	getEntityModels() Returns IEntityModels for the entities which are defined (allowed) in this context model.
IModel	getModel(URI type) Generic method to query context model for any kind of element matching the specified type.

Methods inherited from interface org.eclipse.higgins.idas.api.model.IModel

getDisplayData, getType

Method Detail

getModel

public IModel getModel(URI type)
                throws IdASException

Generic method to query context model for any kind of element matching the specified type. This could be the type of an entity, attribute, metadata, etc.

Parameters:

type - the type of the entity for which to retrieve the model.

Returns:

the model of the element specified by type or null if no element corresponding to that type is defined in this context model.

Throws:

IdASException

getEntityModels

public Iterator getEntityModels()
                         throws IdASException

Returns IEntityModels for the entities which are defined (allowed) in this context model.

Returns:

Iterator of IEntityModel

Throws:

IdASException

See Also:

IContext.getEntity(String), IContext.getEntities(IFilter)

getEntityModel

public IEntityModel getEntityModel(URI entityType)
                            throws IdASException

Returns the IEntityModel for the specified entity type

Parameters:

entityType -

Returns:

IEntityModel for the specified entity type

Throws:

IdASException

getAttributeModels

public Iterator getAttributeModels()
                            throws IdASException

Returns IAttributeModels for the attributes which are defined (allowed) by this context's model.

Returns:

Iterator of IAttributeModel

Throws:

IdASException

See Also:

IEntity.getAttributes()

getAttributeModel

public IAttributeModel getAttributeModel(URI attrID)
                                  throws IdASException

Returns IAttributeModel for the specified attribute ID

Parameters:

attrID - the ID of attribute.

Returns:

attribute's model of requested ID or null if the specified attrID is not defined or not valid for this context's model.

Throws:

IdASException