Package net.sf.okapi.filters.po

Class POWriter

java.lang.Object

net.sf.okapi.filters.po.POWriter

All Implemented Interfaces:

AutoCloseable, IFilterWriter

public class POWriter
extends Object
implements IFilterWriter

Implementation of IFilterWriter for PO. This class is not designed to be used with the PO Filter, but as a standalone writer that can be driven by filter events.

In extraction/merging mode the context line holds a trace of the current sub-document, group and text unit. okpctx: sd=ID:gp=ID:gp=ID...:tuID

Field Summary

Fields

Modifier and Type	Field	Description
static String	CRUMBS_PREFIX
static String	GROUP_CRUMB
static String	SUBDOCUMENT_CRUMB
static String	TEXTUNIT_CRUMB

Constructor Summary

Constructors

Constructor	Description
POWriter()

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancels the current process.
void	close()	Closes the output.
EncoderManager	getEncoderManager()	Gets the current encoder manager for this writer.
String	getName()	Gets the name of this writer.
Parameters	getParameters()	Gets the current parameters for this writer.
ISkeletonWriter	getSkeletonWriter()	Gets the skeleton writer associated with this writer.
Event	handleEvent(Event event)	Handles the filter events.
void	setMode(boolean forExtractMerge, boolean makePOT, boolean transFuzzy)	Sets the creation mode for this writer.
void	setOptions(LocaleId language, String defaultEncoding)	Sets the options for this writer.
void	setOutput(OutputStream output)	Sets the output through its output stream.
void	setOutput(String path)	Sets the output through the path of the output file.
void	setParameters(IParameters params)	Sets new parameters for this writer.

Methods inherited from class java.lang.Object

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

Field Detail

CRUMBS_PREFIX

public static final String CRUMBS_PREFIX

See Also:

Constant Field Values

SUBDOCUMENT_CRUMB

public static final String SUBDOCUMENT_CRUMB

See Also:

Constant Field Values

GROUP_CRUMB

public static final String GROUP_CRUMB

See Also:

Constant Field Values

TEXTUNIT_CRUMB

public static final String TEXTUNIT_CRUMB

See Also:

Constant Field Values

Constructor Detail

POWriter

public POWriter()

Method Detail

cancel

public void cancel()

Description copied from interface: IFilterWriter

Cancels the current process.

Specified by:

cancel in interface IFilterWriter

setMode

public void setMode(boolean forExtractMerge,
                    boolean makePOT,
                    boolean transFuzzy)

Sets the creation mode for this writer.

Parameters:

forExtractMerge - true to create a file that can be merged back into its original format.

makePOT - true to create a PO template file.

transFuzzy - true to set existing translations as fuzzy (only when forExtractMerge is true)

close

public void close()

Description copied from interface: IFilterWriter

Closes the output. Developers must make sure this method is safe to call even if there is nothing to close.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IFilterWriter

getName

public String getName()

Description copied from interface: IFilterWriter

Gets the name of this writer.

Specified by:

getName in interface IFilterWriter

Returns:

The name of the writer.

getEncoderManager

public EncoderManager getEncoderManager()

Description copied from interface: IFilterWriter

Gets the current encoder manager for this writer. Some special implementation of IFilterWriter may not use an encoder manager (for example writers that do not use skeleton).

Specified by:

getEncoderManager in interface IFilterWriter

Returns:

the current encoder manager for this writer, or null if none exists for this writer.

getSkeletonWriter

public ISkeletonWriter getSkeletonWriter()

Description copied from interface: IFilterWriter

Gets the skeleton writer associated with this writer. Some implementation of IFilterWriter may not use a skeleton writer.

Specified by:

getSkeletonWriter in interface IFilterWriter

Returns:

the skeleton writer associated with this writer or null if none is associated.

getParameters

public Parameters getParameters()

Description copied from interface: IFilterWriter

Gets the current parameters for this writer.

Specified by:

getParameters in interface IFilterWriter

Returns:

The current parameters for this writer.

handleEvent

public Event handleEvent(Event event)

Description copied from interface: IFilterWriter

Handles the filter events.

Specified by:

handleEvent in interface IFilterWriter

Parameters:

event - The event to process.

Returns:

The event that was processed.

setOptions

public void setOptions(LocaleId language,
                       String defaultEncoding)

Description copied from interface: IFilterWriter

Sets the options for this writer.

Specified by:

setOptions in interface IFilterWriter

Parameters:

language - the output locale.

defaultEncoding - Name of the character set encoding for the output.

setOutput

public void setOutput(String path)

Description copied from interface: IFilterWriter

Sets the output through the path of the output file.

Specified by:

setOutput in interface IFilterWriter

Parameters:

path - Full path of the output file.

setOutput

public void setOutput(OutputStream output)

Description copied from interface: IFilterWriter

Sets the output through its output stream.

Specified by:

setOutput in interface IFilterWriter

Parameters:

output - Output stream to use for the output.

setParameters

public void setParameters(IParameters params)

Description copied from interface: IFilterWriter

Sets new parameters for this writer.

Specified by:

setParameters in interface IFilterWriter

Parameters:

params - The new parameters to use.