Class TranslationProviderCascadeEntry

This class represents an entry in a translation provider configuration (see Entries), consisting of a main translation provider (MainTranslationProvider), which is generally specified at project creation time and one or more project translation memories (ProjectTranslationMemories which are usually populated automatically by the "Populate Project Translation Memories" batch task as part of project preparation.

Inheritance

object

TranslationProviderCascadeEntry

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SdlSdl.ProjectAutomationCore

Assembly: Sdl.ProjectAutomation.Core.dll

Syntax

public class TranslationProviderCascadeEntry

Constructors

TranslationProviderCascadeEntry(TranslationProviderReference, bool, bool, bool)

Constructor that takes the main translation provider reference and default search and update settings, with no penalty.

Declaration

public TranslationProviderCascadeEntry(TranslationProviderReference mainTranslationProvider, bool performUpdate, bool performNormalSearch, bool performConcordanceSearch)

Parameters

Type	Name	Description
TranslationProviderReference	mainTranslationProvider	The main translation provider reference.
bool	performUpdate	Whether to update this translation provider when updating translation units in the cascade it belongs to (Entries).
bool	performNormalSearch	Whether to search this translation provider when performing a normal translation search in the cascade it belongs to (Entries).
bool	performConcordanceSearch	Whether to search this translation provider when performing a concordance search in the cascade it belongs to (Entries).

TranslationProviderCascadeEntry(TranslationProviderReference, bool, bool, bool, int)

Constructor that takes the main translation provider reference and default search and update settings.

Declaration

public TranslationProviderCascadeEntry(TranslationProviderReference mainTranslationProvider, bool performUpdate, bool performNormalSearch, bool performConcordanceSearch, int penalty)

Parameters

Type	Name	Description
TranslationProviderReference	mainTranslationProvider	The main translation provider reference.
bool	performUpdate	Whether to update this translation provider when updating translation units in the cascade it belongs to (Entries).
bool	performNormalSearch	Whether to search this translation provider when performing a normal translation search in the cascade it belongs to (Entries).
bool	performConcordanceSearch	Whether to search this translation provider when performing a concordance search in the cascade it belongs to (Entries).
int	penalty	The penalty to apply for search results from this provider (main or project) when performing normal searches. This penalty is applied on top of any penalty that might be applied by the translation provider itself. This should be a positive integer.

TranslationProviderCascadeEntry(TranslationProviderReference, List<TranslationProviderReference>, bool, bool, bool, int)

Constructor that takes the main translation provider reference, project translation memory references, and default search and update settings.

Declaration

public TranslationProviderCascadeEntry(TranslationProviderReference mainTranslationProvider, List<TranslationProviderReference> projectTranslationMemories, bool performUpdate, bool performNormalSearch, bool performConcordanceSearch, int penalty)

Parameters

Type	Name	Description
TranslationProviderReference	mainTranslationProvider	The main translation provider reference.
List TranslationProviderReference	projectTranslationMemories	The list of project translation memories corresponding to the main translation provider in this entry. This list can be empty, but not `null`. The only situation where the list can contain more than one translation memory is when the main translation provider is a multilingual server-based translation memory and the project was set to create file-based translation memories. In this case, there will be one file-based project translation memory for each of the language directions in the main server-based translation memory (if this language direction is also one of the project language directions).
bool	performUpdate	Whether to update this translation provider when updating translation units in the cascade it belongs to (Entries).
bool	performNormalSearch	Whether to search this translation provider when performing a normal translation search in the cascade it belongs to (Entries).
bool	performConcordanceSearch	Whether to search this translation provider when performing a concordance search in the cascade it belongs to (Entries).
int	penalty	The penalty to apply for search results from this provider (main or project) when performing normal searches. This penalty is applied on top of any penalty that might be applied by the translation provider itself. This should be a positive integer.

TranslationProviderCascadeEntry(string, bool, bool, bool)

Constructor that takes an absolute path to a file-based translation memory (*.sdltm) and default search and update settings, with no penalty.

Declaration

public TranslationProviderCascadeEntry(string fileBasedTranslationMemoryFilePath, bool performUpdate, bool performNormalSearch, bool performConcordanceSearch)

Parameters

Type	Name	Description
string	fileBasedTranslationMemoryFilePath	The absolute path to a file-based translation memory (*.sdltm).
bool	performUpdate	Whether to update this translation provider when updating translation units in the cascade it belongs to (Entries).
bool	performNormalSearch	Whether to search this translation provider when performing a normal translation search in the cascade it belongs to (Entries).
bool	performConcordanceSearch	Whether to search this translation provider when performing a concordance search in the cascade it belongs to (Entries).

TranslationProviderCascadeEntry(string, bool, bool, bool, int)

Constructor that takes an absolute path to a file-based translation memory (*.sdltm)and default search and update settings.

Declaration

public TranslationProviderCascadeEntry(string fileBasedTranslationMemoryFilePath, bool performUpdate, bool performNormalSearch, bool performConcordanceSearch, int penalty)

Parameters

Type	Name	Description
string	fileBasedTranslationMemoryFilePath	The absolute path to a file-based translation memory (*.sdltm).
bool	performUpdate	Whether to update this translation provider when updating translation units in the cascade it belongs to (Entries).
bool	performNormalSearch	Whether to search this translation provider when performing a normal translation search in the cascade it belongs to (Entries).
bool	performConcordanceSearch	Whether to search this translation provider when performing a concordance search in the cascade it belongs to (Entries).
int	penalty	The penalty to apply for search results from this provider (main or project) when performing normal searches. This penalty is applied on top of any penalty that might be applied by the translation provider itself. This should be a positive integer.

Properties

MainTranslationProvider

Gets the main translation provider reference. Cannot be null.

Declaration

public TranslationProviderReference MainTranslationProvider { get; set; }

Property Value

Type	Description
TranslationProviderReference

Penalty

Gets or sets the penalty to apply for search results from this provider (main or project) when performing normal searches. This penalty is applied on top of any penalty that might be applied by the translation provider itself. This should be a positive integer.

Declaration

public int Penalty { get; set; }

Property Value

Type	Description
int

PerformConcordanceSearch

Gets or sets whether to search this translation provider when performing a concordance search in the cascade it belongs to (Entries).

Declaration

public bool PerformConcordanceSearch { get; set; }

Property Value

Type	Description
bool

PerformNormalSearch

Gets or sets whether to search this translation provider when performing a normal translation search in the cascade it belongs to (Entries).

Declaration

public bool PerformNormalSearch { get; set; }

Property Value

Type	Description
bool

PerformUpdate

Gets or sets whether to search this translation provider when performing a normal translation search in the cascade it belongs to (Entries).

Declaration

public bool PerformUpdate { get; set; }

Property Value

Type	Description
bool

ProjectTranslationMemories

Gets or sets the list of project translation memories corresponding to the main translation provider in this entry. This list can be empty, but not null. The only situation where the list can contain more than one translation memory is when the main translation provider is a multilingual server-based translation memory and the project was set to create file-based translation memories. In this case, there will be one file-based project translation memory for each of the language directions in the main server-based translation memory (if this language direction is also one of the project language directions).

Declaration

public List<TranslationProviderReference> ProjectTranslationMemories { get; set; }

Property Value

Type	Description
List TranslationProviderReference