Class BaseSmartSearchDataProvider

Namespace

Dynamicweb.SmartSearch.DataProviders

Assembly

Dynamicweb.SmartSearch.dll

A smart search data provider. Inherit from ConfigurableAddIn class

[AddInName("Dynamicweb.Modules.Searching.SmartSearch")]
[AddInGroup("SmartSearchDataProvider")]
[AddInIgnore(true)]
[AddInDescription("Base smart search data provider")]
public class BaseSmartSearchDataProvider : ConfigurableAddIn, ICloneable

Inheritance

object

ConfigurableAddIn

BaseSmartSearchDataProvider

Implements

ICloneable

BaseSmartSearchDataProvider

SmartSearchDataProvider<T>

Inherited Members

ConfigurableAddIn.UpdateFromPost(NameValueCollection)

ConfigurableAddIn.GetIdSuitableString(string)

ConfigurableAddIn.LoadParametersFromXml(string)

ConfigurableAddIn.GetParametersToXml()

ConfigurableAddIn.GetParametersToXml(bool)

ConfigurableAddIn.SetValue(string, object)

ConfigurableAddIn.GetInstanceFromParameterXml<T>(string)

ConfigurableAddIn.RenderAdditionalContent(TextWriter)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

BaseSmartSearchDataProvider()

Initializes a new instance of the BaseSmartSearchDataProvider class.

public BaseSmartSearchDataProvider()

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 int

The results limit.

QueryRules SmartSearchRuleGroupCollection

The query rules.

Returns

int

GetCount(int, SmartSearchRulesGroupCollection)

Gets the count.

[Obsolete]
public int GetCount(int ResultsLimit, SmartSearchRulesGroupCollection QueryRules)

Parameters

ResultsLimit int

The results limit.

QueryRules SmartSearchRulesGroupCollection

The query rules.

Returns

int

GetCountCacheKey(int, SmartSearchRuleGroupCollection)

Gets the count cache key.

protected static string GetCountCacheKey(int ResultsLimit, SmartSearchRuleGroupCollection QueryRules)

Parameters

ResultsLimit int

The results limit.

QueryRules SmartSearchRuleGroupCollection

The query rules.

Returns

string

GetCountCacheKey(int, SmartSearchRulesGroupCollection)

Gets the count cache key.

[Obsolete("Use GetCountCacheKey instead")]
protected static string GetCountCacheKey(int ResultsLimit, SmartSearchRulesGroupCollection QueryRules)

Parameters

ResultsLimit int

The results limit.

QueryRules SmartSearchRulesGroupCollection

The query rules.

Returns

string

GetPreviewData(int, SmartSearchRuleGroupCollection, params SmartSearchSortInfo[])

Gets the preview data.

public DataTable GetPreviewData(int ResultsLimit, SmartSearchRuleGroupCollection QueryRules, params SmartSearchSortInfo[] SortParams)

Parameters

ResultsLimit int

The results limit.

QueryRules SmartSearchRuleGroupCollection

The query rules.

SortParams SmartSearchSortInfo[]

The sort params.

Returns

DataTable

GetPreviewData(int, SmartSearchRulesGroupCollection, params SmartSearchSortInfo[])

Gets the preview data.

[Obsolete]
public DataTable GetPreviewData(int ResultsLimit, SmartSearchRulesGroupCollection QueryRules, params SmartSearchSortInfo[] SortParams)

Parameters

ResultsLimit int

The results limit.

QueryRules SmartSearchRulesGroupCollection

The query rules.

SortParams SmartSearchSortInfo[]

The sort params.

Returns

DataTable

GetRulesConditionOptions()

public List<SmartSearchOperator> GetRulesConditionOptions()

Returns

List<SmartSearchOperator>

GetRulesDataFields()

Gets the rules data fields.

public List<SmartSearchRuleField> GetRulesDataFields()

Returns

List<SmartSearchRuleField>

GetSortingDataFields()

Gets the sorting data fields.

public List<SmartSearchRuleField> GetSortingDataFields()

Returns

List<SmartSearchRuleField>

OnGetCount(int, SmartSearchRuleGroupCollection)

Called when get count of the query results.

protected virtual int OnGetCount(int ResultsLimit, SmartSearchRuleGroupCollection QueryRules)

Parameters

ResultsLimit int

The results limit.

QueryRules SmartSearchRuleGroupCollection

The query rules.

Returns

int

OnGetCount(int, SmartSearchRulesGroupCollection)

Called when get count of the query results.

[Obsolete]
protected virtual int OnGetCount(int ResultsLimit, SmartSearchRulesGroupCollection QueryRules)

Parameters

ResultsLimit int

The results limit.

QueryRules SmartSearchRulesGroupCollection

The query rules.

Returns

int

OnGetEntityType()

Get entity type

protected virtual Type OnGetEntityType()

Returns

Type

OnGetPreviewData(int, SmartSearchRuleGroupCollection, SmartSearchSortInfo[])

Exec query and fill data fields

protected virtual DataTable OnGetPreviewData(int ResultsLimit, SmartSearchRuleGroupCollection QueryRules, SmartSearchSortInfo[] SortParams)

Parameters

ResultsLimit int

QueryRules SmartSearchRuleGroupCollection

SortParams SmartSearchSortInfo[]

Returns

DataTable

OnGetPreviewData(int, SmartSearchRulesGroupCollection, SmartSearchSortInfo[])

Exec query and fill data fields

[Obsolete]
protected virtual DataTable OnGetPreviewData(int ResultsLimit, SmartSearchRulesGroupCollection QueryRules, SmartSearchSortInfo[] SortParams)

Parameters

ResultsLimit int

QueryRules SmartSearchRulesGroupCollection

SortParams SmartSearchSortInfo[]

Returns

DataTable

OnGetPreviewDataDescriptionText()

Get preview data text description

protected virtual string OnGetPreviewDataDescriptionText()

Returns

string

OnGetRulesConditionOperators()

protected virtual List<SmartSearchOperator> OnGetRulesConditionOperators()

Returns

List<SmartSearchOperator>

OnGetRulesDataFields()

Get data fields for rules

protected virtual List<SmartSearchRuleField> OnGetRulesDataFields()

Returns

List<SmartSearchRuleField>

OnGetSortingDataFields()

Get data fields for sorting

protected virtual List<SmartSearchRuleField> OnGetSortingDataFields()

Returns

List<SmartSearchRuleField>