Package net.sf.okapi.steps.rainbowkit.xliff

Class XLIFF2TerminologyPackageWriter

java.lang.Object

net.sf.okapi.steps.rainbowkit.common.BasePackageWriter

net.sf.okapi.steps.rainbowkit.xliff.XLIFF2PackageWriter

net.sf.okapi.steps.rainbowkit.xliff.XLIFF2TerminologyPackageWriter

All Implemented Interfaces:

AutoCloseable, IFilterWriter, IPackageWriter

public class XLIFF2TerminologyPackageWriter
extends XLIFF2PackageWriter

Class that adds functionality on writing XLIFF glossary element of the Glossary module to the XLIFF unit element. Glossary annotation GlossaryAnnotation should be present in source segment Segment in order to perform the writing. Also it is capable to annotate source and target segments with references to generated glossary entry ids. For this, the fields GlossaryAnnotation.isAnnotateSourceSegment() and GlossaryAnnotation.isAnnotateTargetSegment() from GlossaryAnnotation are used to indicate if the annotation should be done.

Author:

Vladyslav Mykhalets

Field Summary

Fields

Modifier and Type	Field	Description
static String	GLS_SEGMENT_REF_PREFIX

Fields inherited from class net.sf.okapi.steps.rainbowkit.xliff.XLIFF2PackageWriter

POBJECTS_DIR

Fields inherited from class net.sf.okapi.steps.rainbowkit.common.BasePackageWriter

copiedTargetsLikeApproved, docId, extractionType, inputRootDir, manifest, params, rootDir, skelWriter, supporstOneOutputPerInput, tempTmxPathAlternates, tempTmxPathApproved, tempTmxPathLeverage, tempTmxPathUnApproved, tmxInfoAlreadySet, tmxPathAlternates, tmxPathApproved, tmxPathLeverage, tmxPathUnApproved, tmxWriterAlternates, tmxWriterApproved, tmxWriterLeverage, tmxWriterUnApproved, useLetterCodes, zeroBasedLetterCodes

Constructor Summary

Constructors

Constructor	Description
XLIFF2TerminologyPackageWriter()

Method Summary

Modifier and Type	Method	Description
protected void	addGlossary(Unit xliffUnit, GlossaryAnnotation glossaryAnnotation)	Method which converts OKAPI glossary entries to XLIFF format and adds them to XLIFF glossary element.
protected void	addGlossaryReferences(Segment xliffSegment, GlossaryAnnotation glossaryAnnotation)	Method which annotates source and target XLIFF segments with references to generated glossary entry ids.
protected Unit	toXLIFF2Unit(ITextUnit unit)

Methods inherited from class net.sf.okapi.steps.rainbowkit.xliff.XLIFF2PackageWriter

close, getCreeatTipPackage, getName, processDocumentPart, processEndBatch, processEndDocument, processEndGroup, processEndSubDocument, processStartBatch, processStartDocument, processStartGroup, processStartSubDocument, processTextUnit, toXLIFF2StartGroupData

Methods inherited from class net.sf.okapi.steps.rainbowkit.common.BasePackageWriter

cancel, copySupportMaterial, creatRawDocumentEventSet, getEncoderManager, getMainOutputPath, getParameters, getSkeletonWriter, handleEvent, initializeTMXWriters, processEndBatchItem, processRawDocument, processStartBatchItem, setBatchInformation, setDocumentInformation, setOptions, setOutput, setOutput, setParameters, setSupporstOneOutputPerInput, setTMXInfo, writeTMXEntries

Methods inherited from class java.lang.Object

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

Field Detail

GLS_SEGMENT_REF_PREFIX

public static final String GLS_SEGMENT_REF_PREFIX

See Also:

Constant Field Values

Constructor Detail

XLIFF2TerminologyPackageWriter

public XLIFF2TerminologyPackageWriter()

Method Detail

toXLIFF2Unit

protected Unit toXLIFF2Unit(ITextUnit unit)

Overrides:

toXLIFF2Unit in class XLIFF2PackageWriter

addGlossaryReferences

protected void addGlossaryReferences(Segment xliffSegment,
                                     GlossaryAnnotation glossaryAnnotation)

Method which annotates source and target XLIFF segments with references to generated glossary entry ids. It is possible to override the default behavior.

Parameters:

xliffSegment - XLIFF segment where glossary entries annotation will be done

glossaryAnnotation - glossary annotation for XLIFF segment

addGlossary

protected void addGlossary(Unit xliffUnit,
                           GlossaryAnnotation glossaryAnnotation)

Method which converts OKAPI glossary entries to XLIFF format and adds them to XLIFF glossary element. It is possible to override the default behaviour.

Parameters:

xliffUnit - XLIFF unit

glossaryAnnotation - okapi glossary annotation taken from source segment