ensemble.processing
Class Processor

java.lang.Object
  ensemble.processing.Processor

All Implemented Interfaces:

LifeCycle

public abstract class Processor
extends java.lang.Object
implements LifeCycle

The Class Processor.

Field Summary

protected Parameters

parameters The parameters.

Constructor Summary

Processor()

Method Summary

boolean	configure() User-implemented method that configures the component, setting up user parameters and essential properties.
Parameters	getParameters() Returns all configured parameters.
boolean	parameterUpdate(java.lang.String name, java.lang.String newValue) User-implement method called when a parameter has been updated.
abstract java.lang.Object	process(Parameters parameters, java.lang.Object in) Process method.
void	setParameters(Parameters parameters) Framework-implemented method that sets system and user parameters.
boolean	start() Framework-implemented initialization method.
boolean	stop() Framework-implemented finalization method.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ensemble.LifeCycle

finit, init

Field Detail

parameters

protected Parameters parameters

The parameters.

Constructor Detail

Processor

public Processor()

Method Detail

setParameters

public void setParameters(Parameters parameters)

Description copied from interface: LifeCycle

Framework-implemented method that sets system and user parameters.

Specified by:

setParameters in interface LifeCycle

Parameters:

parameters - a Parameters object with all user and system Parameters for this object

getParameters

public Parameters getParameters()

Description copied from interface: LifeCycle

Returns all configured parameters.

Specified by:

getParameters in interface LifeCycle

Returns:

a Parameters object with system and user parameters

configure

public boolean configure()

Description copied from interface: LifeCycle

User-implemented method that configures the component, setting up user parameters and essential properties.

Specified by:

configure in interface LifeCycle

Returns:

true, if successful

start

public boolean start()

Description copied from interface: LifeCycle

Framework-implemented initialization method.

Specified by:

start in interface LifeCycle

Returns:

true, if successful

stop

public boolean stop()

Description copied from interface: LifeCycle

Framework-implemented finalization method.

Specified by:

stop in interface LifeCycle

Returns:

true, if successful

parameterUpdate

public boolean parameterUpdate(java.lang.String name,
                               java.lang.String newValue)

Description copied from interface: LifeCycle

User-implement method called when a parameter has been updated.

Specified by:

parameterUpdate in interface LifeCycle

Parameters:

name - the name

newValue - the new value

Returns:

true, if successful

process

public abstract java.lang.Object process(Parameters parameters,
                                         java.lang.Object in)

Process method.

Parameters:

parameters - the parameters

in - the in

Returns:

the object