Click or drag to resize

SearchDataProvider Class

Represents a data provider that aggregates data from the default search service application.
Inheritance Hierarchy

Namespace:  Colygon.MatchPoint.Search.DataProvider
Assembly:  Colygon.MatchPoint (in Colygon.MatchPoint.dll) Version: 2016.10.0.0
Syntax
C#
[SerializableAttribute]
public class SearchDataProvider : DataProviderWithConditions, 
	IFilterableDataProvider

The SearchDataProvider type exposes the following members.

Constructors
  NameDescription
Public methodSearchDataProvider
Initializes a new instance of the SearchDataProvider class
Top
Properties
  NameDescription
Public propertyAdvancedQuerySettings
Public propertyConditions
Contains the conditions of the data provider.
(Inherited from DataProviderWithConditions.)
Public propertyRowLimit
Top
Methods
  NameDescription
Public methodCreateInstance(String, IEnumerableString)
Returns the BaseDataProviderInstance object responsible for aggregating the data for this data provider.
(Overrides BaseDataProviderCreateInstance(String, IEnumerableString).)
Public methodCreateInstance(String, IEnumerableString, IEnumerableBaseCondition)
Returns the BaseDataProviderInstance object responsible for aggregating the data for this data provider.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetFieldNames
All available fields in the search.
(Overrides BaseDataProviderGetFieldNames(MPInstance).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldAllowComplexQueries
If set to false, quotation marks ('"') will be escaped and the query will be treated as a whole. Otherwise the FullTextCondition's input value will be added to the query as it is. This allows users to write raw KQL into the condition: "(Title:Bar* AND Number=42 OR (Foo))". Note: In order to use stemming 'AllowComplexQueries' has to be enabled.
Public fieldCacheExpirationMinutes
Specifies how long the data is cached (in minutes).
Public fieldCacheGranularity
Specifies how the data is cached. Choose 'User' if the query depends on the current user (e.g. user ID in the query or security trimmed data).
Public fieldCacheKey
Specifies the cache key for this data provider.
(Inherited from BaseDataProvider.)
Public fieldEnableStemming
If enabled, full text search stemming is activated (not recommended because this might result in unpredictable results). Stemming does not work if 'AllowComplexQueries' is set to false.
Public fieldLcidExpression
Specifies the language (LCID) to determine which wordbreaker, stemmer, thesaurus, and other language-sensitive components to use in the query.
Public fieldRanking
Specifies the ranking settings used for the search queries.
Public fieldResultSourceExpression
Specifies the result source used by the search query. If the result source is specified using an expression, the expression evaluation type is expected to be the ID or the name of the result source.
Public fieldShowAlertMeButton
If enabled, an 'Alert me' button will be displayed beneath the grid. This field is valid only within a DataGrid or Composite Web Part configuration.
Public fieldSortFields
Contains fields which should be used to sort the search results.
Public fieldTrimDuplicates
Specifies, whether duplicates are removed before sorting, selecting, and returning result items. Note that if this is set to true it's possible that the native refinement count is wrong.
Top
Remarks
  • #APIChange 4.0: Removed ScopeExpression
  • #APIChange 4.0: added ResultSourceExpression
  • #APIChange 4.0: added AllowComplexQueries
  • #APIChange 5.0: removed public virtual BaseDataProviderInstance CreateInstance(IEnumerable<string> columnNames, IEnumerable<BaseCondition> conditions)
Remarks
This is a MatchPoint configuration class.
See Also