net.sf.okapi.common.pipelinebuilder

Class XPipeline

java.lang.Object

net.sf.okapi.common.pipeline.Pipeline

net.sf.okapi.common.pipelinebuilder.XPipeline

All Implemented Interfaces:

IObservable, IObserver, IPipeline, IPipelineStep

public class XPipeline
extends Pipeline
implements IPipelineStep

Field Summary

Fields inherited from class net.sf.okapi.common.pipeline.Pipeline

DEFAULT_ID

Constructor Summary

Constructors

Constructor and Description
XPipeline(String description, IPipeline pipeline)
XPipeline(String description, IPipelineStep... steps)
XPipeline(String description, XBatch batch, IPipelineStep... steps)
XPipeline(String description, XBatch batch, XPipelineType type, IPipelineStep... steps)
XPipeline(String description, XFilters filters, String rootDir, XBatch batch, IPipelineStep... steps)
XPipeline(String description, XFilters filters, XBatch batch, IPipelineStep... steps)
XPipeline(String description, XPipelineType type, IPipelineStep... steps)

Method Summary

Modifier and Type	Method and Description
void	addObserver(IObserver observer) Attaches a observer to the Observable.
int	countObservers() Counts how many Observers were attached to this class.
void	deleteObserver(IObserver observer) Detaches a previously attached observer to the observable.
void	deleteObservers() Detaches all previously attached observer to the observable.
PipelineReturnValue	execute()
XBatch	getBatch()
String	getDescription() Gets a short localizable description of what this step does.
String	getHelpLocation() Gets the relative directory location for the help of this step.
String	getName() Gets the localizable name of this step.
List<IObserver>	getObservers() Returns list of observers registered with the Observable.
IParameters	getParameters() Gets the current parameters for this step.
Event	handleEvent(Event event) Processes each event sent though the pipeline.
boolean	isDone() Steps that can generate Events such as IFilters return false until no more events can be created.
boolean	isLastOutputStep() Is this step the last step with output in the pipeline?
void	notifyObservers() Notifies all attached observers about changes in the observable.
void	notifyObservers(Object arg) Notifies all attached observers about changes in the observable.
void	setBatch(XBatch batch)
void	setLastOutputStep(boolean isLastStep) Tell the step if it is the last one on the pipeline with output.
void	setParameters(IParameters params) Sets new parameters for this step.
void	stop()

Methods inherited from class net.sf.okapi.common.pipeline.Pipeline

addStep, cancel, clearSteps, destroy, endBatch, getId, getState, getSteps, process, process, setId, startBatch, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.okapi.common.pipeline.IPipelineStep

cancel, destroy, getSourceLocale, getTargetLocale, setSourceLocale, setTargetLocale

Constructor Detail

XPipeline

public XPipeline(String description,
                 IPipeline pipeline)

XPipeline

public XPipeline(String description,
                 IPipelineStep... steps)

XPipeline

public XPipeline(String description,
                 XPipelineType type,
                 IPipelineStep... steps)

XPipeline

public XPipeline(String description,
                 XBatch batch,
                 IPipelineStep... steps)

XPipeline

public XPipeline(String description,
                 XFilters filters,
                 XBatch batch,
                 IPipelineStep... steps)

XPipeline

public XPipeline(String description,
                 XFilters filters,
                 String rootDir,
                 XBatch batch,
                 IPipelineStep... steps)

XPipeline

public XPipeline(String description,
                 XBatch batch,
                 XPipelineType type,
                 IPipelineStep... steps)

Method Detail

execute

public PipelineReturnValue execute()

stop

public void stop()

getHelpLocation

public String getHelpLocation()

Description copied from interface: IPipelineStep

Gets the relative directory location for the help of this step. The main help file for the step must be at that location and its name must be the name of the class implementing the step in lowercase with a .html extension.

Specified by:

getHelpLocation in interface IPipelineStep

Returns:

the relative directory location for the help of this step.

getName

public String getName()

Description copied from interface: IPipelineStep

Gets the localizable name of this step.

Specified by:

getName in interface IPipelineStep

Returns:

the localizable name of this step.

getParameters

public IParameters getParameters()

Description copied from interface: IPipelineStep

Gets the current parameters for this step.

Specified by:

getParameters in interface IPipelineStep

Returns:

the current parameters for this step or null if there are no parameters.

handleEvent

public Event handleEvent(Event event)

Description copied from interface: IPipelineStep

Processes each event sent though the pipeline.

Specified by:

handleEvent in interface IPipelineStep

Parameters:

event - the event to process.

Returns:

the event to pass down the pipeline.

isDone

public boolean isDone()

Description copied from interface: IPipelineStep

Steps that can generate Events such as IFilters return false until no more events can be created. Steps which do not create Events always return true.

Specified by:

isDone in interface IPipelineStep

Returns:

false if can generate more events, true otherwise.

isLastOutputStep

public boolean isLastOutputStep()

Description copied from interface: IPipelineStep

Is this step the last step with output in the pipeline?

Specified by:

isLastOutputStep in interface IPipelineStep

Returns:

true if last step with output, false otherwise.

setLastOutputStep

public void setLastOutputStep(boolean isLastStep)

Description copied from interface: IPipelineStep

Tell the step if it is the last one on the pipeline with output.

Specified by:

setLastOutputStep in interface IPipelineStep

Parameters:

isLastStep - true if last step with output, false otherwise.

setParameters

public void setParameters(IParameters params)

Description copied from interface: IPipelineStep

Sets new parameters for this step.

Specified by:

setParameters in interface IPipelineStep

Parameters:

params - the new parameters to use.

getBatch

public XBatch getBatch()

setBatch

public void setBatch(XBatch batch)

getDescription

public String getDescription()

Description copied from interface: IPipelineStep

Gets a short localizable description of what this step does.

Specified by:

getDescription in interface IPipelineStep

Returns:

the text of a short description of what this step does.

addObserver

public void addObserver(IObserver observer)

Description copied from interface: IObservable

Attaches a observer to the Observable. After attachment the observer gets informed about changes in the Observable.

Specified by:

addObserver in interface IObservable

Overrides:

addObserver in class Pipeline

Parameters:

observer - The observer to attach to the observable

countObservers

public int countObservers()

Description copied from interface: IObservable

Counts how many Observers were attached to this class.

Specified by:

countObservers in interface IObservable

Overrides:

countObservers in class Pipeline

Returns:

the number of Observers

See Also:

IObserver

deleteObserver

public void deleteObserver(IObserver observer)

Description copied from interface: IObservable

Detaches a previously attached observer to the observable. After detachment the observer does no longer receive change notifications from the observable.

Specified by:

deleteObserver in interface IObservable

Overrides:

deleteObserver in class Pipeline

Parameters:

observer - The observer to detach from the observable

notifyObservers

public void notifyObservers()

Description copied from interface: IObservable

Notifies all attached observers about changes in the observable.

Specified by:

notifyObservers in interface IObservable

Overrides:

notifyObservers in class Pipeline

notifyObservers

public void notifyObservers(Object arg)

Description copied from interface: IObservable

Notifies all attached observers about changes in the observable.

Specified by:

notifyObservers in interface IObservable

Overrides:

notifyObservers in class Pipeline

Parameters:

arg - an arbitrary Object to be passed to the Observer

deleteObservers

public void deleteObservers()

Description copied from interface: IObservable

Detaches all previously attached observer to the observable. After detachment observers do not longer receive change notifications from the observable.

Specified by:

deleteObservers in interface IObservable

Overrides:

deleteObservers in class Pipeline

getObservers

public List<IObserver> getObservers()

Description copied from interface: IObservable

Returns list of observers registered with the Observable. List returned is unmodifiable list.

Specified by:

getObservers in interface IObservable

Overrides:

getObservers in class Pipeline

Returns:

list of observers