Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.common.instance.model
Interface Instance

All Superinterfaces:
Group
All Known Subinterfaces:
FamilyInstance, MutableInstance
All Known Implementing Classes:
DefaultInstance, FamilyInstanceImpl, InstanceDecorator, OInstance, StreamGmlInstance

public interface Instance
extends Group

Represents an instance of a type

Author:
Simon Templer
Partner:
01 / Fraunhofer Institute for Computer Graphics Research

Method Summary
 DataSet getDataSet()
          Get the data set the instance is associated to.
 TypeDefinition getDefinition()
          Get the definition of the type associated with the instance
 List<Object> getMetaData(String key)
          Get the metadata the instance my be associated with
 Set<String> getMetaDataNames()
          Get all keys the metadata is associated with
 Object getValue()
          Get the instance value.

The value is only present for certain types where the HasValueFlag or AugmentedValueFlag constraint is enabled.
 
Methods inherited from interface eu.esdihumboldt.hale.common.instance.model.Group
getProperty, getPropertyNames
 

Method Detail

getDefinition

TypeDefinition getDefinition()
Get the definition of the type associated with the instance

Specified by:
getDefinition in interface Group
Returns:
the instance's type definition

getValue

Object getValue()
Get the instance value.

The value is only present for certain types where the HasValueFlag or AugmentedValueFlag constraint is enabled. The Binding constraint on the type definition defines the binding of the value.

NOTE: This is needed for instance for XML elements with text content and attributes. It may only be a simple value (i.e. no Group or Instance).

Returns:
the instance value if it is defined, otherwise null

getDataSet

DataSet getDataSet()
Get the data set the instance is associated to.

Returns:
the instance data set, null if not set

getMetaData

List<Object> getMetaData(String key)
Get the metadata the instance my be associated with

Parameters:
key - the key to access a certain metadata
Returns:
A list of objects from the metadata, may be an empty List if the key can not be found or there is not metadata associated with the Instance

getMetaDataNames

Set<String> getMetaDataNames()
Get all keys the metadata is associated with

Returns:
an Set of String keys, or an empty Set if the data doesn't exist or the container is empty, the Set may not be changed

Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d