Package net.sf.okapi.filters.xliff

Class XLIFFFilter

java.lang.Object

net.sf.okapi.filters.xliff.XLIFFFilter

All Implemented Interfaces:

AutoCloseable, Iterator<Event>, IFilter

public class XLIFFFilter
extends Object
implements IFilter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XLIFFFilter.State

Field Summary

Fields

Modifier and Type	Field	Description
static String	CDATA_END
static String	CDATA_START
static String	EXACT_MATCH
static String	FUZZY_MATCH
static String	ID_MATCH
static String	LEVERAGED_INHERITED
static String	LEVERAGED_MT
static String	LEVERAGED_TM
static String	MT_SUGGESTION
static String	PROP_BUILDNUM
static String	PROP_EXTRADATA
static String	PROP_REPETITION
static String	PROP_WASSEGMENTED
static String	PROP_XLIFF_FLAVOR	On StartDocument to indicate that the "flavor" of the document is possible
static String	STATE_QUALIFIER
static String	TM_SUGGESTION
static String	XLIFF_FLAVOR_DEFAULT
static String	XLIFF_FLAVOR_SDLXLIFF
static String	XLIFF_FLAVOR_XTM

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

SUB_FILTER

Constructor Summary

Constructors

Constructor	Description
XLIFFFilter()

Method Summary

Modifier and Type	Method	Description
String	buildStartCode(XMLStreamReader reader)
void	cancel()	Cancels the current process.
void	close()	Closes the input document.
IFilterWriter	createFilterWriter()	Creates a new IFilterWriter object from the most appropriate class to use with this filter.
ISkeletonWriter	createSkeletonWriter()	Creates a new ISkeletonWriter object that corresponds to the type of skeleton this filter uses.
InputStreamReader	createStreamReader(RawDocument input, String charset)
String	fixSdlSpaceInId(String id)	Converts an ID to a format where the space is represented as _x0020_, as used in the XLIFF mid attribute.
ITSAnnotatorsRefContext	getAnnotatorsRefContext()	Gets the ITS annotators references context object.
List<FilterConfiguration>	getConfigurations()	Gets the list of all predefined configurations for this filter.
SdlFileInfo	getCurrentSdlFileInfo()
LocaleId	getCurrentSourceLocale()
LocaleId	getCurrentTargetLocale()
String	getDisplayName()	Gets the localizable display name of this filter.
EncoderManager	getEncoderManager()	Gets the EncoderManager object for this filter.
String	getMimeType()	Gets the MIME type of the format supported by this filter.
String	getName()	Gets the name/identifier of this filter.
Parameters	getParameters()	Gets the current parameters for this filter.
boolean	hasNext()	Indicates if there is an event to process.
Event	next()	Gets the next event available.
void	open(RawDocument input)	Opens the input document described in a give RawDocument object.
void	open(RawDocument input, boolean generateSkeleton)	Opens the input document described in a give RawDocument object, and optionally creates skeleton information.
void	open(RawDocument input, boolean generateSkeleton, IITSDataStore datastore)	Opens the input document described in a give RawDocument object, optionally creates skeleton information, and set the default data store to use to harvest ITS standoff annotations.
List<Object>	processSub(XMLStreamReader reader)	Process the content of a sub element.
void	setFilterConfigurationMapper(IFilterConfigurationMapper filterConfigurationMapper)	Sets the filter configuration mapper for this filter.
void	setParameters(IParameters params)	Sets new parameters for this filter.

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

isMultilingual, stream

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Detail

PROP_BUILDNUM

public static final String PROP_BUILDNUM

See Also:

Constant Field Values

PROP_EXTRADATA

public static final String PROP_EXTRADATA

See Also:

Constant Field Values

PROP_WASSEGMENTED

public static final String PROP_WASSEGMENTED

See Also:

Constant Field Values

PROP_REPETITION

public static final String PROP_REPETITION

See Also:

Constant Field Values

PROP_XLIFF_FLAVOR

public static final String PROP_XLIFF_FLAVOR

On StartDocument to indicate that the "flavor" of the document is possible

See Also:

Constant Field Values

XLIFF_FLAVOR_DEFAULT

public static final String XLIFF_FLAVOR_DEFAULT

See Also:

Constant Field Values

XLIFF_FLAVOR_SDLXLIFF

public static final String XLIFF_FLAVOR_SDLXLIFF

See Also:

Constant Field Values

XLIFF_FLAVOR_XTM

public static final String XLIFF_FLAVOR_XTM

See Also:

Constant Field Values

EXACT_MATCH

public static final String EXACT_MATCH

See Also:

Constant Field Values

FUZZY_MATCH

public static final String FUZZY_MATCH

See Also:

Constant Field Values

ID_MATCH

public static final String ID_MATCH

See Also:

Constant Field Values

LEVERAGED_MT

public static final String LEVERAGED_MT

See Also:

Constant Field Values

LEVERAGED_TM

public static final String LEVERAGED_TM

See Also:

Constant Field Values

MT_SUGGESTION

public static final String MT_SUGGESTION

See Also:

Constant Field Values

TM_SUGGESTION

public static final String TM_SUGGESTION

See Also:

Constant Field Values

LEVERAGED_INHERITED

public static final String LEVERAGED_INHERITED

See Also:

Constant Field Values

STATE_QUALIFIER

public static final String STATE_QUALIFIER

See Also:

Constant Field Values

CDATA_START

public static final String CDATA_START

See Also:

Constant Field Values

CDATA_END

public static final String CDATA_END

See Also:

Constant Field Values

Constructor Detail

XLIFFFilter

public XLIFFFilter()

Method Detail

cancel

public void cancel()

Description copied from interface: IFilter

Cancels the current process.

Specified by:

cancel in interface IFilter

close

public void close()

Description copied from interface: IFilter

Closes the input document. Developers should call this method from within their code before sending the last event: This can allow writer objects to overwrite the input file when they receive the last event. This method must also be safe to call even if the input document is not opened.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IFilter

getName

public String getName()

Description copied from interface: IFilter

Gets the name/identifier of this filter.

Specified by:

getName in interface IFilter

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

Returns:

the localizable display name of this filter.

getMimeType

public String getMimeType()

Description copied from interface: IFilter

Gets the MIME type of the format supported by this filter.

Specified by:

getMimeType in interface IFilter

Returns:

The MIME type of the format supported by 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

Returns:

a list of the all predefined configurations for this filter.

getEncoderManager

public EncoderManager getEncoderManager()

Description copied from interface: IFilter

Gets the EncoderManager object for this filter. This encoder manager should provided the mappings to the different MIME types used by the filter.

Specified by:

getEncoderManager in interface IFilter

Returns:

the EncoderManager for this filter.

getParameters

public Parameters getParameters()

Description copied from interface: IFilter

Gets the current parameters for this filter.

Specified by:

getParameters in interface IFilter

Returns:

The current parameters for this filter, or DefaultParameters if this filter has no parameters.

hasNext

public boolean hasNext()

Description copied from interface: IFilter

Indicates if there is an event to process.

Implementer Note: The caller must be able to call this method several times without changing state.

Specified by:

hasNext in interface IFilter

Specified by:

hasNext in interface Iterator<Event>

Returns:

True if there is at least one event to process, false if not.

getCurrentSourceLocale

public LocaleId getCurrentSourceLocale()

getCurrentTargetLocale

public LocaleId getCurrentTargetLocale()

getCurrentSdlFileInfo

public SdlFileInfo getCurrentSdlFileInfo()

next

public Event next()

Description copied from interface: IFilter

Gets the next event available. Calling this method can be done only once on each event.

Specified by:

next in interface IFilter

Specified by:

next in interface Iterator<Event>

Returns:

The next event available or null if there are no events.

open

public void open(RawDocument input)

Description copied from interface: IFilter

Opens the input document described in a give RawDocument object. Skeleton information is always created when you use this method.

Specified by:

open in interface IFilter

Parameters:

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

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

Parameters:

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

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

open

public void open(RawDocument input,
                 boolean generateSkeleton,
                 IITSDataStore datastore)

Opens the input document described in a give RawDocument object, optionally creates skeleton information, and set the default data store to use to harvest ITS standoff annotations.

Parameters:

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

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

datastore - the data store to use for the ITS standoff annotations (cannot be null).

setFilterConfigurationMapper

public void setFilterConfigurationMapper(IFilterConfigurationMapper filterConfigurationMapper)

Description copied from interface: IFilter

Sets the filter configuration mapper for this filter. This object is used by this filter if it needs to instantiate sub-filters. The implementations of IFilter that do not use sub-filters can use an empty stub for this method.

Specified by:

setFilterConfigurationMapper in interface IFilter

Parameters:

filterConfigurationMapper - the mapper to set.

setParameters

public void setParameters(IParameters params)

Description copied from interface: IFilter

Sets new parameters for this filter.

Specified by:

setParameters in interface IFilter

Parameters:

params - The new parameters to use.

createSkeletonWriter

public ISkeletonWriter createSkeletonWriter()

Description copied from interface: IFilter

Creates a new ISkeletonWriter object that corresponds to the type of skeleton this filter uses.

Specified by:

createSkeletonWriter in interface IFilter

Returns:

A new instance of ISkeletonWriter for the type of skeleton this filter uses.

createFilterWriter

public IFilterWriter createFilterWriter()

Description copied from interface: IFilter

Creates a new IFilterWriter object from the most appropriate class to use with this filter.

Specified by:

createFilterWriter in interface IFilter

Returns:

A new instance of IFilterWriter for the preferred implementation for this filter.

createStreamReader

public InputStreamReader createStreamReader(RawDocument input,
                                            String charset)

fixSdlSpaceInId

public String fixSdlSpaceInId(String id)

Converts an ID to a format where the space is represented as _x0020_, as used in the XLIFF mid attribute. See issue 1111. Fix for SDLXLIFF split-segments: they are represented as "123 a" in the SDL properties, but "123_x0020_a" in the XLIFF segment.

Parameters:

id - the ID to convert.

Returns:

the ID converted.

buildStartCode

public String buildStartCode(XMLStreamReader reader)

processSub

public List<Object> processSub(XMLStreamReader reader)
                        throws XMLStreamException

Process the content of a sub element. It assumes the content is valid.

Parameters:

reader - - XmlStreamReader passed in. We assume

Returns:

a list of strings and codes corresponding to the text/code chunks processed.

Throws:

XMLStreamException - if a read error occurs.

getAnnotatorsRefContext

public ITSAnnotatorsRefContext getAnnotatorsRefContext()

Gets the ITS annotators references context object.

Returns:

the ITS annotators references context object.