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
System.Object
Cascade<T>
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Sdl.LanguagePlatform.TranslationMemoryApi.dll
public class Cascade<T>
where T : CascadeEntry
Type Parameters
| Name |
Description |
| T |
T represents the cascade entry type. A simple cascade can just use CascadeEntry but, for example,
project cascades need more information associated with each cascade entry and uses ProjectCascadeEntry.
|
Constructors
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, CultureInfo sourceLanguage, CultureInfo targetLanguage)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.IEnumerable<T> |
cascadeEntries |
cascade entries
|
| System.Boolean |
stopSearchingWhenResultsFound |
whether to stop searching when results have been found
|
| System.Boolean |
removeDuplicates |
remove duplicates
|
| System.Globalization.CultureInfo |
sourceLanguage |
source language
|
| System.Globalization.CultureInfo |
targetLanguage |
target language
|
Properties
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 |
| System.Collections.ObjectModel.ReadOnlyCollection<T> |
|
CascadeEntryIndexesUsed
Gets the Cascade Entry Indexes that were used in the search.
Declaration
public ConcurrentQueue<int> CascadeEntryIndexesUsed { get; }
Property Value
| Type |
Description |
| System.Collections.Concurrent.ConcurrentQueue<System.Int32> |
|
Gets whether duplicates should be removed from search results.
Declaration
public bool RemoveDuplicates { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
Gets the source language of this cascade.
Declaration
public CultureInfo SourceLanguage { get; }
Property Value
| Type |
Description |
| System.Globalization.CultureInfo |
|
Gets or sets whether to stop searching when results have been found.
Declaration
public bool StopSearchingWhenResultsFound { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
Gets the target language of this cascade.
Declaration
public CultureInfo TargetLanguage { get; }
Property Value
| Type |
Description |
| System.Globalization.CultureInfo |
|
Methods
Declaration
public ImportResult[] AddOrUpdateTranslationUnits(TranslationUnit[] translationUnits, int[] previousTranslationHashes, ImportSettings settings)
Parameters
Returns
Declaration
public ImportResult[] AddOrUpdateTranslationUnits(TranslationUnit[] translationUnits, int[] previousTranslationHashes, ImportSettings settings, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Returns
Declaration
public ImportResult[] AddOrUpdateTranslationUnitsMasked(TranslationUnit[] translationUnits, int[] previousTranslationHashes, ImportSettings settings, bool[] mask)
Parameters
Returns
Declaration
public ImportResult[] AddOrUpdateTranslationUnitsMasked(TranslationUnit[] translationUnits, int[] previousTranslationHashes, ImportSettings settings, bool[] mask, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Returns
Declaration
public ImportResult AddTranslationUnit(TranslationUnit translationUnit, ImportSettings settings)
Parameters
Returns
Declaration
public ImportResult AddTranslationUnit(TranslationUnit translationUnit, ImportSettings settings, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Returns
Declaration
public ImportResult[] AddTranslationUnits(TranslationUnit[] translationUnits, ImportSettings settings)
Parameters
Returns
Declaration
public ImportResult[] AddTranslationUnits(TranslationUnit[] translationUnits, ImportSettings settings, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Returns
Declaration
public ImportResult[] AddTranslationUnitsMasked(TranslationUnit[] translationUnits, ImportSettings settings, bool[] mask)
Parameters
Returns
Declaration
public ImportResult[] AddTranslationUnitsMasked(TranslationUnit[] translationUnits, ImportSettings settings, bool[] mask, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Returns
Gets a comma-delimited string of translation provider names.
Declaration
public string GetTranslationProviderNames()
Returns
| Type |
Description |
| System.String |
translation provider names
|
Getting Warning messages for Upgrade requirement.
Declaration
public IList<CascadeMessage> GetWarningMessage(T cascadeEntry, SearchSettings searchSettings)
Parameters
Returns
Declaration
public SearchResults SearchSegment(SearchSettings settings, Segment segment)
Parameters
Returns
Declaration
public SearchResults SearchSegment(SearchSettings settings, Segment segment, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Returns
Declaration
public SearchResults[] SearchSegments(SearchSettings settings, Segment[] segments)
Parameters
Returns
Declaration
public SearchResults[] SearchSegments(SearchSettings settings, Segment[] segments, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Returns
Declaration
public SearchResults[] SearchSegmentsMasked(SearchSettings settings, Segment[] segments, bool[] mask)
Parameters
Returns
Declaration
public SearchResultsMerged[] SearchSegmentsMasked(SearchSettings settings, Segment[] segments, bool[] mask, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Returns
Declaration
public SegmentAndSubsegmentSearchResultsMerged[] SearchSegmentsMasked(SearchSettings settings, SubsegmentSearchSettings subsegmentSettings, SubsegmentSearchCondition subsegmentSearchCondition, Segment[] segments, bool[] mask, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Returns
SearchText(SearchSettings, String)
Declaration
public SearchResults SearchText(SearchSettings settings, string segment)
Parameters
Returns
SearchText(SearchSettings, String, out IEnumerable<CascadeMessage>)
Declaration
public SearchResults SearchText(SearchSettings settings, string segment, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Returns
Declaration
public SearchResults SearchTranslationUnit(SearchSettings settings, TranslationUnit translationUnit)
Parameters
Returns
Declaration
public SearchResults SearchTranslationUnit(SearchSettings settings, TranslationUnit translationUnit, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Returns
Declaration
public SearchResults[] SearchTranslationUnits(SearchSettings settings, TranslationUnit[] tus)
Parameters
Returns
Declaration
public SearchResults[] SearchTranslationUnits(SearchSettings settings, TranslationUnit[] tus, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Returns
Declaration
public SegmentAndSubsegmentSearchResultsMerged[] SearchTranslationUnitsMasked(SearchSettings settings, SubsegmentSearchSettings subsegmentSettings, SubsegmentSearchCondition subsegmentSearchCondition, TranslationUnit[] translationUnits, bool[] mask, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Returns
Declaration
public SearchResults[] SearchTranslationUnitsMasked(SearchSettings settings, TranslationUnit[] translationUnits, bool[] mask)
Parameters
Returns
Declaration
public SearchResultsMerged[] SearchTranslationUnitsMasked(SearchSettings settings, TranslationUnit[] translationUnits, bool[] mask, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Returns
Declaration
public SubsegmentSearchResultsCollection[] SubsegmentSearchSegments(SubsegmentSearchSettings subsegmentSearchSettings, Segment[] segments, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Returns
Declaration
public ImportResult UpdateTranslationUnit(TranslationUnit translationUnit)
Parameters
Returns
Declaration
public ImportResult UpdateTranslationUnit(TranslationUnit translationUnit, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Returns
Declaration
public ImportResult[] UpdateTranslationUnits(TranslationUnit[] translationUnits)
Parameters
Returns
Declaration
public ImportResult[] UpdateTranslationUnits(TranslationUnit[] translationUnits, out IEnumerable<CascadeMessage> cascadeMessages)
Parameters
Returns