AbstractSearchSyntaxHelper Class

Helper methods for search condition syntax

Inheritance Hierarchy

System.Object
  CMS.Search.AbstractSearchSyntaxHelper
    CMS.Search.Lucene3.LuceneSearchSyntaxHelper

Namespace: CMS.Search
Assembly: CMS.Search (in CMS.Search.dll) Version: 8.2.23

Syntax

public abstract class AbstractSearchSyntaxHelper : ISearchSyntaxHelper

The AbstractSearchSyntaxHelper type exposes the following members.

Constructors

	Name	Description
Protected method	AbstractSearchSyntaxHelper

Methods

	Name	Description
Public method	AddSearchCondition	Adds the given search condition to the existing condition
Public method	CombineSearchCondition	Returns string with combined search index conditions.
Public method	EscapeKeyWords	Escapes the key words to be searched
Public method	ExpandWithSynonyms	Expands given search expression with synonyms. If the data base of synonyms for given language is not found, searchExpression is returned without any modifications.
Protected method	FieldNameEvaluator	Evaluator method, converts lowercase "to" to uppercase.
Protected method	FinalizeSearchCondition	Finalizes the search query to make sure that its syntax is consistent and valid
Protected method	GetClassNameCondition	Gets the search condition for a given list of class names
Protected method	GetCultureCondition	Gets the search condition for the given culture
Public method	GetExactPhraseCondition	Gets the exact phrase condition from the given phrase
Protected method	GetExtraConditions	Gets the extra conditions based on the given expression
Public method	GetFieldCondition(String, Object, Nullable<Boolean>)	Gets the search condition for the given field
Public method	GetFieldCondition(String, Object, Object, Nullable<Boolean>)	Gets the field condition for a range of values
Public method	GetFilterCondition	Returns condition for search filter row
Public method	GetGroup	Groups the expressions
Protected method	GetKeyWordsCondition	Gets the search condition for the given key words
Public method	GetNotCondition	Gets a not (except) condition from the given condition
Public method	GetRange	Gets the range expression
Public method	GetRequiredCondition	Gets a required condition from the given condition
Public method	IsEmptyCondition	Returns true if the given search condition is empty
Public method	ProcessSearchKeywords	Returns modified keywords string based on searchOptions.
Protected method	SplitKeyWords	Splits the given list of key words separated by space
Public method	TransformToFuzzySearch	Adds ~ signs to each term to force fuzzy search.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Protected property	FieldNameSyntaxRegex	Gets the regular expression for field name.