Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.ui.service.instance
Interface InstanceService

All Superinterfaces:
InstanceResolver
All Known Implementing Classes:
AbstractInstanceService, OrientInstanceService

public interface InstanceService
extends InstanceResolver

The InstanceService provides Instances from different data sets, e.g. the DataSet.SOURCE and DataSet.TRANSFORMED data sets. It also triggers the transformation of the source to the target data set.

Author:
Thorsten Reitz, Simon Templer

Field Summary
static String ACTION_READ_SOURCEDATA
          The action id used for reading source data.
 
Method Summary
 void addListener(InstanceServiceListener listener)
          Adds an instance service listener
 void addSourceInstances(InstanceCollection sourceInstances)
          Add instances to the DataSet.SOURCE data set
 void clearInstances()
          This will remove all instances from the service.
 InstanceCollection getInstances(DataSet dataset)
          Get the instances from the given data set
 Set<TypeDefinition> getInstanceTypes(DataSet dataset)
          Get the types for which instances are present in the given data set
 boolean isTransformationEnabled()
          Get if live transformation of source data is enabled.
 void removeListener(InstanceServiceListener listener)
          Removes an instance service listener
 void setTransformationEnabled(boolean enabled)
          Set if live transformation of source data is enabled.
 
Methods inherited from interface eu.esdihumboldt.hale.common.instance.model.InstanceResolver
getInstance, getReference
 

Field Detail

ACTION_READ_SOURCEDATA

static final String ACTION_READ_SOURCEDATA
The action id used for reading source data.

See Also:
Constant Field Values
Method Detail

getInstances

InstanceCollection getInstances(DataSet dataset)
Get the instances from the given data set

Parameters:
dataset - the data set
Returns:
the instance collection

getInstanceTypes

Set<TypeDefinition> getInstanceTypes(DataSet dataset)
Get the types for which instances are present in the given data set

Parameters:
dataset - the data set
Returns:
the set of types for which instances are present

addSourceInstances

void addSourceInstances(InstanceCollection sourceInstances)
Add instances to the DataSet.SOURCE data set

Parameters:
sourceInstances - the instances to add

setTransformationEnabled

void setTransformationEnabled(boolean enabled)
Set if live transformation of source data is enabled.

Parameters:
enabled - if transformation is enabled

isTransformationEnabled

boolean isTransformationEnabled()
Get if live transformation of source data is enabled.

Returns:
if live transformation is enabled

clearInstances

void clearInstances()
This will remove all instances from the service.


addListener

void addListener(InstanceServiceListener listener)
Adds an instance service listener

Parameters:
listener - the listener to add

removeListener

void removeListener(InstanceServiceListener listener)
Removes an instance service listener

Parameters:
listener - the listener to remove

Humboldt Alignment Editor 2.5.0

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