| SearchResults Class |
Represents a set of results returned by the translation memory after a search operation for a given input (segment/translation unit/string).
Inheritance HierarchySystemObject
Sdl.LanguagePlatform.TranslationMemorySearchResults
Sdl.LanguagePlatform.TranslationMemorySearchResultsMerged
Sdl.LanguagePlatform.TranslationMemorySubsegmentSearchResults
Sdl.LanguagePlatform.TranslationMemorySearchResults
Sdl.LanguagePlatform.TranslationMemorySearchResultsMerged
Sdl.LanguagePlatform.TranslationMemorySubsegmentSearchResults
Namespace: Sdl.LanguagePlatform.TranslationMemory
Assembly: Sdl.LanguagePlatform.TranslationMemory (in Sdl.LanguagePlatform.TranslationMemory.dll) Version: 1.6.0.0 (1.7.3662.0)
SyntaxThe SearchResults type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SearchResults |
Initializes a new instance with default values.
|
| SearchResults(SortSpecification) |
Initializes a new instance with the specified sort order.
|
Properties| Name | Description | |
|---|---|---|
 | Count |
Gets the number of results in this instance.
|
| DocumentPlaceables |
Gets or sets the source segment placeables. The value is usually set by
the search engine.
|
| Item |
Gets or sets the search results at the specified index in the collection.
|
| MultipleTranslations |
Gets or sets the flag whether there exist multiple exact matches in the result set. Note that there also is a MultipleTranslationsPenalty
in each match result. However, the penalty will only be set if the malus is > 0, but the MultipleTrnaslations flag will
be set independently.
|
| Results |
Gets or sets the sesarch results.
|
| SortOrder |
Gets or sets the sort order. The search results are not re-sorted if this
field is set. To re-sort, call Sort() after setting the value.
|
| SourceHash |
Gets or sets the source segment's hash value.
|
| SourceSegment |
Gets or sets the document source segment for this instance. The value
is set by the search engine.
|
| SourceWordCounts |
Gets or sets the source word counts for this instance.
|
Methods| Name | Description | |
|---|---|---|
| Add |
Adds a new search result to the collection.
|
 | AreEqual |
Determines whether two search results are equal, by comparing the segments of the
memory translation units.
|
| Cap |
Caps the number of search results to at most maxCapacity elements. If the object holds
less than the maximum number, this method has no effect.
|
| CheckForMultipleTranslations |
Count the number of exact matches in the result and set the MultipleTranslations flag and penalty accordingly.
This is only valid for normal searches; nothing will be changed for concordance searches.
|
| Clear |
Removes all results.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Merge |
Appends addtional search results to the current list of search results. Note that other fields, such as
the source tokens or the source word count, are not merged (although they may differ for cross-TM
searches).
|
| RemoveAll |
Removes all the elements that match the condition defined by the specified predicate
|
| RemoveDuplicates |
Removes any duplicate search results. The duplicate with the lowest index
is kept, and other duplicates are removed.
|
| RemoveDuplicates(FuncSearchResult, SearchResult, SearchResult) |
Removes any duplicate search results.
|
| Sort |
Sorts the results in this instance using the currently set sort order (see SortOrder),
or the default sort order if no sort order is set.
|
| Sort(String) |
Sorts the results in this instance based on the specified sort order.
|
| Sort(SortSpecification) |
Sorts the results in this instance based on the specified sort order.
|
| Sort(SortSpecification, SearchResultsSearchResultComparer) |
Sorts the results in this instance based on the specified sort order.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
 | DefaultSortOrder |
The default sort order, in string representation, for normal searches. The
primary sort key is the score (descending), the secondary sort key is the
use count (descending), and the tertiary sort key is the use date (descending).
|
| DefaultSortOrderConcordance |
The default sort order, in string representation, for concordance searches. The
primary sort key is the score (descending), the secondary sort key is the
change date (descending), and the tertiary sort key is the use count (descending).
|
See AlsoCommunityComments