net.sf.okapi.steps.xliffsplitter

Class XliffSplitterStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.steps.xliffsplitter.XliffSplitterStep

All Implemented Interfaces:

IPipelineStep

public class XliffSplitterStep
extends BasePipelineStep

Splits a single XLIFF file into multiple files, split on the file element. All other content (outside the file element) is copied as-is to each split file. Expects a RawDocument as input and sends the RawDocument Event unaltered. Will output multiple split XLIFF files in the set output path. An XLIFF file with only one file element is written out unaltered.

Author:

Greg Perkins, HargraveJE

Constructor Summary

Constructors

Constructor and Description
XliffSplitterStep()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Gets a short localizable description of what this step does.
String	getName() Gets the localizable name of this step.
URI	getOutputURI()
XliffSplitterParameters	getParameters() Gets the current parameters for this step.
protected Event	handleRawDocument(Event event) Handles the EventType.RAW_DOCUMENT event.
protected Event	handleStartBatch(Event event) Handles the EventType.START_BATCH event.
protected Event	handleStartBatchItem(Event event) Handles the EventType.START_BATCH_ITEM event.
boolean	isDone() Steps that can generate Events such as IFilters return false until no more events can be created.
void	setOutputURI(URI outputURI)
void	setParameters(IParameters params) Sets new parameters for this step.

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

cancel, destroy, getHelpLocation, getSourceLocale, getTargetLocale, handleCustom, handleDocumentPart, handleEndBatch, handleEndBatchItem, handleEndDocument, handleEndGroup, handleEndSubDocument, handleEndSubfilter, handleEvent, handleMultiEvent, handlePipelineParameters, handleStartDocument, handleStartGroup, handleStartSubDocument, handleStartSubfilter, handleTextUnit, isLastOutputStep, setLastOutputStep, setSourceLocale, setTargetLocale

Methods inherited from class java.lang.Object

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

Constructor Detail

XliffSplitterStep

public XliffSplitterStep()

Method Detail

setOutputURI

public void setOutputURI(URI outputURI)

getOutputURI

public URI getOutputURI()

getDescription

public String getDescription()

Description copied from interface: IPipelineStep

Gets a short localizable description of what this step does.

Returns:

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

getName

public String getName()

Description copied from interface: IPipelineStep

Gets the localizable name of this step.

Returns:

the localizable name of this step.

getParameters

public XliffSplitterParameters getParameters()

Description copied from interface: IPipelineStep

Gets the current parameters for this step.

Specified by:

getParameters in interface IPipelineStep

Overrides:

getParameters in class BasePipelineStep

Returns:

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

setParameters

public void setParameters(IParameters params)

Description copied from interface: IPipelineStep

Sets new parameters for this step.

Specified by:

setParameters in interface IPipelineStep

Overrides:

setParameters in class BasePipelineStep

Parameters:

params - the new parameters to use.

handleStartBatch

protected Event handleStartBatch(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.START_BATCH event.

Overrides:

handleStartBatch in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

handleStartBatchItem

protected Event handleStartBatchItem(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.START_BATCH_ITEM event.

Overrides:

handleStartBatchItem in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

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

Overrides:

isDone in class BasePipelineStep

Returns:

false if can generate more events, true otherwise.

handleRawDocument

protected Event handleRawDocument(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.RAW_DOCUMENT event.

Overrides:

handleRawDocument in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.