Class SmartSearchDataProvider
- Namespace
- Dynamicweb.SmartSearch
- Assembly
- Dynamicweb.Core.dll
public abstract class SmartSearchDataProvider : ConfigurableAddIn, ICloneable
- Inheritance
-
SmartSearchDataProvider
- Implements
- Derived
- Inherited Members
Constructors
SmartSearchDataProvider()
Initializes a new instance of the SmartSearchDataProvider class.
public SmartSearchDataProvider()
Properties
Configuration
Gets the name of the configuration file.
public string Configuration { get; set; }
Property Value
- string
The configuration file name.
CountPreCalculate
Gets or sets a value indicating whether count pre calculate.
public bool CountPreCalculate { get; protected set; }
Property Value
- bool
true
if pre calculate count; otherwise,false
.
EntityType
Gets the entity type.
public Type EntityType { get; }
Property Value
- Type
The provider entity type.
Name
Gets the provider name.
public string Name { get; }
Property Value
- string
The provider name.
PreviewDataDescriptionText
Gets the preview data description text.
public string PreviewDataDescriptionText { get; }
Property Value
- string
The preview data description text.
SmartSearch
Gets the SmartSearch related to the provider.
public SmartSearch SmartSearch { get; set; }
Property Value
- SmartSearch
The SmartSearch instance.
Methods
Clone()
Creates a new object that is a copy of the current instance.
public object Clone()
Returns
- object
A new object that is a copy of this instance.
GetCount(int, SmartSearchRuleGroupCollection)
Gets the count.
public int GetCount(int ResultsLimit, SmartSearchRuleGroupCollection QueryRules)
Parameters
ResultsLimit
intThe results limit.
QueryRules
SmartSearchRuleGroupCollectionThe query rules.
Returns
GetCountCacheKey(int, SmartSearchRuleGroupCollection)
Gets the count cache key.
protected static string GetCountCacheKey(int ResultsLimit, SmartSearchRuleGroupCollection QueryRules)
Parameters
ResultsLimit
intThe results limit.
QueryRules
SmartSearchRuleGroupCollectionThe query rules.
Returns
GetPreviewData(int, SmartSearchRuleGroupCollection, params SmartSearchSortInfo[])
Gets the preview data.
public DataTable GetPreviewData(int ResultsLimit, SmartSearchRuleGroupCollection QueryRules, params SmartSearchSortInfo[] SortParams)
Parameters
ResultsLimit
intThe results limit.
QueryRules
SmartSearchRuleGroupCollectionThe query rules.
SortParams
SmartSearchSortInfo[]The sort params.
Returns
GetRulesConditionOptions()
public List<SmartSearchOperator> GetRulesConditionOptions()
Returns
GetRulesDataFields()
Gets the rules data fields.
public List<SmartSearchRuleField> GetRulesDataFields()
Returns
GetSortingDataFields()
Gets the sorting data fields.
public List<SmartSearchRuleField> GetSortingDataFields()
Returns
OnGetCount(int, SmartSearchRuleGroupCollection)
Called when get count of the query results.
protected virtual int OnGetCount(int ResultsLimit, SmartSearchRuleGroupCollection QueryRules)
Parameters
ResultsLimit
intThe results limit.
QueryRules
SmartSearchRuleGroupCollectionThe query rules.
Returns
OnGetEntityType()
Get entity type
protected virtual Type OnGetEntityType()
Returns
OnGetPreviewData(int, SmartSearchRuleGroupCollection, SmartSearchSortInfo[])
Exec query and fill data fields
protected virtual DataTable OnGetPreviewData(int ResultsLimit, SmartSearchRuleGroupCollection QueryRules, SmartSearchSortInfo[] SortParams)
Parameters
ResultsLimit
intQueryRules
SmartSearchRuleGroupCollectionSortParams
SmartSearchSortInfo[]
Returns
OnGetPreviewDataDescriptionText()
Get preview data text description
protected virtual string OnGetPreviewDataDescriptionText()
Returns
OnGetRulesConditionOperators()
protected virtual List<SmartSearchOperator> OnGetRulesConditionOperators()
Returns
OnGetRulesDataFields()
Get data fields for rules
protected virtual List<SmartSearchRuleField> OnGetRulesDataFields()
Returns
OnGetSortingDataFields()
Get data fields for sorting
protected virtual List<SmartSearchRuleField> OnGetSortingDataFields()