net.sf.okapi.filters.xliff2.util

Class PropertiesMapper

java.lang.Object

net.sf.okapi.filters.xliff2.util.PropertiesMapper

public class PropertiesMapper
extends Object

Saves parameters and other data from the XLIFF Toolkit into Okapi Core and back. These properties are all saved as read only.

Since the mapping operation to and from should be equivalent, we put both operations in here to make it easier to compare them. All the methods in here have at least 2 parameters. The first parameter is where the data is being read from, and the second parameter is where the data is being written to.

Constructor Summary

Constructors

Constructor and Description
PropertiesMapper()

Method Summary

Modifier and Type	Method and Description
static void	fixMissingTargetCodeProperties(ITextUnit tu) In target Code placeholders, the properties are lost during conversion from XLIFF 2.0 to 1.2 and back.
static void	fixMissingTargetCodeProperties(ITextUnit propertiesStorage, Code okapiCode) Restores the missing properties saved by fixMissingTargetCodeProperties(ITextUnit).
static void	setCodeProperties(Code okapiCode, net.sf.okapi.lib.xliff2.core.CTag xliff2Ctag) Transfers properties from the Okapi Core Code Tag to the XLIFF Toolkit Code Tag
static void	setCodeProperties(net.sf.okapi.lib.xliff2.core.CTag xliff2Ctag, Code okapiCode) Transfers properties from the XLIFF Toolkit Code Tag to the Okapi Core Code Tag.
static void	setGroupProperties(net.sf.okapi.lib.xliff2.core.StartGroupData xliffStartGroupData, StartGroup okapiStartGroup) Transfers properties from the XLIFF 2.0 Start Group Data to the Okapi Core Start Group
static void	setGroupProperties(StartGroup okapiStartGroup, net.sf.okapi.lib.xliff2.core.StartGroupData xliffStartGroupData) Transfers properties from the Okapi Core Start Group to the XLIFF 2.0 Start Group Data
static void	setMidFileProperties(DocumentPart documentPart, net.sf.okapi.lib.xliff2.core.MidFileData midFileData) Transfers properties from the Okapi Core Document Part to the XLIFF Toolkit Mid File Data
static void	setMidFileProperties(net.sf.okapi.lib.xliff2.core.MidFileData midFileData, DocumentPart documentPart) Transfers properties from the XLIFF Toolkit Mid File Data to the Okapi Core Document Part
static void	setPartProperties(net.sf.okapi.lib.xliff2.core.Part xliffPart, TextPart okapiPart) Transfers properties from the XLIFF Toolkit Part to the Okapi Core TextPart
static void	setPartProperties(TextPart okapiSourcePart, TextPart okapiTargetPart, net.sf.okapi.lib.xliff2.core.Part xliffPart, ITextUnit okapiTextUnit) Transfers properties from the Okapi Core TextPart to the XLIFF Toolkit Part
static void	setSkeletonProperties(net.sf.okapi.lib.xliff2.core.Skeleton skeletonData, StartSubDocument startSubDoc) Transfers properties from the XLIFF Toolkit Skeleton to the Okapi Core StartSubDocument
static void	setSkeletonProperties(StartSubDocument startSubDoc, net.sf.okapi.lib.xliff2.core.Skeleton skeletonData) Transfers properties from the Okapi Core StartSubDocument to the XLIFF Toolkit Skeleton
static void	setStartFileProperties(net.sf.okapi.lib.xliff2.core.StartFileData xliffStartFileData, StartSubDocument okapiStartSubDoc) Transfers properties from the XLIFF Toolkit StartFileData to the Okapi Core StartSubDocument
static void	setStartFileProperties(StartSubDocument okapiStartSubDoc, net.sf.okapi.lib.xliff2.core.StartFileData xliffStartFileData) Transfers properties from the Okapi Core StartSubDocument to the XLIFF Toolkit StartFileData
static void	setStartXliffProperties(StartDocument okapiStartDocument, net.sf.okapi.lib.xliff2.core.StartXliffData xliffStartXliff) Transfers properties from the Okapi Core StartDocument to the XLIFF Toolkit StartXliffData
static void	setStartXliffProperties(net.sf.okapi.lib.xliff2.core.StartXliffData xliffStartXliff, StartDocument okapiStartDocument) Transfers properties from the XLIFF Toolkit StartXliffData to the Okapi Core StartDocument
static void	setTextUnitProperties(ITextUnit okapiTextUnit, net.sf.okapi.lib.xliff2.core.Unit xliffTextUnit) Transfers properties from the Okapi Core TextUnit to the XLIFF Toolkit TextUnit
static void	setTextUnitProperties(net.sf.okapi.lib.xliff2.core.Unit unit, ITextUnit tu) Transfers properties from the XLIFF Toolkit TextUnit to the Okapi Core TextUnit

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesMapper

public PropertiesMapper()

Method Detail

setStartXliffProperties

public static void setStartXliffProperties(net.sf.okapi.lib.xliff2.core.StartXliffData xliffStartXliff,
                                           StartDocument okapiStartDocument)

Transfers properties from the XLIFF Toolkit StartXliffData to the Okapi Core StartDocument

Relates to <xliff> elements in XLIFF 2.0 file

Parameters:

xliffStartXliff - The properties to read from

okapiStartDocument - The properties to write to

setStartXliffProperties

public static void setStartXliffProperties(StartDocument okapiStartDocument,
                                           net.sf.okapi.lib.xliff2.core.StartXliffData xliffStartXliff)

Transfers properties from the Okapi Core StartDocument to the XLIFF Toolkit StartXliffData

Relates to <xliff> elements in XLIFF 2.0 file

Parameters:

okapiStartDocument - The properties to read from

xliffStartXliff - The properties to write to

setStartFileProperties

public static void setStartFileProperties(net.sf.okapi.lib.xliff2.core.StartFileData xliffStartFileData,
                                          StartSubDocument okapiStartSubDoc)

Transfers properties from the XLIFF Toolkit StartFileData to the Okapi Core StartSubDocument

Relates to <file> elements in XLIFF 2.0 file

Parameters:

xliffStartFileData - The properties to read from

okapiStartSubDoc - The properties to write to

setStartFileProperties

public static void setStartFileProperties(StartSubDocument okapiStartSubDoc,
                                          net.sf.okapi.lib.xliff2.core.StartFileData xliffStartFileData)

Transfers properties from the Okapi Core StartSubDocument to the XLIFF Toolkit StartFileData

Relates to <file> elements in XLIFF 2.0 file

Parameters:

xliffStartFileData - The properties to read from

okapiStartSubDoc - The properties to write to

setSkeletonProperties

public static void setSkeletonProperties(net.sf.okapi.lib.xliff2.core.Skeleton skeletonData,
                                         StartSubDocument startSubDoc)

Transfers properties from the XLIFF Toolkit Skeleton to the Okapi Core StartSubDocument

Relates to <skeleton> elements in XLIFF 2.0 file

Parameters:

skeletonData - The properties to read from

startSubDoc - The properties to write to

setSkeletonProperties

public static void setSkeletonProperties(StartSubDocument startSubDoc,
                                         net.sf.okapi.lib.xliff2.core.Skeleton skeletonData)

Transfers properties from the Okapi Core StartSubDocument to the XLIFF Toolkit Skeleton

Relates to <skeleton> elements in XLIFF 2.0 file

Parameters:

startSubDoc - The properties to read from

skeletonData - The properties to write to

setGroupProperties

public static void setGroupProperties(net.sf.okapi.lib.xliff2.core.StartGroupData xliffStartGroupData,
                                      StartGroup okapiStartGroup)

Transfers properties from the XLIFF 2.0 Start Group Data to the Okapi Core Start Group

Parameters:

xliffStartGroupData - The properties to read from

okapiStartGroup - The properties to write to

setGroupProperties

public static void setGroupProperties(StartGroup okapiStartGroup,
                                      net.sf.okapi.lib.xliff2.core.StartGroupData xliffStartGroupData)

Transfers properties from the Okapi Core Start Group to the XLIFF 2.0 Start Group Data

Parameters:

xliffStartGroupData - The properties to write to

okapiStartGroup - The properties to read from

setTextUnitProperties

public static void setTextUnitProperties(net.sf.okapi.lib.xliff2.core.Unit unit,
                                         ITextUnit tu)

Transfers properties from the XLIFF Toolkit TextUnit to the Okapi Core TextUnit

Relates to <unit> elements in XLIFF 2.0 file

Parameters:

unit - The properties to read from

tu - The properties to write to

setTextUnitProperties

public static void setTextUnitProperties(ITextUnit okapiTextUnit,
                                         net.sf.okapi.lib.xliff2.core.Unit xliffTextUnit)

Transfers properties from the Okapi Core TextUnit to the XLIFF Toolkit TextUnit

Relates to <unit> elements in XLIFF 2.0 file

Parameters:

okapiTextUnit - The properties to read from

xliffTextUnit - The properties to write to

setPartProperties

public static void setPartProperties(net.sf.okapi.lib.xliff2.core.Part xliffPart,
                                     TextPart okapiPart)

Transfers properties from the XLIFF Toolkit Part to the Okapi Core TextPart

Relates to <segment> and <ignorable> elements in XLIFF 2.0 file

Parameters:

xliffPart - The properties to write to

okapiPart - The properties to read from

setPartProperties

public static void setPartProperties(TextPart okapiSourcePart,
                                     TextPart okapiTargetPart,
                                     net.sf.okapi.lib.xliff2.core.Part xliffPart,
                                     ITextUnit okapiTextUnit)

Transfers properties from the Okapi Core TextPart to the XLIFF Toolkit Part

Relates to <segment> and <ignorable> elements in XLIFF 2.0 file

Parameters:

okapiSourcePart - The properties to read from

xliffPart - The properties to write to

okapiTextUnit - Extra properties to read from

setCodeProperties

public static void setCodeProperties(Code okapiCode,
                                     net.sf.okapi.lib.xliff2.core.CTag xliff2Ctag)

Transfers properties from the Okapi Core Code Tag to the XLIFF Toolkit Code Tag

Relates to <ph>, <pc>, and <sc> elements in XLIFF 2.0 file

Parameters:

okapiCode - The properties to read from

xliff2Ctag - The properties to write to

setCodeProperties

public static void setCodeProperties(net.sf.okapi.lib.xliff2.core.CTag xliff2Ctag,
                                     Code okapiCode)

Transfers properties from the XLIFF Toolkit Code Tag to the Okapi Core Code Tag.

Relates to <ph>, <pc>, and <sc> elements in XLIFF 2.0 file

Due to the Okapi Core Code only allowing integers as a valid ID, the integer used instead is a hash code of the ID and the actual ID is saved in the original ID.

Parameters:

okapiCode - The properties to read from

xliff2Ctag - The properties to write to

setMidFileProperties

public static void setMidFileProperties(net.sf.okapi.lib.xliff2.core.MidFileData midFileData,
                                        DocumentPart documentPart)

Transfers properties from the XLIFF Toolkit Mid File Data to the Okapi Core Document Part

Relates to <metadata> elements in the <file> element in XLIFF 2.0 file

Parameters:

midFileData - The properties to read from

documentPart - The properties to write to

setMidFileProperties

public static void setMidFileProperties(DocumentPart documentPart,
                                        net.sf.okapi.lib.xliff2.core.MidFileData midFileData)

Transfers properties from the Okapi Core Document Part to the XLIFF Toolkit Mid File Data

Relates to <metadata> elements in the <file> element in XLIFF 2.0 file

Parameters:

documentPart - The properties to read from

midFileData - The properties to write to

fixMissingTargetCodeProperties

public static void fixMissingTargetCodeProperties(ITextUnit tu)

In target Code placeholders, the properties are lost during conversion from XLIFF 2.0 to 1.2 and back. This saves them into the TextUnit, which doesn't lose its properties during such conversion. Because in XLIFF 2.0 the ID of a placeholder in a target must be unique to that text unit (unless it's paired with a source), we can use the ID as a unique identifier. Hopefully, the XLIFF 1.2 Filter can be fixed and then this method can be deprecated.

Parameters:

tu - The text unit to save the properties to.

fixMissingTargetCodeProperties

public static void fixMissingTargetCodeProperties(ITextUnit propertiesStorage,
                                                  Code okapiCode)

Restores the missing properties saved by fixMissingTargetCodeProperties(ITextUnit).

Parameters:

propertiesStorage - The place where the properties are saved.

okapiCode - The code to restore to.