net.sf.okapi.filters.sdlpackage

Class SdlPackageFilter

java.lang.Object

net.sf.okapi.common.filters.AbstractFilter

net.sf.okapi.filters.archive.ArchiveFilter

net.sf.okapi.filters.sdlpackage.SdlPackageFilter

All Implemented Interfaces:

AutoCloseable, Iterator<Event>, IFilter

public class SdlPackageFilter
extends ArchiveFilter

Implements the IFilter interface for SDLPPX and SDLRPX files. This is written on top of the ArchiveFilter class. The entries generated are the ones from the .sdlxliff files in the sub-folder that is named for the target language.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MIME_TYPE

Fields inherited from interface net.sf.okapi.common.filters.IFilter

SUB_FILTER

Constructor Summary

Constructors

Constructor and Description
SdlPackageFilter()

Method Summary

Modifier and Type	Method and Description
List<FilterConfiguration>	getConfigurations() Gets the list of all predefined configurations for this filter.
String	getDisplayName() Gets the localizable display name of this filter.
String	getName() Gets the name/identifier of this filter.
void	open(RawDocument input, boolean generateSkeleton) Opens the input document described in a give RawDocument object, and optionally creates skeleton information.

Methods inherited from class net.sf.okapi.filters.archive.ArchiveFilter

cancel, close, createFilterWriter, createSkeletonWriter, getEncoderManager, getFilterConfigurationMapper, getMimeType, getParameters, hasNext, isUtf8Bom, isUtf8Encoding, next, open, setFilterConfigurationMapper, setParameters

Methods inherited from class net.sf.okapi.common.filters.AbstractFilter

addConfiguration, addConfiguration, addConfiguration, addConfigurations, createEndFilterEvent, createStartFilterEvent, findConfiguration, getConfiguration, getDocumentId, getDocumentName, getEncoding, getFilterWriter, getNewlineType, getParameters, getParametersClassName, getParentId, getSrcLoc, getTrgLoc, isCanceled, isGenerateSkeleton, isMultilingual, removeConfiguration, setDisplayName, setDocumentName, setEncoding, setFilterWriter, setGenerateSkeleton, setMimeType, setMultilingual, setName, setNewlineType, setOptions, setParentId, setSrcLoc, setTrgLoc

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.filters.IFilter

stream

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Detail

MIME_TYPE

public static final String MIME_TYPE

See Also:

Constant Field Values

Constructor Detail

SdlPackageFilter

public SdlPackageFilter()

Method Detail

getName

public String getName()

Description copied from interface: IFilter

Gets the name/identifier of this filter.

Specified by:

getName in interface IFilter

Overrides:

getName in class ArchiveFilter

Returns:

The name/identifier of the filter.

getDisplayName

public String getDisplayName()

Description copied from interface: IFilter

Gets the localizable display name of this filter.

Specified by:

getDisplayName in interface IFilter

Overrides:

getDisplayName in class ArchiveFilter

Returns:

the localizable display name of this filter.

getConfigurations

public List<FilterConfiguration> getConfigurations()

Description copied from interface: IFilter

Gets the list of all predefined configurations for this filter.

Specified by:

getConfigurations in interface IFilter

Overrides:

getConfigurations in class AbstractFilter

Returns:

a list of the all predefined configurations for this filter.

open

public void open(RawDocument input,
                 boolean generateSkeleton)

Description copied from interface: IFilter

Opens the input document described in a give RawDocument object, and optionally creates skeleton information.

Specified by:

open in interface IFilter

Overrides:

open in class ArchiveFilter

Parameters:

input - The RawDocument object to use to open the document.

generateSkeleton - true to generate the skeleton data, false otherwise.