Package net.sf.okapi.common.encoder

Class XMLEncoder

java.lang.Object

net.sf.okapi.common.encoder.XMLEncoder

All Implemented Interfaces:

Function<ITextUnit,ITextUnit>, IEncoder

Direct Known Subclasses:

TSEncoder

public class XMLEncoder
extends Object
implements IEncoder

Implements IEncoder for XML format.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XMLEncoder.Parameters	Provides encoder parameters.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ESCAPEGT	Parameter flag for escaping the greater-than characters.
static String	ESCAPELINEBREAK	Parameter flag for escaping the line-breaks.
static String	ESCAPENBSP	Parameter flag for escaping the non-breaking space characters.
static String	QUOTEMODE	Parameter flag for defining the quote mode.
static String	QUOTEMODEDEFINED	Parameter flag for indicating that the QUOTEMODE is defined.

Constructor Summary

Constructors

Constructor	Description
XMLEncoder()
XMLEncoder(String encoding, String lineBreak, boolean escapeGT, boolean escapeNbsp, boolean escapeLineBreak, QuoteMode quoteMode)

Method Summary

Modifier and Type	Method	Description
String	encode(char value, EncoderContext context)	Encodes a given character with this encoding.
String	encode(int value, EncoderContext context)	Encodes a given code-point with this encoding.
String	encode(String text, EncoderContext context)	Encodes a given text with this encoder.
CharsetEncoder	getCharsetEncoder()	Gets the character set encoder used for this encoder.
String	getEncoding()	Gets the name of the charset encoding to use.
String	getLineBreak()	Gets the line-break to use for this encoder.
IParameters	getParameters()	Gets the parameters object with all the configuration information specific to this encoder.
void	reset()	Reset state in this encoder in preparation for processing new content.
void	setOptions(IParameters params, String encoding, String lineBreak)	Sets the options for this encoder.
String	toNative(String propertyName, String value)	Converts any property values from its standard representation to the native representation for this encoder.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface net.sf.okapi.common.encoder.IEncoder

apply

Field Detail

ESCAPEGT

public static final String ESCAPEGT

Parameter flag for escaping the greater-than characters.

See Also:

Constant Field Values

ESCAPENBSP

public static final String ESCAPENBSP

Parameter flag for escaping the non-breaking space characters.

See Also:

Constant Field Values

ESCAPELINEBREAK

public static final String ESCAPELINEBREAK

Parameter flag for escaping the line-breaks.

See Also:

Constant Field Values

QUOTEMODEDEFINED

public static final String QUOTEMODEDEFINED

Parameter flag for indicating that the QUOTEMODE is defined.

See Also:

Constant Field Values

QUOTEMODE

public static final String QUOTEMODE

Parameter flag for defining the quote mode.

See Also:

Constant Field Values

Constructor Detail

XMLEncoder

public XMLEncoder(String encoding,
                  String lineBreak,
                  boolean escapeGT,
                  boolean escapeNbsp,
                  boolean escapeLineBreak,
                  QuoteMode quoteMode)

XMLEncoder

public XMLEncoder()

Method Detail

reset

public void reset()

Description copied from interface: IEncoder

Reset state in this encoder in preparation for processing new content.

Specified by:

reset in interface IEncoder

setOptions

public void setOptions(IParameters params,
                       String encoding,
                       String lineBreak)

Sets the options for this encoder. This encoder supports the following parameters:

• escapeGT=true to converts '>' characters to to >.
• escapeNbsp=true to converts non-breaking space to  .
• escapeLineBreak=true to converts line-breaks to 
.

Specified by:

setOptions in interface IEncoder

Parameters:

params - the parameters object with all the configuration information specific to this encoder.

encoding - the name of the character set encoding to use.

lineBreak - the type of line break to use.

encode

public String encode(String text,
                     EncoderContext context)

Description copied from interface: IEncoder

Encodes a given text with this encoder.

Specified by:

encode in interface IEncoder

Parameters:

text - the text to encode.

context - the context of the text: 0=text, 1=skeleton, 2=inline.

Returns:

the encoded text.

encode

public String encode(char value,
                     EncoderContext context)

Description copied from interface: IEncoder

Encodes a given character with this encoding.

Specified by:

encode in interface IEncoder

Parameters:

value - the character to encode.

context - the context of the character: 0=text, 1=skeleton, 2=inline.

Returns:

the encoded character 9as a string since it can be now made up of more than one character).

encode

public String encode(int value,
                     EncoderContext context)

Description copied from interface: IEncoder

Encodes a given code-point with this encoding. If this method is called from a loop it is assumed that the code point is tested by the caller to know if it is a supplemental one or not and and any index update to skip the low surrogate part of the pair is done on the caller side.

Specified by:

encode in interface IEncoder

Parameters:

value - the code-point to encode.

context - the context of the character: 0=text, 1=skeleton, 2=inline.

Returns:

the encoded character (as a string since it can be now made up of more than one character).

toNative

public String toNative(String propertyName,
                       String value)

Description copied from interface: IEncoder

Converts any property values from its standard representation to the native representation for this encoder.

Specified by:

toNative in interface IEncoder

Parameters:

propertyName - the name of the property.

value - the standard value to convert.

Returns:

the native representation of the given value.

getLineBreak

public String getLineBreak()

Description copied from interface: IEncoder

Gets the line-break to use for this encoder.

Specified by:

getLineBreak in interface IEncoder

Returns:

the line-break used for this encoder.

getCharsetEncoder

public CharsetEncoder getCharsetEncoder()

Description copied from interface: IEncoder

Gets the character set encoder used for this encoder.

Specified by:

getCharsetEncoder in interface IEncoder

Returns:

the character set encoder used for this encoder. This can be null.

getParameters

public IParameters getParameters()

Description copied from interface: IEncoder

Gets the parameters object with all the configuration information specific to this encoder.

Specified by:

getParameters in interface IEncoder

Returns:

the parameters object used for this encoder. This can be null.

getEncoding

public String getEncoding()

Description copied from interface: IEncoder

Gets the name of the charset encoding to use.

Specified by:

getEncoding in interface IEncoder

Returns:

the charset encoding used for this encoder.