Package net.sf.okapi.common.skeleton

Interface ISkeletonWriter

All Known Implementing Classes:

CSVSkeletonWriter, GenericSkeletonWriter, HTML5SkeletonWriter, HtmlSkeletonWriter, IwsXliffSkeletonWriter, MarkdownSkeletonWriter, SdlXliffSkeletonWriter, SubFilterSkeletonWriter, TEXSkeletonWriter, TTXSkeletonWriter, TXMLSkeletonWriter, VignetteSkeletonWriter, XLIFFSkeletonWriter, XMLSkeletonWriter, YamlSkeletonWriter

public interface ISkeletonWriter

Provides the methods common to all skeleton writers.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this skeleton writer.
String	processDocumentPart(DocumentPart resource)	Processes the DOCUMENT_PART event.
String	processEndDocument(Ending resource)	Processes the END_DOCUMENT event.
String	processEndGroup(Ending resource)	Processes the END_GROUP event.
String	processEndSubDocument(Ending resource)	Processes the END_SUBDOCUMENT event.
String	processEndSubfilter(EndSubfilter resource)
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	processStartSubfilter(StartSubfilter resource)
String	processTextUnit(ITextUnit resource)	Processes the TEXT_UNIT event.

Method Detail

close

void close()

Closes this skeleton writer.

processStartDocument

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

Processes the START_DOCUMENT event.

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.

processEndDocument

String processEndDocument(Ending resource)

Processes the END_DOCUMENT event.

Parameters:

resource - the Ending resource associated with the event.

Returns:

the string output corresponding to this event.

processStartSubDocument

String processStartSubDocument(StartSubDocument resource)

Processes a START_SUBDOCUMENT event.

Parameters:

resource - the StartSubDocument resource associated with the event.

Returns:

the string output corresponding to this event.

processEndSubDocument

String processEndSubDocument(Ending resource)

Processes the END_SUBDOCUMENT event.

Parameters:

resource - the Ending resource associated with the event.

Returns:

the string output corresponding to this event.

processStartGroup

String processStartGroup(StartGroup resource)

Processes the START_GROUP event.

Parameters:

resource - the StartGroup resource associated with the event.

Returns:

the string output corresponding to this event.

processEndGroup

String processEndGroup(Ending resource)

Processes the END_GROUP event.

Parameters:

resource - the Ending resource associated with the event.

Returns:

the string output corresponding to this event.

processTextUnit

String processTextUnit(ITextUnit resource)

Processes the TEXT_UNIT event.

Parameters:

resource - the TextUnit resource associated with the event.

Returns:

the string output corresponding to this event.

processDocumentPart

String processDocumentPart(DocumentPart resource)

Processes the DOCUMENT_PART event.

Parameters:

resource - the DocumentPart resource associated with the event.

Returns:

the string output corresponding to this event.

processStartSubfilter

String processStartSubfilter(StartSubfilter resource)

processEndSubfilter

String processEndSubfilter(EndSubfilter resource)