Interface ITranslationOrigin

Information on the origin of a translation.

Inherited Members

IMetaDataContainer.MetaDataContainsKey(string)

IMetaDataContainer.GetMetaData(string)

IMetaDataContainer.SetMetaData(string, string)

IMetaDataContainer.RemoveMetaData(string)

IMetaDataContainer.ClearMetaData()

IMetaDataContainer.MetaData

IMetaDataContainer.HasMetaData

IMetaDataContainer.MetaDataCount

ICloneable.Clone()

Namespace: SdlSdl.FileTypeSupportFrameworkNativeApi

Assembly: Sdl.FileTypeSupport.Framework.Core.dll

Syntax

public interface ITranslationOrigin : IMetaDataContainer, ICloneable

Remarks

Custom metadata can be stored and accessed through the IMetaDataContainer implementation.

Properties

IsRepeated

Indicates whether this segment pair exists in the repetitions table

Declaration

bool IsRepeated { get; }

Property Value

Type	Description
bool

IsSIDContextMatch

If true, indicates that the translation originates from a system that takes ID context information into account, and that the ID context matches.

Declaration

bool IsSIDContextMatch { get; set; }

Property Value

Type	Description
bool

Remarks

This is used when a document has context information with at least one Purpose set to Match with ContextType set to sdl:sid, in order to indicate when a match has a corresponding Description that holds the SID value.

IsStructureContextMatch

If true, indicates that the translation originates from a system that takes structural context information into account, and that the structure context matches.

Declaration

bool IsStructureContextMatch { get; set; }

Property Value

Type	Description
bool

Remarks

This is used when a document has context information with at least one Purpose set to Match in order to indicate when a match has a corresponding ContextType.

When a match gets adapted by interactive translation, the original structure match value can be read from this property on the OriginBeforeAdaptation properties.

Typical usage for this value is when editing or proofreading translations. Here, proofreaders or editors may want to pay special attention to certain matches to ensure that they were correctly adopted when used in translation.

It may also be possible to directly access the actual translation proposal used as part of the bilingual object model for the paragraph unit. In that case, this value should convey the structure match quality for that translation.

This value should typically not change during editing of the segment content, as it is meant to capture information on the original interaction with the translation memory.

this[string]

Convenience getter and setter for metadata using indexer syntax.

The getter functionality is equivalent to calling SetMetaData(string, string), and the setter functionality is equivalent to GetMetaData(string).

Declaration

string this[string key] { get; set; }

Parameters

Type	Name	Description
string	key	Must not be null or empty

Property Value

Type	Description
string	The corresponding value, or null if none

MatchPercent

The match value for a translation memory match, or the confidence level for a machine translation. Should be a percentage value from 0 - 100%

Declaration

byte MatchPercent { get; set; }

Property Value

Type	Description
byte

Remarks

When a match gets adapted by interactive translation, the original match value can be read from this property on the OriginBeforeAdaptation properties.

A typical use case for this value is when editing or proof-reading translations. Here, proofreaders or editors may want to pay special attention to fuzzy matches to ensure that they were correctly adopted when used in translation.

It may also be possible to directly access the actual translation proposal used as part of the bilingual object model for the paragraph unit. In that case, this value should correspond to the match quality for that translation.

This value should typically not change during editing of the segment content, as it is meant to capture information on the original interaction with the translation memory.

OriginBeforeAdaptation

Null or the origin information for the originally adapted target content

Declaration

ITranslationOrigin OriginBeforeAdaptation { get; set; }

Property Value

Type	Description
ITranslationOrigin

OriginSystem

The translation memory, machine translation system, or a similar source from which the translation originates, or null if unknown or not applicable.

Declaration

string OriginSystem { get; set; }

Property Value

Type	Description
string

OriginType

The origin of the translation for the segment pair.

Declaration

string OriginType { get; set; }

Property Value

Type	Description
string

Remarks

Use the pre-defined constant values in Sdl.FileTypeSupport.Framework.Core.Utilitites.NativeApi.DefaultTranslationOrigin if possible.

If the translation origin is Sdl.FileTypeSupport.Framework.Core.Utilitites.NativeApi.DefaultTranslationOrigin.Interactive, the OriginBeforeAdaptation may contain information on the originally adapted content.

OriginalTranslationHash

A hash value that identifies the entry in the TM that provided the translation. This is used to update the correct TM entry if a translator provides an updated version of the translation.

Declaration

string OriginalTranslationHash { get; set; }

Property Value

Type	Description
string

RepetitionTableId

The id of this segment in the repetitions table that holds all the repetitions matching this segment

Declaration

RepetitionId RepetitionTableId { get; set; }

Property Value

Type	Description
RepetitionId

TextContextMatchLevel

Indicates whether the match originates from a source where the textual surrounding content corresponds to the text surrounding this segment.

Declaration

TextContextMatchLevel TextContextMatchLevel { get; set; }

Property Value

Type	Description
TextContextMatchLevel

Remarks

This is used with the new translation memory for textual context matches.

When a match gets adapted by interactive translation, the original text context match level can be read from this property on the OriginBeforeAdaptation properties.

A typical use case for this value is when editing or proofreading translations. Here, proofreaders or editors may want to pay special attention to certain matches to ensure that they were correctly adopted when used in translation.

It may also be possible to directly access the actual translation proposal used as part of the bilingual object model for the paragraph unit. In that case, this value should convey the textual match quality for that translation.

This value should typically not change during editing of the segment content, as it is meant to capture information on the original interaction with the translation memory.