Search Expressions

AndExpression

Defines an expression representing an "and" operator.

Namespace

Ektron.Cms.Search.Expressions.AndExpression

Properties

  • Left. Gets the left branch of the binary expression tree.
  • Right. Gets the right branch of the binary expression tree.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to process the current expression.
  • AndExpression(). Constructor.
  • AndExpression(Expression,Expression). Constructor.

BinaryExpression

Defines an expression representing a binary operator.

Namespace

Ektron.Cms.Search.Expressions.BinaryExpression

Properties

  • Left. Gets the left branch of the binary expression tree.
  • Right. Gets the right branch of the binary expression tree.

Methods

  • ValidateComparisonExpression(Expression,Expression). Validates a comparison expression in which the 'left' expression must be of type PropertyExpression and the 'right' expression must be of type ValueExpression.

BooleanMultiValuePropertyExpression

Defines an expression representing a boolean index field which may contain multiple values.

Namespace

Ektron.Cms.Search.Expressions.BooleanMultiValuePropertyExpression

Properties

  • Category. Gets or sets the CMS category by which this property is classified.
  • Name. Gets or sets the internal property name.
  • ValueType. Gets or sets the data type of the values that may be associated with this property.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • BooleanMultiValuePropertyExpression(String). Constructor.
  • Contains(Boolean). Constructs a ContainsExpression using the current object as its left branch and the specified value as its right branch.
  • IsNotNull(). Creates an 'IsNull' expression. (Not supported)
  • IsNull(). Creates an 'IsNotNull' expression. (Not supported)

Remarks

  • FAST Search for Sharepoint 2010. Multi-value properties are not supported when your search provider is Microsoft FAST Search for SharePoint 2010.
  • Search Server 2010. Multi-value properties are not supported when your search provider is Microsoft Search Server 2010.
  • Solr. Field names in Apache Solr are case-sensitive. When constructing a PropertyExpression for a custom Solr index field, ensure that the proper casing is applied.

BooleanPropertyExpression

Defines an expression representing a boolean index field.

Namespace

Ektron.Cms.Search.Expressions.BooleanPropertyExpression

Properties

  • Category. Gets or sets the CMS category by which this property is classified.
  • Name. Gets or sets the internal property name.
  • ValueType. Gets or sets the data type of the values that may be associated with this property.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to process the current expression.
  • AsMultiValue(). Returns a reference to the multi-value form of this property expression, typically used to retrieve a collection of values from the index.

    NOTE: An index field must be specifically configured to process multi-value data for this to be applicable. Not all search providers support this behavior.

  • BooleanPropertyExpression(String). Constructor.
  • EqualTo(Boolean). Constructs an EqualsExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • NotEqualTo(Boolean). Constructs an NotEqualsExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.

Remarks

  • Solr. Field names in Apache Solr are case sensitive. When constructing a PropertyExpression for a custom Solr index field, ensure that the proper casing is applied.

BooleanValueExpression

Defines an expression representing a boolean value.

Namespace

Ektron.Cms.Search.Expressions.BooleanValueExpression

Properties

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.

ContainsExpression

Defines an expression representing a "contains" operator.

Namespace

Ektron.Cms.Search.Expressions.ContainsExpression

Properties

  • Forms. Gets or sets which alternative word forms should also be considered when searching for the specified phrase.
  • Phrase. Gets or sets the search phrase for this expression.
  • Property. Gets the property to evaluate.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • ContainsExpression(). Constructor.
  • ContainsExpression(BooleanMultiValuePropertyExpression,Boolean). Constructor.
  • ContainsExpression(DateMultiValuePropertyExpression,DateTime). Constructor.
  • ContainsExpression(DecimalMultiValuePropertyExpression,Double). Constructor.
  • ContainsExpression(IntegerMultiValuePropertyExpression,Int64). Constructor.
  • ContainsExpression(PropertyExpression,Expression). Constructor.
  • ContainsExpression(PropertyExpression,Expression,WordForms). Constructor.
  • ContainsExpression(String). Constructor.
  • ContainsExpression(StringMultiValuePropertyExpression,String). Constructor.
  • ContainsExpression(StringPropertyExpression,String). Constructor.
  • ContainsExpression(StringPropertyExpression,StringValueExpression). Constructor.
  • ContainsExpression(StringPropertyExpression,String,WordForms). Constructor.
  • ContainsExpression(String,WordForms). Constructor.

Remarks

  • All Providers. Use caution when including special characters in your expressions as your search provider may interpret these as wildcards. This can have an unintended performance impact. Consult your search provider vendor's documentation for information regarding how to safely escape these characters.
  • FAST Search for Sharepoint 2010. The WordForms parameter is not supported when your search provider is Microsoft FAST Search for SharePoint. Instead, use the fields exposed directly on the KeywordSearchCriteria class (EnableStemming, and so on) to modify this behavior.
  • Solr. The WordForms parameter is not supported when your search provider is Apache Solr. Stemming and other similar features cannot be toggled at query-time. They are configured on a field by field basis in the schema.xml for a given Solr core. If a different behavior is required, you should consider customizing the index schema for your site.

DateMultiValuePropertyExpression

Defines an expression representing a date index field which may contain multiple values.

Namespace

Ektron.Cms.Search.Expressions.DateMultiValuePropertyExpression

Properties

  • Category. Gets or sets the CMS category by which this property is classified.
  • Name. Gets or sets the internal property name.
  • ValueType. Gets or sets the data type of the values that may be associated with this property.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • Contains(DateTime). Constructs a ContainsExpression using the current object as its left branch and the specified value as its right branch.
  • DateMultiValuePropertyExpression(String). Constructor.
  • IsNotNull(). Creates an 'IsNull' expression. (Not supported)
  • IsNull(). Creates an 'IsNotNull' expression. (Not supported)

Remarks

  • FAST Search for Sharepoint 2010. Multi-value properties are not supported when your search provider is Microsoft FAST Search for SharePoint 2010.
  • Search Server 2010. Multi-value properties are not supported when your search provider is Microsoft Search Server 2010.
  • Solr. Field names in Apache Solr are case sensitive. When constructing a PropertyExpression for a custom Solr index field, ensure that the proper casing is applied.

DatePropertyExpression

Defines an expression representing a date index field.

Namespace

Ektron.Cms.Search.Expressions.DatePropertyExpression

Properties

  • Category. Gets or sets the CMS category by which this property is classified.
  • Name. Gets or sets the internal property name.
  • ValueType. Gets or sets the data type of the values that may be associated with this property.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node
  • AsMultiValue(). Returns a reference to the multi-value form of this property expression, typically used to retrieve a collection of values from the index.

    NOTE: An index field must be specifically configured to process multi-value data for this to be applicable. Not all search providers support this behavior.

  • DatePropertyExpression(String). Constructor.
  • EqualTo(DateTime). Constructs an EqualToExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • GreaterThan(DateTime). Constructs a GreaterThanExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • GreaterThanOrEqualTo(DateTime). Constructs a GreaterThanOrEqualsExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • LessThan(DateTime). Constructs an LessThanExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • LessThanOrEqualTo(DateTime). Constructs an LessThanOrEqualsExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • NotEqualTo(DateTime). Constructs an NotEqualToExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.

Remarks

  • Solr. Field names in Apache Solr are case-sensitive. When constructing a PropertyExpression for a custom Solr index field, ensure that the proper casing is applied.

DateValueExpression

Defines an expression representing a date value.

Namespace

Ektron.Cms.Search.Expressions.DateValueExpression

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.

DecimalMultiValuePropertyExpression

Defines an expression representing a decimal index field which may contain multiple values.

Namespace

Ektron.Cms.Search.Expressions.DecimalMultiValuePropertyExpression

Properties

  • Category. Gets or sets the CMS category by which this property is classified.
  • Name. Gets or sets the internal property name.
  • ValueType. Gets or sets the data type of the values that may be associated with this property.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • Contains(Double). Constructs a ContainsExpression using the current object as its left branch and the specified value as its right branch.
  • DecimalMultiValuePropertyExpression(String). Constructor.
  • IsNotNull(). Creates an 'IsNull' expression. (Not supported)
  • IsNull(). Creates an 'IsNotNull' expression. (Not supported)

Remarks

  • FAST Search for Sharepoint 2010. Multi-value properties are not supported when your search provider is Microsoft FAST Search for SharePoint 2010.
  • Search Server 2010. Multi-value properties are not supported when your search provider is Microsoft Search Server 2010.
  • Solr. Field names in Apache Solr are case-sensitive. When constructing a PropertyExpression for a custom Solr index field, ensure that the proper casing is applied.

DecimalPropertyExpression

Defines an expression representing a decimal index field.

Namespace

Ektron.Cms.Search.Expressions.DecimalPropertyExpression

Properties

  • Category. Gets or sets the CMS category by which this property is classified.
  • Name. Gets or sets the internal property name.
  • ValueType. Gets or sets the data type of the values that may be associated with this property.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • AsMultiValue(). Returns a reference to the multi-value form of this property expression, typically used to retrieve a collection of values from the index.

    NOTE: An index field must be specifically configured to process multi-value data for this to be applicable. (Not all search providers support this behavior.)

  • DecimalPropertyExpression(String). Constructor.
  • EqualTo(Double). Constructs an EqualsExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • GreaterThan(Double). Constructs a GreaterThanExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • GreaterThanOrEqualTo(Double). Constructs a GreaterThanOrEqualsExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • LessThan(Double). Constructs a LessThanExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • LessThanOrEqualTo(Double). Constructs a LessThanOrEqualsExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • NotEqualTo(Double). Constructs a NotEqualsExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.

Remarks

  • Solr. Field names in Apache Solr are case sensitive. When constructing a PropertyExpression for a custom Solr index field, ensure that the proper casing is applied.

DecimalValueExpression

Defines an expression representing a decimal value.

Namespace

Ektron.Cms.Search.Expressions.DecimalValueExpression

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.

EqualsExpression

Defines an expression representing an "equals" operator.

Namespace

Ektron.Cms.Search.Expressions.EqualsExpression

Properties

  • Left. Gets the left branch of the binary expression tree.
  • Right. Gets the right branch of the binary expression tree.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • EqualsExpression(). Constructor.
  • EqualsExpression(BooleanPropertyExpression,Boolean). Constructor.
  • EqualsExpression(DatePropertyExpression,DateTime). Constructor.
  • EqualsExpression(DecimalPropertyExpression,Double). Constructor.
  • EqualsExpression(Expression,Expression). Constructor.
  • EqualsExpression(IntegerPropertyExpression,Int64). Constructor.
  • EqualsExpression(StringPropertyExpression,String). Constructor.

Remarks

  • All Providers. Use the EqualsExpression with caution when applied to string properties. Any variance between the field value and the target value will result in a non-match. Often, a ContainsExpression is more appropriate.

    The precision of decimal fields can vary from provider to provider. Consider querying a range of values rather than applying an exact equality statement in these cases.

  • Solr. The EqualsExpression is evaluated in a case sensitive manner.

    Exact-match comparisons for text fields (StringPropertyExpression and StringMultiValuePropertyExpression) are given special handling. String equality of tokenized textual data is not supported in Solr. Instead, exact-match comparisons must be performed against an untokenized version of the text data. To achieve the appropriate behavior, the Ektron search API will automatically re-target string equality expressions to an untokenized companion field.

    When adding a custom text field to your site's schema, you should also add an exact match companion field. The companion field is required for any literal string comparisons (string equality) appearing in your queries. Failure to add this companion field will result in an error if the EqualsExpression appears in a query. (See the schema.xml for your site for additional information.)

Expression

Abstract class defining the base logical search expression.

Namespace

Ektron.Cms.Search.Expressions.Expression

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • And(Expression). Returns an AND expression of this expression and the specified right expression.
  • And(IEnumerable<Expression>). Returns a list of terms ANDed together.
  • op_BitwiseAnd(Expression,Expression). Returns an AND expression for the specified left and right expressions.
  • op_BitwiseOr(Expression,Expression). Returns an OR expression for the specified left and right expressions.
  • op_LogicalNot(Expression). Returns an expression negating the specified expression.
  • Or(Expression). Returns an OR expression of this expression and the specified right expression.
  • Or(IEnumerable<Expression>). Returns a list of terms ORed together.

GreaterThanExpression

Defines an expression representing a "greater-than" operator.

Namespace

Ektron.Cms.Search.Expressions.GreaterThanExpression

Properties

  • Left. Gets the left branch of the binary expression tree.
  • Right. Gets the right branch of the binary expression tree.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • GreaterThanExpression(). Constructor.
  • GreaterThanExpression(DatePropertyExpression,DateTime). Constructor.
  • GreaterThanExpression(DecimalPropertyExpression,Double). Constructor.
  • GreaterThanExpression(Expression,Expression). Constructor.
  • GreaterThanExpression(IntegerPropertyExpression,Int64). Constructor.
  • GreaterThanExpression(StringPropertyExpression,String). Constructor.

GreaterThanOrEqualsExpression

Defines an expression representing a "greater-than-or-equals" operator.

Namespace

Ektron.Cms.Search.Expressions.GreaterThanOrEqualsExpression

Properties

  • Left. Gets the left branch of the binary expression tree.
  • Right. Gets the right branch of the binary expression tree.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • GreaterThanOrEqualsExpression(). Constructor.
  • GreaterThanOrEqualsExpression(DatePropertyExpression,DateTime). Constructor.
  • GreaterThanOrEqualsExpression(DecimalPropertyExpression,Double). Constructor.
  • GreaterThanOrEqualsExpression(Expression,Expression). Constructor.
  • GreaterThanOrEqualsExpression(IntegerPropertyExpression,Int64). Constructor.
  • GreaterThanOrEqualsExpression(StringPropertyExpression,String). Constructor.

IntegerMultiValuePropertyExpression

Defines an expression representing a integer index field which may contain multiple values.

Namespace

Ektron.Cms.Search.Expressions.IntegerMultiValuePropertyExpression

Properties

  • Category. Gets or sets the CMS category by which this property is classified.
  • Name. Gets or sets the internal property name.
  • ValueType. Gets or sets the data type of the values that may be associated with this property.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • Contains(Int64). Constructs a ContainsExpression using the current object as its left branch and the specified value as its right branch.
  • IntegerMultiValuePropertyExpression(String). Constructor.
  • IsNotNull(). Creates an 'IsNull' expression. (Not supported)
  • IsNull(). Creates an 'IsNotNull' expression. (Not supported)

Remarks

  • FAST Search for Sharepoint 2010. Multi-value properties are not supported when your search provider is Microsoft FAST Search for SharePoint 2010.
  • Search Server 2010. Multi-value properties are not supported when your search provider is Microsoft Search Server 2010.
  • Solr. Field names in Apache Solr are case sensitive. When constructing a PropertyExpression for a custom Solr index field, ensure that the proper casing is applied.

IntegerPropertyExpression

Defines an expression representing a integer index field.

Namespace

Ektron.Cms.Search.Expressions.IntegerPropertyExpression

Properties

  • Category. Gets or sets the CMS category by which this property is classified.
  • Name. Gets or sets the internal property name.
  • ValueType. Gets or sets the data type of the values that may be associated with this property.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node
  • AsMultiValue(). Returns a reference to the multi-value form of this property expression, typically used to retrieve a collection of values from the index.

    NOTE: An index field must be specifically configured to process multi-value data for this to be applicable. Not all search providers support this behavior.

  • EqualTo(Int64). Constructs an EqualsExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • GreaterThan(Int64). Constructs a GreaterThanExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • GreaterThanOrEqualTo(Int64). Constructs a GreaterThanOrEqualsExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • IntegerPropertyExpression(String). Constructor.
  • LessThan(Int64). Constructs a LessThanExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • LessThanOrEqualTo(Int64). Constructs a LessThanOrEqualsExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • NotEqualTo(Int64). Constructs a NotEqualsExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.

Remarks

  • Solr. Field names in Apache Solr are case sensitive. When constructing a PropertyExpression for a custom Solr index field, ensure that the proper casing is applied.

IntegerValueExpression

Defines an expression representing an integer value.

Namespace

Ektron.Cms.Search.Expressions.IntegerValueExpression

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node
  • IntegerValueExpression(Int64). Constructor.

KeywordExpression

Defines an expression representing a "keyword-search" operator.

Namespace

Ektron.Cms.Search.Expressions.KeywordExpression

Properties

  • Mode. Gets or sets the mode for this keyword expression, which indicates whether individual terms are implicitly ANDed or ORed.
  • Phrase. Gets or sets the StringValueExpression representing the keyword text of this expression.
  • Property. Gets the property to which this KeywordExpression applies.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • KeywordExpression(). Constructor.
  • KeywordExpression(PropertyExpression,String,KeywordMode). Constructor.
  • KeywordExpression(String,KeywordMode). Constructor.

Remarks

  • Solr. The KeywordMode option is not supported if your search provider is Apache Solr. KeywordExpressions with multiple terms assume an implicit AND between terms.

LessThanExpression

Defines an expression representing a "less-than" operator.

Namespace

Ektron.Cms.Search.Expressions.LessThanExpression

Properties

  • Left. Gets the left branch of the binary expression tree.
  • Right. Gets the right branch of the binary expression tree.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • LessThanExpression(). Constructor.
  • LessThanExpression(DatePropertyExpression,DateTime). Constructor.
  • LessThanExpression(DecimalPropertyExpression,Double). Constructor.
  • LessThanExpression(Expression,Expression). Constructor.
  • LessThanExpression(IntegerPropertyExpression,Int64). Constructor.
  • LessThanExpression(StringPropertyExpression,String). Constructor.

LessThanOrEqualsExpression

Defines an expression representing a "less-than-or-equals" operator.

Namespace

Ektron.Cms.Search.Expressions.LessThanOrEqualsExpression

Properties

  • Left. Gets the left branch of the binary expression tree.
  • Right. Gets the right branch of the binary expression tree.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • LessThanOrEqualsExpression(). Constructor.
  • LessThanOrEqualsExpression(DatePropertyExpression,DateTime). Constructor.
  • LessThanOrEqualsExpression(DecimalPropertyExpression,Double). Constructor.
  • LessThanOrEqualsExpression(Expression,Expression). Constructor.
  • LessThanOrEqualsExpression(IntegerPropertyExpression,Int64). Constructor.
  • LessThanOrEqualsExpression(StringPropertyExpression,String). Constructor.

NotEqualsExpression

Defines an expression representing a "not-equals" operator.

Namespace

Ektron.Cms.Search.Expressions.NotEqualsExpression

Properties

  • Left. Gets the left branch of the binary expression tree.
  • Right. Gets the right branch of the binary expression tree.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • NotEqualsExpression(). Constructor.
  • NotEqualsExpression(BooleanPropertyExpression,Boolean). Constructor.
  • NotEqualsExpression(DatePropertyExpression,DateTime). Constructor.
  • NotEqualsExpression(DecimalPropertyExpression,Double). Constructor.
  • NotEqualsExpression(Expression,Expression). Constructor.
  • NotEqualsExpression(IntegerPropertyExpression,Int64). Constructor.
  • NotEqualsExpression(StringPropertyExpression,String). Constructor.

NotExpression

Defines an expression representing a "not" operator.

Namespace

Ektron.Cms.Search.Expressions.NotExpression

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • NotExpression(Expression). Constructor.

OrExpression

Defines an expression representing an "or" operator.

Namespace

Ektron.Cms.Search.Expressions.OrExpression

Properties

  • Left. Gets the left branch of the binary expression tree.
  • Right. Gets the right branch of the binary expression tree.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • OrExpression(Expression,Expression). Constructor.

PropertyExpression

The PropertyExpression class serves as a base for expressions identifying a specific searchable property.

Namespace

Ektron.Cms.Search.Expressions.PropertyExpression

Properties

  • Category. Gets or sets the CMS category by which this property is classified.
  • Name. Gets or sets the internal property name.
  • ValueType. Gets or sets the data type of the values that may be associated with this property.

Methods

  • And(Expression). Returns an AND expression of this expression and the specified right expression.

    NOTE: The AND expression is not support for expressions of type PropertyExpression.

  • CreateBooleanMultiValueProperty(String,PropertyCategory). Creates a BooleanMultiValuePropertyExpression for the specified searchable property.
  • CreateBooleanProperty(String). Creates a BooleanPropertyExpression for the specified searchable property.
  • CreateBooleanProperty(String,PropertyCategory). Creates a BooleanPropertyExpression for the specified searchable property.
  • CreateDateMultiValueProperty(String,PropertyCategory). Creates a DateMultiValuePropertyExpression for the specified searchable property.
  • CreateDateProperty(String). Creates a DatePropertyExpression for the specified searchable property.
  • CreateDateProperty(String,PropertyCategory). Creates a DatePropertyExpression for the specified searchable property.
  • CreateDecimalMultiValueProperty(String,PropertyCategory). Creates a DecimalMultiValuePropertyExpression for the specified searchable property.
  • CreateDecimalProperty(String). Creates a DecimalPropertyExpression for the specified searchable property.
  • CreateDecimalProperty(String,PropertyCategory). Creates a DecimalPropertyExpression for the specified searchable property.
  • CreateIntegerProperty(String). Creates a IntegerPropertyExpression for the specified searchable property.
  • CreateIntegerMultiValueProperty(String,PropertyCategory). Creates a IntegerMultiValuePropertyExpression for the specified searchable property.
  • CreateIntegerProperty(String,PropertyCategory). Creates a IntegerPropertyExpression for the specified searchable property.
  • CreateRankProperty(). Creates a RankPropertyExpression for the default rank field.
  • CreateRankProperty(String). Creates a RankProperty expression for the default rank field with the specified rank ID.
  • CreateRankProperty(String,String). Creates a RankProperty expression for the specified rank field and rank ID.
  • CreateStringMultiValueProperty(String,PropertyCategory). Creates a StringMultiValuePropertyExpression for the specified searchable property.
  • CreateStringProperty(String). Creates a StringPropertyExpression for the specified searchable property.
  • CreateStringProperty(String,PropertyCategory). Creates a StringPropertyExpression for the specified searchable property.
  • Equals(Object). Returns true if this PropertyExpression instance is equal to the specified one.
  • GetHashCode(). Gets the hash code for this PropertyExpression instance.
  • IsNull(). Creates an 'IsNull' expression.
  • IsNotNull(). Creates an 'IsNotNull' expression.
  • Or(Expression). Returns an OR expression of this expression and the specified right expression.

    NOTE: The OR expression is not support for expressions of type PropertyExpression.

  • PropertyExpression(String). Constructor.
  • ToString(). Gets the string representation of this PropertyExpression instance.

Remarks

  • Solr. Field names in Apache Solr are case sensitive. When constructing a PropertyExpression for a custom Solr index field, ensure that the proper casing is applied.

RankPropertyExpression

Defines an expression representing a rank field in the index.

Namespace

Ektron.Cms.Search.Expressions.RankPropertyExpression

Properties

  • Category. Gets or sets the CMS category by which this property is classified.
  • IsDefault. Gets or sets a flag indicating whether the default ranking profile is applied.
  • Name. Gets or sets the internal property name.
  • RankID. Gets or sets the ID of the ranking profile to be applied.
  • ValueType. Gets or sets the data type of the values that may be associated with this property.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • RankPropertyExpression(). Constructor.
  • RankPropertyExpression(String). Constructor.
  • RankPropertyExpression(String,String). Constructor.

Remarks

  • FAST Search for Sharepoint 2010. The RankID identifies the rank profile to be applied when calculating the relevance of documents matching your query.
  • Search Server 2010. The RankID property is not supported for Microsoft Search Server.
  • Solr. The RankID property is not supported for Apache Solr.

ScopeExpression

A ScopeExpression identifies a subset of a search index to be queried.

Namespace

Ektron.Cms.Search.Expressions.ScopeExpression

Properties

  • Default. Gets a ScopeExpression identifying the default scope for the current site.

Methods

  • Accept(ExpressionVisitor). Accepts an expression visitor capable of translating this expression into a search query.
  • ScopeExpression(). Implicit conversion of a single ScopeExpression to a list of ScopeExpressions.
  • ScopeExpression(String). Constructor.

StringMultiValuePropertyExpression

Defines an expression representing a string index field which may contain multiple values.

Namespace

Ektron.Cms.Search.Expressions.StringMultiValuePropertyExpression

Properties

  • Category. Gets or sets the CMS category by which this property is classified.
  • Name. Gets or sets the internal property name.
  • ValueType. Gets or sets the data type of the values that may be associated with this property.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • Contains(String). Constructs a ContainsExpression using the current object as its left branch and the specified phrase as its right branch.
  • IsNotNull(). Creates an 'IsNull' expression. (Not supported)
  • IsNull(). Creates an 'IsNotNull' expression. (Not supported)
  • StringMultiValuePropertyExpression(String). Constructor.

Remarks

  • FAST Search for Sharepoint 2010. Multi-value properties are not supported when your search provider is Microsoft FAST Search for SharePoint 2010.
  • Search Server 2010. Multi-value properties are not supported when your search provider is Microsoft Search Server 2010.
  • Solr. Field names in Apache Solr are case sensitive. When constructing a PropertyExpression for a custom Solr index field, ensure that the proper casing is applied.

StringPropertyExpression

Defines an expression representing a string index field.

Namespace

Ektron.Cms.Search.Expressions.StringPropertyExpression

Properties

  • Category. Gets or sets the CMS category by which this property is classified.
  • Name. Gets or sets the internal property name.
  • ValueType. Gets or sets the data type of the values that may be associated with this property.

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • AsMultiValue(). Returns a reference to the multi-value form of this property expression, typically used to retrieve a collection of values from the index.

    NOTE: An index field must be specifically configured to process multi-value data for this to be applicable. Not all search providers support this behavior.

  • Contains(String). Constructs a ContainsExpression using the current object as its left branch and the specified phrase as its right branch.
  • Contains(String,WordForms). Constructs a ContainsExpression using the current object as its left branch and the specified phrase as its right branch.
  • EqualTo(String). Constructs an EqualsExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • GreaterThan(String). Constructs a GreaterThanExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • GreaterThanOrEqualTo(String). Constructs a GreaterThanOrEqualsExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • LessThan(String). Constructs a LessThanExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • LessThanOrEqualTo(String). Constructs a LessThanOrEqualsExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • NotEqualTo(String). Constructs a NotEqualsExpression using the current object as its left-branch, and the given parameter "value" as its right-branch.
  • StringPropertyExpression(String). Constructor.

Remarks

  • Solr. Field names in Apache Solr are case sensitive. When constructing a PropertyExpression for a custom Solr index field, ensure that the proper casing is applied.

StringValueExpression

Defines an expression representing a string value.

Namespace

Ektron.Cms.Search.Expressions.StringValueExpression

Methods

  • Accept(ExpressionVisitor). Accepts a visitor to perform actions on this expression node.
  • StringValueExpression(String). Constructor.