net.sf.okapi.lib.extra.pipelinebuilder

Class XPipeline

java.lang.Object

net.sf.okapi.common.pipeline.Pipeline

net.sf.okapi.lib.extra.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

Methods

Modifier and Type	Method and Description
void	addObserver(IObserver observer)
int	countObservers()
void	deleteObserver(IObserver observer)
void	deleteObservers()
PipelineReturnValue	execute()
XBatch	getBatch()
String	getDescription()
String	getHelpLocation()
String	getName()
List<IObserver>	getObservers()
IParameters	getParameters()
Event	handleEvent(Event event)
boolean	isDone()
boolean	isLastOutputStep()
void	notifyObservers()
void	notifyObservers(Object arg)
void	setBatch(XBatch batch)
void	setLastOutputStep(boolean isLastStep)
void	setParameters(IParameters params)
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

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()

Specified by:

getHelpLocation in interface IPipelineStep

getName

public String getName()

Specified by:

getName in interface IPipelineStep

getParameters

public IParameters getParameters()

Specified by:

getParameters in interface IPipelineStep

handleEvent

public Event handleEvent(Event event)

Specified by:

handleEvent in interface IPipelineStep

isDone

public boolean isDone()

Specified by:

isDone in interface IPipelineStep

isLastOutputStep

public boolean isLastOutputStep()

Specified by:

isLastOutputStep in interface IPipelineStep

setLastOutputStep

public void setLastOutputStep(boolean isLastStep)

Specified by:

setLastOutputStep in interface IPipelineStep

setParameters

public void setParameters(IParameters params)

Specified by:

setParameters in interface IPipelineStep

getBatch

public XBatch getBatch()

setBatch

public void setBatch(XBatch batch)

getDescription

public String getDescription()

Specified by:

getDescription in interface IPipelineStep

addObserver

public void addObserver(IObserver observer)

Specified by:

addObserver in interface IObservable

Overrides:

addObserver in class Pipeline

countObservers

public int countObservers()

Specified by:

countObservers in interface IObservable

Overrides:

countObservers in class Pipeline

deleteObserver

public void deleteObserver(IObserver observer)

Specified by:

deleteObserver in interface IObservable

Overrides:

deleteObserver in class Pipeline

notifyObservers

public void notifyObservers()

Specified by:

notifyObservers in interface IObservable

Overrides:

notifyObservers in class Pipeline

notifyObservers

public void notifyObservers(Object arg)

Specified by:

notifyObservers in interface IObservable

Overrides:

notifyObservers in class Pipeline

deleteObservers

public void deleteObservers()

Specified by:

deleteObservers in interface IObservable

Overrides:

deleteObservers in class Pipeline

getObservers

public List<IObserver> getObservers()

Specified by:

getObservers in interface IObservable

Overrides:

getObservers in class Pipeline