Class Cascade<T>
A cascade is used to perform searches and updates across many different translation provider language directions. Each translation provider language direction is represented by a cascade entry that contains other information with regards to how it should be treated
- e.g. what penalties should be applied during searches.
Inheritance
Inherited Members
Namespace: Sdl.LanguagePlatform.TranslationMemoryApi
Assembly: Sdl.LanguagePlatform.TranslationMemoryApi.dll
Syntax
public class Cascade<T>
where T : CascadeEntry
Type Parameters
Name | Description |
---|---|
T | T represents the cascade entry type. A simple cascade can just use Cascade |
Constructors
Cascade(IEnumerable<T>, Boolean, Boolean, CultureCode, CultureCode)
Constructor that takes the cascade entries, cascade search mode, remove duplicates, source language, and target language.
Declaration
public Cascade(IEnumerable<T> cascadeEntries, bool stopSearchingWhenResultsFound, bool removeDuplicates, CultureCode sourceLanguage, CultureCode targetLanguage)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<T> | cascadeEntries | cascade entries |
Boolean | stopSearchingWhenResultsFound | whether to stop searching when results have been found |
Boolean | removeDuplicates | remove duplicates |
Culture |
sourceLanguage | source language |
Culture |
targetLanguage | target language |
Properties
CascadeEntries
Gets the cascade entries, which refer to a translation provider language direction and specify and optional penalty to apply when perforing look-ups.
Declaration
public ReadOnlyCollection<T> CascadeEntries { get; }
Property Value
Type | Description |
---|---|
Read |
CascadeEntryIndexesUsed
Gets the Cascade Entry Indexes that were used in the search.
Declaration
public ConcurrentQueue<int> CascadeEntryIndexesUsed { get; }
Property Value
Type | Description |
---|---|
Concurrent |
RemoveDuplicates
Gets whether duplicates should be removed from search results.
Declaration
public bool RemoveDuplicates { get; }
Property Value
Type | Description |
---|---|
Boolean |
SourceLanguage
Gets the source language of this cascade.
Declaration
public CultureCode SourceLanguage { get; }
Property Value
Type | Description |
---|---|
Culture |
StopSearchingWhenResultsFound
Gets or sets whether to stop searching when results have been found.
Declaration
public bool StopSearchingWhenResultsFound { get; }
Property Value
Type | Description |
---|---|
Boolean |
Remarks
"Stop searching" means that the cascade will not search the next translation provider when results have been found in the current translation provider.
TargetLanguage
Gets the target language of this cascade.
Declaration
public CultureCode TargetLanguage { get; }
Property Value
Type | Description |
---|---|
Culture |
Methods
AddOrUpdateTranslationUnits(TranslationUnit[], Int32[], ImportSettings)
Executes Add
Declaration
public ImportResult[] AddOrUpdateTranslationUnits(TranslationUnit[] translationUnits, int[] previousTranslationHashes, ImportSettings settings)
Parameters
Type | Name | Description |
---|---|---|
Translation |
translationUnits | |
Int32[] | previousTranslationHashes | |
Import |
settings |
Returns
Type | Description |
---|---|
Import |
AddOrUpdateTranslationUnits(TranslationUnit[], Int32[], ImportSettings, out IEnumerable<CascadeMessage>)
Executes Add
Declaration
public ImportResult[] AddOrUpdateTranslationUnits(TranslationUnit[] translationUnits, int[] previousTranslationHashes, ImportSettings settings, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Type | Name | Description |
---|---|---|
Translation |
translationUnits | |
Int32[] | previousTranslationHashes | |
Import |
settings | |
IEnumerable<Cascade |
cascadeMessages |
Returns
Type | Description |
---|---|
Import |
AddOrUpdateTranslationUnitsMasked(TranslationUnit[], Int32[], ImportSettings, Boolean[])
Executes Add
Declaration
public ImportResult[] AddOrUpdateTranslationUnitsMasked(TranslationUnit[] translationUnits, int[] previousTranslationHashes, ImportSettings settings, bool[] mask)
Parameters
Type | Name | Description |
---|---|---|
Translation |
translationUnits | |
Int32[] | previousTranslationHashes | |
Import |
settings | |
Boolean[] | mask |
Returns
Type | Description |
---|---|
Import |
AddOrUpdateTranslationUnitsMasked(TranslationUnit[], Int32[], ImportSettings, Boolean[], out IEnumerable<CascadeMessage>)
Executes Add
Declaration
public ImportResult[] AddOrUpdateTranslationUnitsMasked(TranslationUnit[] translationUnits, int[] previousTranslationHashes, ImportSettings settings, bool[] mask, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Type | Name | Description |
---|---|---|
Translation |
translationUnits | |
Int32[] | previousTranslationHashes | |
Import |
settings | |
Boolean[] | mask | |
IEnumerable<Cascade |
cascadeMessages |
Returns
Type | Description |
---|---|
Import |
AddTranslationUnit(TranslationUnit, ImportSettings)
Executes Add
Declaration
public ImportResult AddTranslationUnit(TranslationUnit translationUnit, ImportSettings settings)
Parameters
Type | Name | Description |
---|---|---|
Translation |
translationUnit | |
Import |
settings |
Returns
Type | Description |
---|---|
Import |
AddTranslationUnit(TranslationUnit, ImportSettings, out IEnumerable<CascadeMessage>)
Executes Add
Declaration
public ImportResult AddTranslationUnit(TranslationUnit translationUnit, ImportSettings settings, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Type | Name | Description |
---|---|---|
Translation |
translationUnit | |
Import |
settings | |
IEnumerable<Cascade |
cascadeMessages |
Returns
Type | Description |
---|---|
Import |
AddTranslationUnits(TranslationUnit[], ImportSettings)
Executes Add
Declaration
public ImportResult[] AddTranslationUnits(TranslationUnit[] translationUnits, ImportSettings settings)
Parameters
Type | Name | Description |
---|---|---|
Translation |
translationUnits | |
Import |
settings |
Returns
Type | Description |
---|---|
Import |
AddTranslationUnits(TranslationUnit[], ImportSettings, out IEnumerable<CascadeMessage>)
Executes Add
Declaration
public ImportResult[] AddTranslationUnits(TranslationUnit[] translationUnits, ImportSettings settings, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Type | Name | Description |
---|---|---|
Translation |
translationUnits | |
Import |
settings | |
IEnumerable<Cascade |
cascadeMessages |
Returns
Type | Description |
---|---|
Import |
AddTranslationUnitsMasked(TranslationUnit[], ImportSettings, Boolean[])
Executes Add
Declaration
public ImportResult[] AddTranslationUnitsMasked(TranslationUnit[] translationUnits, ImportSettings settings, bool[] mask)
Parameters
Type | Name | Description |
---|---|---|
Translation |
translationUnits | |
Import |
settings | |
Boolean[] | mask |
Returns
Type | Description |
---|---|
Import |
AddTranslationUnitsMasked(TranslationUnit[], ImportSettings, Boolean[], out IEnumerable<CascadeMessage>)
Executes Add
Declaration
public ImportResult[] AddTranslationUnitsMasked(TranslationUnit[] translationUnits, ImportSettings settings, bool[] mask, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Type | Name | Description |
---|---|---|
Translation |
translationUnits | |
Import |
settings | |
Boolean[] | mask | |
IEnumerable<Cascade |
cascadeMessages |
Returns
Type | Description |
---|---|
Import |
GetTranslationProviderNames()
Gets a comma-delimited string of translation provider names.
Declaration
public string GetTranslationProviderNames()
Returns
Type | Description |
---|---|
String | translation provider names |
GetWarningMessage(T, SearchSettings)
Getting Warning messages for Upgrade requirement.
Declaration
public IList<CascadeMessage> GetWarningMessage(T cascadeEntry, SearchSettings searchSettings)
Parameters
Type | Name | Description |
---|---|---|
T | cascadeEntry | |
Search |
searchSettings |
Returns
Type | Description |
---|---|
IList<Cascade |
SearchSegment(SearchSettings, Segment)
Executes Search
Declaration
public SearchResults SearchSegment(SearchSettings settings, Segment segment)
Parameters
Type | Name | Description |
---|---|---|
Search |
settings | |
Segment | segment |
Returns
Type | Description |
---|---|
Search |
SearchSegment(SearchSettings, Segment, out IEnumerable<CascadeMessage>)
Executes Search
Declaration
public SearchResults SearchSegment(SearchSettings settings, Segment segment, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Type | Name | Description |
---|---|---|
Search |
settings | |
Segment | segment | |
IEnumerable<Cascade |
cascadeMessages |
Returns
Type | Description |
---|---|
Search |
SearchSegments(SearchSettings, Segment[])
Executes Search
Declaration
public SearchResults[] SearchSegments(SearchSettings settings, Segment[] segments)
Parameters
Type | Name | Description |
---|---|---|
Search |
settings | |
Segment[] | segments |
Returns
Type | Description |
---|---|
Search |
SearchSegments(SearchSettings, Segment[], out IEnumerable<CascadeMessage>)
Executes Search
Declaration
public SearchResults[] SearchSegments(SearchSettings settings, Segment[] segments, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Type | Name | Description |
---|---|---|
Search |
settings | |
Segment[] | segments | |
IEnumerable<Cascade |
cascadeMessages |
Returns
Type | Description |
---|---|
Search |
SearchSegmentsMasked(SearchSettings, Segment[], Boolean[])
Executes Search
Declaration
public SearchResults[] SearchSegmentsMasked(SearchSettings settings, Segment[] segments, bool[] mask)
Parameters
Type | Name | Description |
---|---|---|
Search |
settings | |
Segment[] | segments | |
Boolean[] | mask |
Returns
Type | Description |
---|---|
Search |
SearchSegmentsMasked(SearchSettings, Segment[], Boolean[], out IEnumerable<CascadeMessage>)
Executes Search
Declaration
public SearchResultsMerged[] SearchSegmentsMasked(SearchSettings settings, Segment[] segments, bool[] mask, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Type | Name | Description |
---|---|---|
Search |
settings | |
Segment[] | segments | |
Boolean[] | mask | |
IEnumerable<Cascade |
cascadeMessages |
Returns
Type | Description |
---|---|
Search |
SearchSegmentsMasked(SearchSettings, SubsegmentSearchSettings, SubsegmentSearchCondition, Segment[], Boolean[], out IEnumerable<CascadeMessage>)
Executes Search
Declaration
public SegmentAndSubsegmentSearchResultsMerged[] SearchSegmentsMasked(SearchSettings settings, SubsegmentSearchSettings subsegmentSettings, SubsegmentSearchCondition subsegmentSearchCondition, Segment[] segments, bool[] mask, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Type | Name | Description |
---|---|---|
Search |
settings | |
Subsegment |
subsegmentSettings | |
Subsegment |
subsegmentSearchCondition | |
Segment[] | segments | |
Boolean[] | mask | |
IEnumerable<Cascade |
cascadeMessages |
Returns
Type | Description |
---|---|
Segment |
SearchText(SearchSettings, String)
Executes Search
Declaration
public SearchResults SearchText(SearchSettings settings, string segment)
Parameters
Type | Name | Description |
---|---|---|
Search |
settings | |
String | segment |
Returns
Type | Description |
---|---|
Search |
SearchText(SearchSettings, String, out IEnumerable<CascadeMessage>)
Executes Search
Declaration
public SearchResults SearchText(SearchSettings settings, string segment, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Type | Name | Description |
---|---|---|
Search |
settings | |
String | segment | |
IEnumerable<Cascade |
cascadeMessages |
Returns
Type | Description |
---|---|
Search |
SearchTranslationUnit(SearchSettings, TranslationUnit)
Executes Search
Declaration
public SearchResults SearchTranslationUnit(SearchSettings settings, TranslationUnit translationUnit)
Parameters
Type | Name | Description |
---|---|---|
Search |
settings | |
Translation |
translationUnit |
Returns
Type | Description |
---|---|
Search |
SearchTranslationUnit(SearchSettings, TranslationUnit, out IEnumerable<CascadeMessage>)
Executes Search
Declaration
public SearchResults SearchTranslationUnit(SearchSettings settings, TranslationUnit translationUnit, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Type | Name | Description |
---|---|---|
Search |
settings | |
Translation |
translationUnit | |
IEnumerable<Cascade |
cascadeMessages |
Returns
Type | Description |
---|---|
Search |
SearchTranslationUnits(SearchSettings, TranslationUnit[])
Executes Search
Declaration
public SearchResults[] SearchTranslationUnits(SearchSettings settings, TranslationUnit[] tus)
Parameters
Type | Name | Description |
---|---|---|
Search |
settings | |
Translation |
tus |
Returns
Type | Description |
---|---|
Search |
SearchTranslationUnits(SearchSettings, TranslationUnit[], out IEnumerable<CascadeMessage>)
Executes Search
Declaration
public SearchResults[] SearchTranslationUnits(SearchSettings settings, TranslationUnit[] tus, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Type | Name | Description |
---|---|---|
Search |
settings | |
Translation |
tus | |
IEnumerable<Cascade |
cascadeMessages |
Returns
Type | Description |
---|---|
Search |
SearchTranslationUnitsMasked(SearchSettings, SubsegmentSearchSettings, SubsegmentSearchCondition, TranslationUnit[], Boolean[], out IEnumerable<CascadeMessage>)
Executes Search
Declaration
public SegmentAndSubsegmentSearchResultsMerged[] SearchTranslationUnitsMasked(SearchSettings settings, SubsegmentSearchSettings subsegmentSettings, SubsegmentSearchCondition subsegmentSearchCondition, TranslationUnit[] translationUnits, bool[] mask, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Type | Name | Description |
---|---|---|
Search |
settings | |
Subsegment |
subsegmentSettings | |
Subsegment |
subsegmentSearchCondition | |
Translation |
translationUnits | |
Boolean[] | mask | |
IEnumerable<Cascade |
cascadeMessages |
Returns
Type | Description |
---|---|
Segment |
SearchTranslationUnitsMasked(SearchSettings, TranslationUnit[], Boolean[])
Executes Search
Declaration
public SearchResults[] SearchTranslationUnitsMasked(SearchSettings settings, TranslationUnit[] translationUnits, bool[] mask)
Parameters
Type | Name | Description |
---|---|---|
Search |
settings | |
Translation |
translationUnits | |
Boolean[] | mask |
Returns
Type | Description |
---|---|
Search |
SearchTranslationUnitsMasked(SearchSettings, TranslationUnit[], Boolean[], out IEnumerable<CascadeMessage>)
Executes Search
Declaration
public SearchResultsMerged[] SearchTranslationUnitsMasked(SearchSettings settings, TranslationUnit[] translationUnits, bool[] mask, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Type | Name | Description |
---|---|---|
Search |
settings | |
Translation |
translationUnits | |
Boolean[] | mask | |
IEnumerable<Cascade |
cascadeMessages |
Returns
Type | Description |
---|---|
Search |
SubsegmentSearchSegments(SubsegmentSearchSettings, Segment[], out IEnumerable<CascadeMessage>)
Executes Subsegment
Declaration
public SubsegmentSearchResultsCollection[] SubsegmentSearchSegments(SubsegmentSearchSettings subsegmentSearchSettings, Segment[] segments, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Type | Name | Description |
---|---|---|
Subsegment |
subsegmentSearchSettings | |
Segment[] | segments | |
IEnumerable<Cascade |
cascadeMessages |
Returns
Type | Description |
---|---|
Subsegment |
UpdateTranslationUnit(TranslationUnit)
Executes Update
Declaration
public ImportResult UpdateTranslationUnit(TranslationUnit translationUnit)
Parameters
Type | Name | Description |
---|---|---|
Translation |
translationUnit |
Returns
Type | Description |
---|---|
Import |
UpdateTranslationUnit(TranslationUnit, out IEnumerable<CascadeMessage>)
Executes Update
Declaration
public ImportResult UpdateTranslationUnit(TranslationUnit translationUnit, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Type | Name | Description |
---|---|---|
Translation |
translationUnit | |
IEnumerable<Cascade |
cascadeMessages |
Returns
Type | Description |
---|---|
Import |
UpdateTranslationUnits(TranslationUnit[])
Executes Update
Declaration
public ImportResult[] UpdateTranslationUnits(TranslationUnit[] translationUnits)
Parameters
Type | Name | Description |
---|---|---|
Translation |
translationUnits |
Returns
Type | Description |
---|---|
Import |
UpdateTranslationUnits(TranslationUnit[], out IEnumerable<CascadeMessage>)
Executes Update
Declaration
public ImportResult[] UpdateTranslationUnits(TranslationUnit[] translationUnits, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Type | Name | Description |
---|---|---|
Translation |
translationUnits | |
IEnumerable<Cascade |
cascadeMessages |
Returns
Type | Description |
---|---|
Import |