net.sf.okapi.filters.xliff

Class XLIFFSkeletonWriter

java.lang.Object

net.sf.okapi.common.skeleton.GenericSkeletonWriter

net.sf.okapi.filters.xliff.XLIFFSkeletonWriter

All Implemented Interfaces:

ISkeletonWriter

Direct Known Subclasses:

IwsXliffSkeletonWriter, SdlXliffSkeletonWriter

public class XLIFFSkeletonWriter
extends GenericSkeletonWriter

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALTTRANSMARKER
static String	ITSNSDECL
static String	NOTEMARKER
static String	SEGSOURCEMARKER

Fields inherited from class net.sf.okapi.common.skeleton.GenericSkeletonWriter

allowEmptyOutputTarget, ALLOWEMPTYOUTPUTTARGET, encoderManager, inputLoc, isMultilingual, layer, outputEncoding, outputLoc, storageStack

Constructor Summary

Constructors

Constructor and Description
XLIFFSkeletonWriter()
XLIFFSkeletonWriter(Parameters params)
XLIFFSkeletonWriter(Parameters params, XLIFFContent fmt, ITSContent itsCont, ITSStandoffManager itsStandoffManager, Map<String,GenericAnnotations> lqiStandoff, Map<String,GenericAnnotations> provStandoff, CharsetEncoder chsEnc)

Method Summary

Modifier and Type	Method and Description
void	addUnusedAnnotations(StringBuilder endDoc, ITSContent itsContent, Collection<String> storedAnns, HashMap<String,GenericAnnotations> standoff, Class<? extends GenericAnnotations> type)
protected String	expandCodeContent(Code code, LocaleId locToUse, EncoderContext context)
CharsetEncoder	getCharsetEncoder()
protected String	getContent(ITextUnit tu, LocaleId locToUse, EncoderContext context) Gets the original content of a given text unit.
XLIFFContent	getFmt()
ITSContent	getItsCont()
ITSStandoffManager	getITSStandoffManager()
Map<String,GenericAnnotations>	getLqiStandoff()
Parameters	getParams()
protected String	getPropertyValue(INameable resource, String name, LocaleId locToUse, EncoderContext context)
Map<String,GenericAnnotations>	getProvStandoff()
protected String	getString(GenericSkeletonPart part, EncoderContext context)
String	processEndDocument(Ending resource) Processes the END_DOCUMENT event.
String	processStartDocument(LocaleId outputLocale, String outputEncoding, ILayerProvider layer, EncoderManager encoderManager, StartDocument resource) Processes the START_DOCUMENT event.
String	processStartGroup(StartGroup resource) Processes the START_GROUP event.
String	processStartSubDocument(StartSubDocument resource) Processes a START_SUBDOCUMENT event.
String	processTextUnit(ITextUnit resource) Processes the TEXT_UNIT event.
void	setITSStandoffManager(ITSStandoffManager itsStandoffManager)
protected void	setParams(Parameters params)

Methods inherited from class net.sf.okapi.common.skeleton.GenericSkeletonWriter

_processEndGroup, _processStartGroup, addToReferents, close, getContent, getEncoderManager, getInputLoc, getLayer, getOutputEncoding, getOutputLoc, getReference, getReferentCopies, getReferents, getSfWriter, getString, getString, getString, getString, isAllowEmptyOutputTarget, isMultilingual, processDocumentPart, processEndGroup, processEndSubDocument, processEndSubfilter, processStartSubfilter, setAllowEmptyOutputTarget, setEncoderManager, setInputLoc, setLayer, setMultilingual, setOutputEncoding, setOutputLoc, setReferentCopies, setReferents, setSfWriter

Methods inherited from class java.lang.Object

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

Field Detail

SEGSOURCEMARKER

public static final String SEGSOURCEMARKER

See Also:

Constant Field Values

ALTTRANSMARKER

public static final String ALTTRANSMARKER

See Also:

Constant Field Values

ITSNSDECL

public static final String ITSNSDECL

See Also:

Constant Field Values

NOTEMARKER

public static final String NOTEMARKER

See Also:

Constant Field Values

Constructor Detail

XLIFFSkeletonWriter

public XLIFFSkeletonWriter()

XLIFFSkeletonWriter

public XLIFFSkeletonWriter(Parameters params)

XLIFFSkeletonWriter

public XLIFFSkeletonWriter(Parameters params,
                           XLIFFContent fmt,
                           ITSContent itsCont,
                           ITSStandoffManager itsStandoffManager,
                           Map<String,GenericAnnotations> lqiStandoff,
                           Map<String,GenericAnnotations> provStandoff,
                           CharsetEncoder chsEnc)

Method Detail

processStartDocument

public String processStartDocument(LocaleId outputLocale,
                                   String outputEncoding,
                                   ILayerProvider layer,
                                   EncoderManager encoderManager,
                                   StartDocument resource)

Description copied from interface: ISkeletonWriter

Processes the START_DOCUMENT event.

Specified by:

processStartDocument in interface ISkeletonWriter

Overrides:

processStartDocument in class GenericSkeletonWriter

Parameters:

outputLocale - the output locale.

outputEncoding - the name of the output charset encoding.

layer - the layer provider to use.

encoderManager - the encoder manager to use.

resource - the StartDocument resource associated with the event.

Returns:

the string output corresponding to this event.

processTextUnit

public String processTextUnit(ITextUnit resource)

Description copied from interface: ISkeletonWriter

Processes the TEXT_UNIT event.

Specified by:

processTextUnit in interface ISkeletonWriter

Overrides:

processTextUnit in class GenericSkeletonWriter

Parameters:

resource - the TextUnit resource associated with the event.

Returns:

the string output corresponding to this event.

processStartSubDocument

public String processStartSubDocument(StartSubDocument resource)

Description copied from interface: ISkeletonWriter

Processes a START_SUBDOCUMENT event.

Specified by:

processStartSubDocument in interface ISkeletonWriter

Overrides:

processStartSubDocument in class GenericSkeletonWriter

Parameters:

resource - the StartSubDocument resource associated with the event.

Returns:

the string output corresponding to this event.

processStartGroup

public String processStartGroup(StartGroup resource)

Description copied from interface: ISkeletonWriter

Processes the START_GROUP event.

Specified by:

processStartGroup in interface ISkeletonWriter

Overrides:

processStartGroup in class GenericSkeletonWriter

Parameters:

resource - the StartGroup resource associated with the event.

Returns:

the string output corresponding to this event.

processEndDocument

public String processEndDocument(Ending resource)

Description copied from interface: ISkeletonWriter

Processes the END_DOCUMENT event.

Specified by:

processEndDocument in interface ISkeletonWriter

Overrides:

processEndDocument in class GenericSkeletonWriter

Parameters:

resource - the Ending resource associated with the event.

Returns:

the string output corresponding to this event.

addUnusedAnnotations

public void addUnusedAnnotations(StringBuilder endDoc,
                                 ITSContent itsContent,
                                 Collection<String> storedAnns,
                                 HashMap<String,GenericAnnotations> standoff,
                                 Class<? extends GenericAnnotations> type)

getString

protected String getString(GenericSkeletonPart part,
                           EncoderContext context)

Overrides:

getString in class GenericSkeletonWriter

getContent

protected String getContent(ITextUnit tu,
                            LocaleId locToUse,
                            EncoderContext context)

Description copied from class: GenericSkeletonWriter

Gets the original content of a given text unit.

Overrides:

getContent in class GenericSkeletonWriter

Parameters:

tu - The text unit to process.

locToUse - locale to output. Use null for the source, or the locale for the target locales.

context - Context flag: 0=text, 1=skeleton, 2=inline.

Returns:

The string representation of the text unit content.

expandCodeContent

protected String expandCodeContent(Code code,
                                   LocaleId locToUse,
                                   EncoderContext context)

Overrides:

expandCodeContent in class GenericSkeletonWriter

getPropertyValue

protected String getPropertyValue(INameable resource,
                                  String name,
                                  LocaleId locToUse,
                                  EncoderContext context)

Overrides:

getPropertyValue in class GenericSkeletonWriter

getITSStandoffManager

public ITSStandoffManager getITSStandoffManager()

setITSStandoffManager

public void setITSStandoffManager(ITSStandoffManager itsStandoffManager)

getParams

public Parameters getParams()

getFmt

public final XLIFFContent getFmt()

getItsCont

public final ITSContent getItsCont()

getLqiStandoff

public final Map<String,GenericAnnotations> getLqiStandoff()

getProvStandoff

public final Map<String,GenericAnnotations> getProvStandoff()

getCharsetEncoder

public final CharsetEncoder getCharsetEncoder()

setParams

protected void setParams(Parameters params)