Package com.aquima.interactions.metamodel.impl

Class InstanceDefinition

java.lang.Object

com.aquima.interactions.metamodel.impl.InstanceDefinition

All Implemented Interfaces:

IInstanceDefinition, Serializable

public class InstanceDefinition
extends Object
implements IInstanceDefinition

This class holds the definition of a static instance in the meta model.

Since:

5.0

Author:

O. Kerpershoek

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InstanceDefinition(MetaModel model, IInstanceDS datasource)

Method Summary

Modifier and Type	Method	Description
protected void	addReference(String attributeName, InstanceReference reference)
IEntityDefinition	getEntityDefinition()	This method will return the definition of the type of the instance.
GUID	getInstanceId()	This method returns the unique ID of the instance definition.
String	getInstanceName()	This method will return the name of instance.
IInstanceReference[]	getInstances(String attribute)	This method can be used to retrieve the reference definitions to determine which instances are referred by the specified attribute.
IValue	getValue(String attributeName)	This method can be used to retrieve a value of an attribute.
protected void	setValue(String attributeName, Object objValue)

Methods inherited from class java.lang.Object

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

Constructor Details

InstanceDefinition

protected InstanceDefinition(MetaModel model,
 IInstanceDS datasource)
                      throws InitializationException

Throws:

InitializationException

Method Details

addReference

protected void addReference(String attributeName,
 InstanceReference reference)
                     throws InitializationException

Throws:

InitializationException

setValue

protected void setValue(String attributeName,
 Object objValue)
                 throws InitializationException

Throws:

InitializationException

getInstanceId

public GUID getInstanceId()

Description copied from interface: IInstanceDefinition

This method returns the unique ID of the instance definition.

Specified by:

getInstanceId in interface IInstanceDefinition

Returns:

the unique ID of the instance definition.

getInstanceName

public String getInstanceName()

Description copied from interface: IInstanceDefinition

This method will return the name of instance. The name of an instance uniquely identifies an instance within all instances of the same type.

Specified by:

getInstanceName in interface IInstanceDefinition

Returns:

The name of the instance.

getEntityDefinition

public IEntityDefinition getEntityDefinition()

Description copied from interface: IInstanceDefinition

This method will return the definition of the type of the instance.

Specified by:

getEntityDefinition in interface IInstanceDefinition

Returns:

Entity definition of the instance.

getInstances

public IInstanceReference[] getInstances(String attribute)

Description copied from interface: IInstanceDefinition

This method can be used to retrieve the reference definitions to determine which instances are referred by the specified attribute. When the attribute does not refer to any instance, an empty array will be returned.

Specified by:

getInstances in interface IInstanceDefinition

Parameters:

attribute - The name of the attribute for which the references are requested.

Returns:

Array containing information about the instances that are referred by the specified attribute.

getValue

public IValue getValue(String attributeName)
                throws UnknownAttributeException

Description copied from interface: IInstanceDefinition

This method can be used to retrieve a value of an attribute. This method is only applicable for non-relation attributes. For relation attributes use the getInstances method to determine which instances are referred by the relation attribute.

Specified by:

getValue in interface IInstanceDefinition

Parameters:

attributeName - The name of the attribute for which the value is requested.

Returns:

The value for the specified attribute.

Throws:

UnknownAttributeException - This exception is raised when the attribute name passed to this method is invalid.