Search Data Classes

AdministratorPermission

The AdministratorPermission class serves as a token identifying that a search query is intended to be executed as an administrator user.

Namespace

Ektron.Cms.Search.AdministratorPermission

Methods

  • Authenticate(IAuthenticationHandler). Authenticates the current permission against the given authentication handler

AdvancedSearchCriteria

The AdvancedSearchCriteria class describes a narrow search query primarily defined by a logical expression tree. This criteria is intended narrower, targeted, querying.

Namespace

Ektron.Cms.Search.AdvancedSearchCriteria

Properties

  • EnableStemming. Gets or sets a flag indicating whether or not stemming is enabled for the query.
  • ExpressionTree. Gets and sets the logical expression tree for filtering results.
  • IncludeSuggestedResults. Gets and sets a flag indicating whether to retrieve suggested results in addition to the relevant search results.
  • Locale. Gets and sets the query engine's target locale.
  • OrderBy. Gets and sets the list of result ordering rules.
  • PagingInfo. Gets and sets the paging information.
  • Permission. Gets and sets the permissions with which to search.
  • Refinement. Gets or sets the criteria used to indicate how refinements should be applied to the query.

    NOTE: Query refinement is not supported by all search providers and may require some additional manual configuration.

  • ReturnProperties. Gets and sets the list of columns to return in the results.
  • Scope. Gets and sets the scope information.
  • Similarity. Gets or sets the criteria used to refine the query to items that are most similar to a particular item. Note: Similarity search functionality is not supported by all search providers.

Constructors

  • AdvancedSearchCriteria(). Constructor.

Remarks

  • All Providers. The Locale property should be used to specify what type of language processing is applied to your query. The current site language is used as a default if the Locale is not explicitly specified.
  • FAST Search for Sharepoint 2010. The AdvancedSearchCriteria is not applicable when your search provider is Microsoft FAST Search for SharePoint. For the purposes of easing migration to this provider, any queries using this criteria is interpreted as KeywordSearchCriteria. See also KeywordSearchCriteria for additional information.
  • Search Server 2010. The Refinement property is not supported if your search provider is Microsoft Search Server 2010. Deep refinement of result sets is not available.

    The Similarity property is not supported if your search provider is Microsoft Search Server 2010. Similarity search functionality is not available.

  • Solr. The AdvancedSearchCriteria is not applicable when your search provider is Apache Solr. For the purposes of easing migration to this provider, any queries using this criteria are interpreted as KeywordSearchCriteria. See also the KeywordSearchCriteria for additional information.

BoundedFacetBucket

The BoundedFacetBucket class is a data structure describing a facet result that represent a range of values.

Namespace

Ektron.Cms.Search.BoundedFacetBucket<T>

Properties

  • Count. Gets or sets the count of items encompassed by this bucket.
  • Refinement. Gets or sets the refinement data identifying this facet. This data can be applied to subsequent queries to indicate that the result set should be restricted to items classified by this FacetBucket.
  • Value. Gets or sets the upper and lower bounds for data encompassed by this facet bucket.

Constructors

  • BoundedFacetBucket(BoundedValue<T>,Int64). Constructor.

BoundedValue

The BoundedValue class is a data structure representing a range of refinement values.

Namespace

Ektron.Cms.Search.BoundedValue<U>

Properties

  • LowerBound. Gets or sets the lower bound of the value range.
  • UpperBound. Gets or sets the upper bound of the value range.

Constructors

  • BoundedValue(U). Constructor.
  • BoundedValue(U,U). Constructor.

CurrentUserPermission

The CurrentUserPermission class serves as a token identifying that a search query is intended to be executed as the user that has triggered the action to issue it.

Namespace

Ektron.Cms.Search.CurrentUserPermission

Methods

  • Authenticate(IAuthenticationHandler). Authenticates the current permission against the given authentication handler.

DateFacet

The DateFacet class represents a classification of search results on a date/time index field.

Namespace

Ektron.Cms.Search.DateFacet

Properties

  • Buckets. Gets or sets the bounded facet buckets representing the DateTime ranges for this facet.
  • Property. Gets or sets the property associated with this facet.

Constructors

  • DateFacet(DatePropertyExpression). Constructor.
  • DateFacet(DatePropertyExpression,ICollection<BoundedFacetBucket<DateTime>>). Constructor.
  • DateFacet(DateMultiValuePropertyExpression). Constructor.
  • DateFacet(DateMultiValuePropertyExpression,ICollection<BoundedFacetBucket<DateTime>>). Constructor.
  • DateFacet(PropertyExpression). Constructor.
  • DateFacet(PropertyExpression,ICollection<BoundedFacetBucket<DateTime>>). Constructor.

DateRefinementSpecification

The DateRefinementSpecification represents a strongly typed refinement specification for date/time index properties.

Namespace

Ektron.Cms.Search.DateRefinementSpecification

Properties

  • Property. Gets or sets the refinement property.

Constructors

  • DateRefinementSpecification(). Constructor.
  • DateRefinementSpecification(DateMultiValuePropertyExpression). Constructor.
  • DateRefinementSpecification(DateMultiValuePropertyExpression,ICollection<BoundedValue<DateTime>>). Constructor.
  • DateRefinementSpecification(DatePropertyExpression). Constructor.
  • DateRefinementSpecification(DatePropertyExpression,ICollection<BoundedValue<DateTime>>). Constructor.

Remarks

  • All Providers. Add a DateRefinementSpecification to search criteria to identify a field for which facet data should be returned with the query results.
  • FAST Search for Sharepoint 2010. Specifying explicit bounds for date refinements is not supported when your search provider is Microsoft FAST Search for SharePoint 2010. The date ranges are auto-generated by the search engine.
  • Search Server 2010. The DateRefinementSpecification is not applicable if your search provider is Microsoft Search Server 2010. Deep refinement of result sets is not available.
  • Solr. When explicit bounds for date refinements are not specified each unique date value will represent an individual facet bucket in your response.

DecimalFacet

The DecimalFacet class represents a classification of search results on a decimal index field.

Namespace

Ektron.Cms.Search.DecimalFacet

Properties

  • Buckets. Gets or sets the collection of facet buckets associated with this facet.
  • Property. Gets or sets the property associated with this facet.

Constructors

  • DecimalFacet(DecimalMultiValuePropertyExpression). Constructor.
  • DecimalFacet(DecimalMultiValuePropertyExpression,ICollection<BoundedFacetBucket<Double>>). Constructor.
  • DecimalFacet(DecimalPropertyExpression). Constructor.
  • DecimalFacet(DecimalPropertyExpression,ICollection<BoundedFacetBucket<Double>>). Constructor.
  • DecimalFacet(PropertyExpression). Constructor.
  • DecimalFacet(PropertyExpression,ICollection<BoundedFacetBucket<Double>>). Constructor.

DecimalRefinementSpecification

The DecimalRefinementSpecification represents a strongly typed refinement specification for decimal index properties.

Namespace

Ektron.Cms.Search.DecimalRefinementSpecification

Properties

  • Property. Gets or sets the refinement property.

Constructors

  • DecimalRefinementSpecification(). Constructor.
  • DecimalRefinementSpecification(DecimalMultiValuePropertyExpression). Constructor.
  • DecimalRefinementSpecification(DecimalMultiValuePropertyExpression,ICollection<BoundedValue<Double>>). Constructor.
  • DecimalRefinementSpecification(DecimalPropertyExpression). Constructor.
  • DecimalRefinementSpecification(DecimalPropertyExpression,ICollection<BoundedValue<Double>>). Constructor.

Remarks

  • All Providers. Add a DecimalRefinementSpecification to search criteria to identify a field for which facet data should be returned with the query results.
  • FAST Search for Sharepoint 2010. Specifying explicit bounds for decimal refinements is not supported when your search provider is Microsoft FAST Search for SharePoint 2010. The decimal ranges are auto-generated by the search engine.
  • Search Server 2010. The DecimalRefinementSpecification is not applicable if your search provider is Microsoft Search Server 2010. Deep refinement of result sets is not available.
  • Solr. When explicit bounds for decimal refinements are not specified each unique decimal value will represent an individual facet bucket in your response.

Facet

The Facet class represents a classification of search results on a specific index field.

Namespace

Ektron.Cms.Search.Facet<T>

Properties

  • Property. Gets or sets the property associated with this facet.

Constructors

  • Facet(T). Constructor.

FacetBucket

The FacetBucket class describes a subset of results classified within a given facet.

Namespace

Ektron.Cms.Search.FacetBucket

Properties

  • Count. Gets or sets the count of items encompassed by this bucket.
  • Refinement. Gets or sets the refinement data identifying this facet. This data can be applied to subsequent queries to indicate that the result set should be restricted to items classified by this FacetBucket.

Constructors

  • FacetBucket(Int64). Constructor.

Facets

The Facets class is a data structure encapsulating a collection of facet data for an individual search response.

Namespace

Ektron.Cms.Search.Facets

Properties

  • Item[DateMultiValuePropertyExpression]. Gets a DateFacet associated with the specified property.
  • Item[DatePropertyExpression]. Gets a DateFacet associated with the specified property.
  • Item[DecimalMultiValuePropertyExpression]. Gets a DecimalFacet associated with the specified property.
  • Item[DecimalPropertyExpression]. Gets a DecimalFacet associated with the specified property.
  • Item[IntegerMultiValuePropertyExpression]. Gets a IntegerFacet associated with the specified property.
  • Item[IntegerPropertyExpression]. Gets a IntegerFacet associated with the specified property.
  • Item[PropertyExpression]. Gets a Facet associated with the specified property.
  • Item[String]. Gets a Facet with the specified property name.
  • Item[StringMultiValuePropertyExpression]. Gets a StringFacet associated with the specified property.
  • Item[StringPropertyExpression]. Gets a StringFacet associated with the specified property.

Constructors

  • Facets(). Constructor.
  • Facets(ICollection<Facet<PropertyExpression>>). Constructor.

Methods

  • HasFacet(PropertyExpression). Returns true if this instance contains a facet for the property represented by the specified PropertyExpression.
  • HasFacet(String). Returns true if this instance contains a facet for the property represented by the specified property name.

IntegerFacet

The IntegerFacet class represents a classification of search results on a integer index field.

Namespace

Ektron.Cms.Search.IntegerFacet

Properties

  • Buckets. Gets or sets the collection of facet buckets associated with this facet.
  • Property. Gets or sets the property associated with this facet.

Constructors

  • IntegerFacet(IntegerMultiValuePropertyExpression). Constructor.
  • IntegerFacet(IntegerMultiValuePropertyExpression,ICollection<BoundedFacetBucket<Int64>>). Constructor.
  • IntegerFacet(IntegerPropertyExpression). Constructor.
  • IntegerFacet(IntegerPropertyExpression,ICollection<BoundedFacetBucket<Int64>>). Constructor.
  • IntegerFacet(PropertyExpression). Constructor.
  • IntegerFacet(PropertyExpression,ICollection<BoundedFacetBucket<Int64>>). Constructor.

IntegerRefinementSpecification

The IntegerRefinementSpecification represents a strongly typed refinement specification for integer index properties.

Namespace

Ektron.Cms.Search.IntegerRefinementSpecification

Properties

  • Property. Gets or sets the refinement property.

Constructors

  • IntegerRefinementSpecification(). Constructor.
  • IntegerRefinementSpecification(IntegerMultiValuePropertyExpression). Constructor.
  • IntegerRefinementSpecification(IntegerMultiValuePropertyExpression,ICollection<BoundedValue<Int64>>). Constructor.
  • IntegerRefinementSpecification(IntegerPropertyExpression). Constructor.
  • IntegerRefinementSpecification(IntegerPropertyExpression,ICollection<BoundedValue<Int64>>). Constructor.

Remarks

  • All Providers. Add a IntegerRefinementSpecification to search criteria to identify a field for which facet data should be returned with the query results.
  • FAST Search for Sharepoint 2010. Specifying explicit bounds for integer refinements is not supported when your search provider is Microsoft FAST Search for SharePoint 2010. The integer ranges are auto-generated by the search engine.
  • Search Server 2010. The IntegerRefinementSpecification is not applicable if your search provider is Microsoft Search Server 2010. Deep refinement of result sets is not available.
  • Solr. When explicit bounds for integer refinements are not specified each unique integer value will represent an individual facet bucket in your response.

KeywordSearchCriteria

The KeywordSearchCriteria class describes a free-text, keyword-centric search query. The criteria is intended for broad, traditional search queries.

Namespace

Ektron.Cms.Search.KeywordSearchCriteria

Properties

  • EnableStemming. Gets or sets a flag indicating whether or not stemming is enabled for the query.
  • ExpressionTree. Gets and sets the logical expression tree for filtering results.
  • ImplicitAnd. Gets or sets a flag indicating whether or not an 'AND' operator is implied between search terms that lack any other explicit logical operator.
  • IncludeSuggestedResults. Gets and sets a flag indicating whether or not to retrieve suggested results in addition to the relevant search results.
  • Locale. Gets and sets the query engine's target locale.
  • OrderBy. Gets and sets the list of result ordering rules.
  • PagingInfo. Gets and sets the paging information.
  • Permission. Gets and sets the permissions with which to search.
  • QueryText. Gets and sets the keyword query text with which to filter the search results.
  • Refinement. Gets or sets the criteria used to indicate how refinements should be applied to the query.

    NOTE: Query refinement is not supported by all search providers and may require some additional manual configuration.

  • ReturnProperties. Gets and sets the list of columns to return in the results.
  • Scope. Gets and sets the scope information.
  • Similarity. Gets or sets the criteria used to refine the query to items that are most similar to a particular item. Note: Similarity search functionality is not supported by all search providers.

Constructors

  • KeywordSearchCriteria(). Constructor.

Remarks

  • All Providers. As a best practice, explicit property names should not be hard-coded in the value of the QueryText property. The PropertyExpression class (and its various derived classes) exist to abstract away the resolution of property names. This serves to decouple your query from the underlying index schema as well as maximize portability and version compatibility.

    The Locale property should be used to specify what type of language processing is applied to your query. The current site language is used as a default if the Locale is not explicitly specified.

  • FAST Search for Sharepoint 2010. The Permission property is not supported if your search provider is Microsoft FAST Search for SharePoint 2010. Security trimming of documents at query time is not available.
  • Search Server 2010. The Refinement property is not supported if your search provider is Microsoft Search Server 2010. Deep refinement of result sets is not available.

    The Similarity property is not supported if your search provider is Microsoft Search Server 2010. Similarity search functionality is not available.

  • Solr. With Apache Solr, the EnableStemming option is not available. In Solr, stemming is not a feature that can be toggled at query-time. It is configured on a field by field basis in the schema.xml for a given Solr core. By default, stemming is only applied to the content body and content title. There is no stemming applied to any of the other index fields. If a different behavior is required, you should consider customizing the index schema for your site.

    The Permission property is not supported if your search provider is Apache Solr. Security trimming of documents at query time is not available.

    The Similarity property is not supported if your search provider is Apache Solr. Similarity search functionality is not available.

    The Scope property is not supported if your search provider is Apache Solr.

    Ranking algorithms will use the contents of the QueryText property when determining the relevancy of a particular result item. The ExpressionTree will filter your results but will not influence their rank.

    While Solr utilizes boolean operators and related terminology, it is important to consider that these expressions are actually interpreted by Solr as set operations. The 'AND' expression can be thought of as a conjunction operation and 'OR' can be thought of as an injunction operation. If your query produces an unexpected result set, try to revise your query with this in mind. (For additional details on this behavior, see the following article: Why Not AND, OR, And NOT?)

    By default, the content of assets (Word documents, PDFs, and so on) is indexed for files up to 10 MB in size. This limit is intended to accelerate crawl times and minimize the burden placed upon the search server by the content extraction process. When a file exceeds this limit, its summary is indexed instead of the full content of the document. The limit can be adjusted via the ManifoldCF administration console. (Use caution when updating advanced configuration options such as this. Changes may impact the performance of your search server.)

    Solr relies on Apache Tika, an open source collection of content analysis libraries, for the extraction of content from asset files (Word documents, PDFs, and so on). Support for the extraction of content from these types of files is subject to the features and limitations of this toolkit.

Locale

The Locale class provides a mapping of language IDs to the relevant locale for a search query.

Namespace

Ektron.Cms.Search.Locale

Properties

  • Code. Gets the identifying code for this locale.
  • Default. Gets the default 'Locale' according to the current content language.
  • ID. Gets the language ID for this locale.

Methods

  • Create(Int32). Gets the string locale code represented by the language ID.
  • Get(Int32). Gets the locale code for the specified language ID.

ManualUserPermission

The ManualUserPermission class is a data structure encapsulating permission data representing a specific, manually specified, CMS user.

Namespace

Ektron.Cms.Search.ManualUserPermission

Properties

  • UserId. Gets and sets the user identification to apply to search results

Constructors

  • ManualUserPermission(Int64). Constructor.

Methods

  • Authenticate(IAuthenticationHandler). Authenticates the current permission against the given authentication handler.

OrderData

The OrderData class represents the ordering information for the result set of a search query.

Namespace

Ektron.Cms.Search.OrderData

Properties

  • Direction. Gets or sets the direction in which to sort a result set.
  • Property. Gets or sets the property on which to sort a result set.

Constructors

  • OrderData(PropertyExpression,OrderDirection). Constructor.

Remarks

  • All Providers. Your search provider may require that you explicitly configure an index field as sortable. If you find that your results are not sorting as directed, consult the search provider vendor's documentation for information regarding how you would configure this functionality.

    Many search providers will apply an ASCII-based sort to textual fields. Keep this in mind when sorting on string properties.

    The HighlightedSummary property cannot be sorted.

    The Rank property cannot be sorted in an ascending direction.

  • Solr. Sorting of results is not supported for multi-value fields.

    Sorting of results is not supported for text fields with tokenization or other text processing applied to them. If you are sorting on a custom field, it is recommended that you also create an exact-match companion field containing an unprocessed copy of the data. See your schema.xml file for additional information on creating these fields.

    Smart Form fields cannot be sorted on. Apache Solr does not support the sorting of multi-value fields. If sorting behavior is required for data associated with Smart Form content, please consider using a companion metadata definition.

Permission

The Permission class is an abstract base class describing CMS permission data that can be applied to a search query.

Namespace

Ektron.Cms.Search.Permission

Methods

  • Authenticate(IAuthenticationHandler). Authenticates the current permission against the given authentication handler.
  • CreateAdministratorPermission(). Creates a new permission instance representing a CMS administrator.
  • CreateCurrentUserPermission(). Creates a new Permission instance representing the current CMS user.
  • CreateManualUserPermission(Int64). Creates a new Permission instance representing the specified CMS user.

QueryCompletionRequest

The QueryCompletionRequest class defines the parameters of a request for the configured search engine to predict query terms based on some partial term input.

Namespace

Ektron.Cms.Search.QueryCompletionRequest

Properties

  • DictionaryName. Gets or sets the name of the target dictionary supplying completed terms. This parameter is not supported by all search providers. See the Ektron Developer Reference for guidance.
  • HandlerName. Gets or sets the name of the handler supplying completed terms. This parameter is not supported by all search providers. See the Ektron Developer Reference for guidance.
  • Language. Gets or sets the target content language for content feeding potential completed terms.
  • MaxCount. Gets or sets the suggested maximum count of query completions for the search engine. Actual counts may vary according to term availability as determined by the search engine's internal algorithms.
  • Query. Gets or sets the (partial) query term which the search engine will use as a seed for predicting completed terms.
  • SortOrder. Gets or sets the type of sorting applied to query completion results.

Constructors

  • QueryCompletionRequest(). Constructor.
  • QueryCompletionRequest(String,Int32). Constructor.
  • QueryCompletionRequest(String,Int32,Int32,QueryCompletionSortOrder). Constructor.
  • QueryCompletionRequest(String,Int32,QueryCompletionSortOrder). Constructor.

Remarks

  • All Providers. The maximum count parameter is a suggestion for the search engine. Actual counts may vary according to term availability, as determined by the search engine's internal algorithms.
  • FAST Search for Sharepoint 2010. The Language property is not supported if your search provider is Microsoft FAST Search for SharePoint 2010.

    The HandlerName property is not supported if your search provider is Microsoft FAST Search for SharePoint 2010.

    The DictionaryName property is not supported if your search provider is Microsoft FAST Search for SharePoint 2010.

  • Search Server 2010. The Language property is not supported if your search provider is Microsoft Search Server 2010.

    The HandlerName property is not supported if your search provider is Microsoft Search Server 2010.

    The DictionaryName property is not supported if your search provider is Microsoft Search Server 2010.

QueryCompletionResponse

The QueryCompletionResponse class is a data structure which aggregates query completions for a partial search term, as predicted by the configured search provider.

Namespace

Ektron.Cms.Search.QueryCompletionResponse

Properties

  • QueryCompletions. Gets or sets a collection of completed terms as predicted by the configured search provider.

Constructors

  • QueryCompletionResponse(). Constructor.

QueryCompletionTerm

The QuerySuggestionTerm class is a data structure describing an individual, completed, query term as predicted by the configured search provider.

Namespace

Ektron.Cms.Search.QuerySuggestionTerm

Properties

  • Suggestion. Gets or sets the predicted query term.

Constructors

  • QuerySuggestionTerm(). Constructor.

QuerySuggestionResponse

The QuerySuggestionResponse class is a data structure which aggregates query completions for a partial search term, as predicted by the configured search provider.

Namespace

Ektron.Cms.Search.QuerySuggestionResponse

Properties

  • QuerySuggestions. Gets or sets a collection of suggested terms as predicted by the configured search provider.

Constructors

  • QuerySuggestionResponse(). Constructor.

QuerySuggestionTerm

The QuerySuggestionTerm class is a data structure describing an individual, completed, query term as predicted by the configured search provider.

Namespace

Ektron.Cms.Search.QuerySuggestionTerm

Properties

  • Suggestion. Gets or sets the predicted query term.

Constructors

  • QuerySuggestionTerm(). Constructor.

Refinement

The Refinement class is a data structure identifying a specific subset of results to which a query should be restricted.

Namespace

Ektron.Cms.Search.Refinement

Properties

  • Data. Gets or sets the data identifying this refinement.
  • Property. Gets or sets the property associated with this refinement.

Constructors

  • Refinement(). Constructor.
  • Refinement(PropertyExpression,String). Constructor.

Remarks

  • All Providers. Add a Refinement to your search criteria to restrict a query to results classified by a specific facet bucket. Every FacetBucket includes a reference to a Refinement, which can be added to a subsequent query.
  • Search Server 2010. The Refinement is not applicable if your search provider is Microsoft Search Server 2010. Deep refinement of result sets is not available.

RefinementCriteria

The RefinementCriteria class encapsulates all query criteria related to faceted search.

Namespace

Ektron.Cms.Search.RefinementCriteria

Properties

  • IsEnabled. Gets or sets a flag indicating whether or not refinement functionality is enabled for a query.
  • Items. Gets a read-only collection of the refinement information associated with this criteria.

Constructors

  • RefinementCriteria(). Constructor.

Methods

  • Add(Refinement). Adds a specific refinement identifying a specific subset of results to which the query should be restricted.
  • Add(RefinementInfo). Add a RefinementInfo data structure to the criteria.
  • Add(RefinementSpecification<PropertyExpression>). Adds a RefinementSpecification identifying the facets that should be generated at query time.
  • Clear(). Clears this criteria of any refinement specifications or restrictions that it may contain.

Remarks

  • All Providers. Add a RefinementSpecification to this criteria to identify a field for which facet data should be returned with the query results.

    Add a Refinement to this criteria to restrict a query to results classified by a specific facet bucket. Every FacetBucket includes a reference to a Refinement, which can be added to a subsequent query.

  • Search Server 2010. RefinementCriteria is not applicable if your search provider is Microsoft Search Server 2010. Deep refinement of result sets is not available.

RefinementInfo

The RefinementInfo class is a data structure describing individual refinement specifications and restrictions applied to a query.

Namespace

Ektron.Cms.Search.RefinementInfo

Properties

  • Property. Gets or sets the property associated with this refinement information.
  • Refinements. Gets the query refinement restrictions.
  • Specification. Get or sets the query refinement specification.

Constructors

  • RefinementInfo(). Constructor.
  • RefinementInfo(List<Refinement>). Constructor.
  • RefinementInfo(Refinement). Constructor.
  • RefinementInfo(RefinementSpecification<PropertyExpression>). Constructor.

RefinementSpecification

The RefinementSpecification class identifies a specific facet to be included in the search results.

Namespace

Ektron.Cms.Search.RefinementSpecification<T>

Properties

  • Property. Gets or sets the refinement property.

Constructors

  • RefinementSpecification(T). Constructor.

Remarks

  • All Providers. Add a RefinementSpecification to search criteria to identify a field for which facet data should be returned with the query results.
  • Search Server 2010. The RefinementSpecification is not applicable if your search provider is Microsoft Search Server 2010. Deep refinement of result sets is not available.

SearchContentProperty

The ContentProperty class provides access to the PropertyExpressions which map default content properties to index fields.

Namespace

Ektron.Cms.Search.SearchContentProperty

Properties

  • AssetVersion. Gets the PropertyExpression for the asset version path field.
  • Author. Gets the PropertyExpression for the content author field.
  • ContentSubType. Gets the PropertyExpression for the content subtype field.
  • ContentType. Gets the PropertyExpression for the content type field.
  • DateCreated. Gets the PropertyExpression for the content date created field.
  • DateModified. Gets the PropertyExpression for the content date modified field.
  • Description. Gets the PropertyExpression for the content description field.
  • ExpiryDate. Gets the PropertyExpression for the content expiry date field.
  • ExpiryType. Gets the PropertyExpression for the content expiry type field.
  • FolderId. Gets the PropertyExpression for the folder ID field.
  • FolderIdPath. Gets the PropertyExpression for the content folder ID path field.
  • FolderName. Gets the PropertyExpression for the content folder name field.
  • FolderPath. Gets the PropertyExpression for the content folder path field.

    NOTE: For more information on the Folder properties, see Recursive Folder Queries.

  • GoLiveDate. Gets the PropertyExpression for the content go live date field.
  • HighlightedSummary. Gets the PropertyExpression for the highlighted summary field.
  • Id. Gets the PropertyExpression for the content ID field.
  • Language. Gets the PropertyExpression for the content language field.
  • MapAddress. Gets the PropertyExpression for the map address field.
  • MapDate. Gets the PropertyExpression for the map date field.
  • MapLatitude. Gets the PropertyExpression for the map latitude field.
  • MapLongitude. Gets the PropertyExpression for the map longitude field.
  • Path. Gets the PropertyExpression for the content path field.
  • Private. Gets the PropertyExpresion for the field indicating whether or not the content is private.
  • QuickLink. Gets the PropertyExpression for the QuickLink field.
  • Rank. Gets the PropertyExpression for the rank field.
  • SiteId. Gets the PropertyExpression for the ID of the parent site.
  • Size. Gets the PropertyExpression for the content size field.
  • Tags. Gets the PropertyExpression for the content tags field.
  • TaxonomyCategory. Gets the PropertyExpression for the taxonomy category field.
  • Title. Gets the PropertyExpression for the content title field.
  • XmlConfigId. Gets the PropertyExpression for the content SmartForm ID field.

Remarks

  • All Providers. The HighlightedSummary property expression is used to request a dynamically generated summary for each result item in your result set. This behavior varies from search provider to search provider. Its effectiveness also varies based on the quantity and quality of the data available in the index for a given piece of content. For example, XML-based content, such as Smart Form data, is less likely to render a meaningful summary than traditional textual content. It is recommended that static summaries are conditionally displayed for result items in cases where the dynamically generated one is insufficient.
  • Solr. The TaxonomyCategory property is a multi-value field in Solr. Multi-value fields provide a better development experience when consuming field data representing a collection of values. It is recommended that you reference the TaxonomyCategory property as a multi-value property expression to ensure that you are always working with the complete data for your result item (See: StringMultiValuePropertyExpression class):

    SearchContentProperty.TaxonomyCategory.AsMultiValue()

    General keyword searches of hierarchical field data are not supported. Fields such as TaxonomyCategory, FolderPath, and FolderIdPath have been optimized for queries that are constructed using hierarchical paths. When querying this type of data, your input should be a rooted, fully formed path. For example, consider a taxonomy category of "\Departments\HR\Benefits." A query, against the taxonomy category field, with an input of "\Departments\HR," would return results associated with the category. A query with an input of "HR" would not.

    Solr will analyze the first 100,000 characters of an individual document when generating a HighlightedSummary value. For large content, a dynamic summary will not be generated if the search terms for your query are not found in the first 100,000 characters of the document.

SearchCriteria

The SearchCriteria class serves as a base for criteria defining a particular search query.

Namespace

Ektron.Cms.Search.SearchCriteria

Properties

  • EnableStemming. Gets or sets a flag indicating whether or not stemming is enabled for the query.
  • ExpressionTree. Gets and sets the logical expression tree for filtering results
  • IncludeSuggestedResults. Gets and sets a flag indicating whether or not to retrieve suggested results in addition to the relevant search results.
  • Locale. Gets and sets the query engine's target locale.
  • OrderBy. Gets and sets the list of result ordering rules
  • PagingInfo. Gets and sets the paging information
  • Permission. Gets and sets the permissions with which to search
  • Refinement. Gets or sets the criteria used to indicate how refinements should be applied to the query.

    NOTE: Query refinement is not supported by all search providers and may require some additional manual configuration.

  • ReturnProperties. Gets and sets the list of columns to return in the results
  • Scope. Gets and sets the scope information
  • Similarity. Gets or sets the criteria used to refine the query to items that are most similar to a particular item. Note: Similarity search functionality is not supported by all search providers.

Constructors

  • SearchCriteria(). Constructor.

SearchCustomProperty

The SearchCustomProperty class is a factory for property expressions targeting custom property fields.

Namespace

Ektron.Cms.Search.SearchCustomProperty

Methods

  • GetBooleanProperty(String). Gets a BooleanPropertyExpression representing the custom property field identified by the specified name value.
  • GetDateProperty(String). Gets a DatePropertyExpression representing the custom property field identified by the specified name value.
  • GetDecimalProperty(String). Gets a DecimalPropertyExpression representing the custom property field identified by the specified name value.
  • GetIntegerProperty(String). Gets a IntegerPropertyExpression representing the custom property field identified by the specified name value.
  • GetStringProperty(String). Gets a StringPropertyExpression representing the custom property field identified by the specified name value.

SearchECommerceProperty

The SearchECommerceProperty class provides access to the default PropertyExpressions for formulating e-commerce queries.

Namespace

Ektron.Cms.Search.SearchECommerceProperty

Properties

  • Buyable. Gets the PropertyExpression for the buyable field.
  • CatalogNumber. Gets the PropertyExpression for product folder ID field.
  • CurrencyId. Gets the PropertyExpression for the currency ID field.
  • Description. Gets the PropertyExpression for the product description field.
  • Discontinued. Gets the PropertyExpression for the product discontinued field.
  • Height. Gets the PropertyExpression for the product height field.
  • HighlightedSummary. Gets the PropertyExpression for the highlighted product summary field.
  • Id. Gets the PropertyExpression for product content ID field.
  • ImageUrl. Gets the PropertyExpression for the product image field.
  • Language. Gets the PropertyExpression for the product content language field.
  • Length. Gets the PropertyExpression for the product length field.
  • ListPrice. Gets the PropertyExpression for the list price field.
  • PathCategory. Gets the PropertyExpression for the product content path field.
  • ProductType. Gets the PropertyExpression for the product type field.
  • ProductTypeId. Gets the PropertyExpression for the product type ID field.
  • Purchased. Gets the PropertyExpression for the purchased field.
  • QuickLink. Gets the PropertyExpression for the product QuickLink field.
  • Rank. Gets the PropertyExpression for the result rank field.
  • SalePrice. Gets the PropertyExpression for the sale price field.
  • Size. Gets the PropertyExpression for the product content size field.
  • SkuNumber. Gets the PropertyExpression for the SKU number field.
  • Title. Gets the PropertyExpression for the product title field.
  • Weight. Gets the PropertyExpression for the product weight field.
  • Width. Gets the PropertyExpression for the product width field.

Remarks

  • All Providers. The HighlightedSummary property expression is used to request a dynamically generated summary for each result item in your result set. This behavior varies from search provider to search provider. Its effectiveness also varies based on the quantity and quality of the data available in the index for a given piece of content. For example, XML-based content, such as Smart Form data, is less likely to render a meaningful summary than traditional textual content. It is recommended that static summaries are conditionally displayed for result items in cases where the dynamically generated one is insufficient.
  • Solr. The TaxonomyCategory property is a multi-value field in Solr. Multi-value fields provide a better development experience when consuming field data representing a collection of values. It is recommended that you reference the TaxonomyCategory property as a multi-value property expression to ensure that you are always working with the complete data for your result item (See: StringMultiValuePropertyExpression class):

    SearchContentProperty.TaxonomyCategory.AsMultiValue()

    General keyword searches of hierarchical field data is not supported. Fields such as TaxonomyCategory, FolderPath, and FolderIdPath have been optimized for queries that are programmatically constructed. When querying this type of data, your input should be a rooted, fully formed, path. For example, consider a taxonomy category of "\Departments\HR\Benefits". A query, against the taxonomy category field, with an input of "\Departments\HR" would return results associated with the category. A query with an input of "HR" would not.

    Solr will analyze the first 100,000 characters of an individual document when generating a HighlightedSummary value. For large content, a dynamic summary will not be generated if the search terms for your query are not found in the first 100,000 characters of the document.

SearchGroupProperty

The GroupProperty class provides access to the default PropertyExpressions for formulating community group queries.

Namespace

Ektron.Cms.Search.SearchGroupProperty

Properties

  • Avatar. Gets the PropertyExpression for the user avatar field.
  • CreatorId. Gets the PropertyExpression for the group creator ID field.
  • DateModified. Gets the PropertyExpression for the date modified field.
  • EmailAddress. Gets the PropertyExpression for the email address field.
  • Enroll. Gets the PropertyExpression for the enroll field.
  • HighlightedSummary. Gets the PropertyExpression for the highlighted summary field.
  • Id. Gets the PropertyExpression for the group ID field.
  • Location. Gets the PropertyExpression for the location field.
  • LongDescription. Gets the PropertyExpression for the long description field.
  • Name. Gets the PropertyExpression for the name field.
  • Path. Gets the PropertyExpression for the path field.
  • QuickLink. Gets the PropertyExpression for the QuickLink field.
  • Rank. Gets the PropertyExpression for the rank field.
  • ShortDescription. Gets the PropertyExpression for the short description field.
  • Size. Gets the PropertyExpression for the size field.
  • Tags. Gets the PropertyExpression for the tags field.
  • TaxonomyCategory. Gets the PropertyExpression for the taxonomy category field.
  • Title. Gets the PropertyExpression for the title field.
  • Type. Gets the PropertyExpression for the user type field.

Remarks

  • All Providers. The HighlightedSummary property expression is used to request a dynamically generated summary for each result item in your result set. This behavior varies from search provider to search provider. Its effectiveness also varies based on the quantity and quality of the data available in the index for a given piece of content. For example, XML-based content, such as Smart Form data, is less likely to render a meaningful summary than traditional textual content. It is recommended that static summaries are conditionally displayed for result items in cases where the dynamically generated one is insufficient.
  • Solr. The TaxonomyCategory property is a multi-value field in Solr. Multi-value fields provide a better development experience when consuming field data representing a collection of values. It is recommended that you reference the TaxonomyCategory property as a multi-value property expression to ensure that you are always working with the complete data for your result item (See: StringMultiValuePropertyExpression class):

    SearchContentProperty.TaxonomyCategory.AsMultiValue()

    General keyword searches of hierarchical field data is not supported. Fields such as TaxonomyCategory, FolderPath, and FolderIdPath have been optimized for queries that are programmatically constructed. When querying this type of data, your input should be a rooted, fully formed, path. For example, consider a taxonomy category of "\Departments\HR\Benefits". A query, against the taxonomy category field, with an input of "\Departments\HR" would return results associated with the category. A query with an input of "HR" would not.

    Solr will analyze the first 100,000 characters of an individual document when generating a HighlightedSummary value. For large content, a dynamic summary will not be generated if the search terms for your query are not found in the first 100,000 characters of the document.

SearchMetadataProperty

The SearchMetadataProperty class is a factory for property expressions targeting metadata fields.

Namespace

Ektron.Cms.Search.SearchMetadataProperty

Methods

  • GetBooleanProperty(String). Gets a BooleanPropertyExpression representing the metadata field identified by the specified name value.
  • GetDateProperty(String). Gets a DatePropertyExpression representing the metadata field identified by the specified name value.
  • GetDecimalProperty(String). Gets a DecimalPropertyExpression representing the metadata field identified by the specified name value.
  • GetIntegerProperty(String). Gets a IntegerPropertyExpression representing the metadata field identified by the specified name value.
  • GetStringProperty(String). Gets a StringPropertyExpression representing the metadata field identified by the specified name value.

SearchResponseData

The SearchResponseData class is a data structure delivering the results of a search query.

Namespace

Ektron.Cms.Search.SearchResponseData

Properties

  • ElapsedTime. Gets or sets the elapsed execution time for the submitted query.
  • Facets. Gets or sets a list of Facets corresponding to the search results.
  • PagingInfo. Gets or sets the paging details for this result set.
  • Results. Gets or sets a collection of results relevant to the submitted query.
  • SpellingSuggestion. Gets or sets a spelling suggestion for the submitted query.
  • SuggestedResults. Gets or sets a collection of suggested results relevant to the submitted query.
  • Terms. Gets or sets a collection of search terms identified in submitted query.

Constructors

  • SearchResponseData(). Constructor.

SearchResultData

The SearchResultData class represents an individual result item of a search query.

Namespace

Ektron.Cms.Search.SearchResultData

Properties

  • Item[BooleanMultiValuePropertyExpression]. Gets and sets a collection of values for the specified boolean property.
  • Item[BooleanPropertyExpression]. Gets and sets the value for the specified boolean property. If the value of the field is null, false is returned.
  • Item[DateMultiValuePropertyExpression]. Gets and sets a collection of values for the specified date property.
  • Item[DatePropertyExpression]. Gets and sets the value for the specified date property. If the value of the field is null, DateTime.MinValue is returned.
  • Item[DecimalMultiValuePropertyExpression]. Gets and sets a collection of values for the specified decimal property.
  • Item[DecimalPropertyExpression]. Gets and sets the value for the specified decimal property. If the value of the field is null, 0 is returned.
  • Item[IntegerMultiValuePropertyExpression]. Gets and sets a collection of values for the specified integer property.
  • Item[IntegerPropertyExpression]. Gets and sets the value for the specified integer property. If the value of the field is null, 0 is returned.
  • Item[String]. Gets and sets the value for the specified property. If the value of the field is null, DBNull is returned.
  • Item[StringMultiValuePropertyExpression]. Gets and sets a collection of values for the specified string property.
  • Item[StringPropertyExpression]. Gets and sets the value for the specified string property. If the value of the field is null, String.Empty is returned.
  • PropertyCount. Returns the number of fields in this result item.
  • Similarity. Gets or sets datac describing how closely this result item relates to other items in the result set.

Constructors

  • SearchResultData(). Constructor.
  • SearchResultData(DataRow). Constructor.
  • SearchResultData(IDictionary<String>,Object>). Constructor.

Methods

  • GetValue(BooleanMultiValuePropertyExpression). Gets a collection of values associated with the specified property.
  • GetValue(BooleanPropertyExpression). Returns the value of the field associated with the specified property.
  • GetValue(DateMultiValuePropertyExpression). Gets a collection of values associated with the specified property.
  • GetValue(DatePropertyExpression). Returns the value of the field associated with the specified property.
  • GetValue(DecimalMultiValuePropertyExpression). Gets a collection of values associated with the specified property.
  • GetValue(DecimalPropertyExpression). Returns the value of the field associated with the specified property.
  • GetValue(IntegerMultiValuePropertyExpression). Gets a collection of values associated with the specified property.
  • GetValue(IntegerPropertyExpression). Returns the value of the field associated with the specified property.
  • GetValue(String). Returns the values of the field associated with the specified property. If the value represents a single-value result, the single-value form is returned. If the value represents a multi-value result, the multi-value (collection) form is returned.
  • GetValue(StringMultiValuePropertyExpression). Gets a collection of values associated with the specified property.
  • GetValue(StringPropertyExpression). Returns the value of the field associated with the specified property.
  • HasColumn(PropertyExpression). Returns true if the specified property exists in the result item.
  • HasProperty(String). Returns true if the specified property exists in the result item.
  • IsMultiValue(PropertyExpression). Returns true if the field associated with the specified property expression represents a collection of values.
  • IsMultiValue(String). Returns true if the field associated with the specified property expression represents a collection of values.
  • IsNull(PropertyExpression). Returns true if the value of the specified field is null.
  • IsNull(String). Returns true if the value of the specified field is null.
  • SetValue(BooleanMultiValuePropertyExpression,IEnumerable<Boolean>). Sets a value for the specified boolean property.
  • SetValue(BooleanPropertyExpression,Boolean). Sets a value for the specified boolean property.
  • SetValue(DateMultiValuePropertyExpression,IEnumerable<DateTime>). Sets a value for the specified date property.
  • SetValue(DatePropertyExpression,DateTime). Sets a value for the specified date property.
  • SetValue(DecimalMultiValuePropertyExpression,IEnumerable<Double>). Sets a value for the specified decimal property.
  • SetValue(DecimalPropertyExpression,Double). Sets a value for the specified decimal property.
  • SetValue(IntegerMultiValuePropertyExpression,IEnumerable<Int64>). Sets a collection of values for the specified integer property.
  • SetValue(IntegerPropertyExpression,Int64). Sets a value for the specified integer property.
  • SetValue(String,Object). Sets a value for the specified property.
  • SetValue(StringMultiValuePropertyExpression,IEnumerable<String>). Sets a collection of values for the specified string property.
  • SetValue(StringPropertyExpression,String). Sets a value for the specified string property.

Remarks

  • FAST Search for Sharepoint 2010. Multi-value properties are not supported if your search provider is Microsoft FAST Search for SharePoint 2010. Accessors and methods on this class, accepting a multi-value property expression, should not be used.
  • Search Server 2010. Multi-value properties are not supported if your search provider is Microsoft Search Server 2010. Accessors and methods on this class, accepting a multi-value property expression, should not be used.
  • Solr. When accessing data for a multi-value property, your input to the relevant accessors and methods on this class should be a multi-value property expression. A collection of data is returned.

    If multi-value data is accessed with a traditional, single-value, property expression only the first item in that field's collection is returned. Use a multi-value property expression to ensure that you are working with the complete set of data.

    If single-value data is accessed with a multi-value property expression an exception is thrown.

SearchSmartFormProperty

The SearchSmartFormProperty class is a factory for property expressions targeting Smart Form fields.

Namespace

Ektron.Cms.Search.SearchSmartFormProperty

Methods

  • GetBooleanProperty(String). Gets a BooleanPropertyExpression representing the Smart Form field identified by the specified XPath value.
  • GetDateProperty(String). Gets a DatePropertyExpression representing the Smart Form field identified by the specified XPath value.
  • GetDecimalProperty(String). Gets a DecimalPropertyExpression representing the Smart Form field identified by the specified XPath value.
  • GetIntegerProperty(String). Gets a IntegerPropertyExpression representing the Smart Form field identified by the specified XPath value.
  • GetStringProperty(String). Gets a StringPropertyExpression representing the Smart Form field identified by the specified XPath value.

Remarks

  • All Providers. When creating a PropertyExpression for an indexed Smart Form field, specify the XPath expression denoting the desired element. (For example: root/video/description)

    The XPath expressions for Smart Form fields can be found on the "Display Information" tab when viewing a Smart Form Configuration in Workarea of your site.

  • Solr. All indexed Smart Form fields are stored as multi-value fields when your search provider is Apache Solr.

    Smart Form fields cannot be sorted on. Apache Solr does not support the sorting of multi-value fields. If sorting behavior is required for data associated with Smart Form content, please consider using a companion metadata definition.

SearchSolrProperty

The SearchSolrProperty class exposes enhanced functionality around PropertyExpressions representing Solr index fields. This provides access to behavior unique to the Solr search engine.

Namespace

Ektron.Cms.Search.Solr.SearchSolrProperty

Properties

  • SearchSolrProperty() (Static). Constructor.
  • CreateExactStringProperty(StringMultiValuePropertyExpression). Creates a property expression referencing the exact-match companion field for the specified property expression. These companion fields provide access to an untokenized and unfiltered representation of CMS property data, which can be particularly useful for performing exact term matches and requesting refinements. Note: Companion fields for Ektron properties are always multi-value fields.
  • CreateExactStringProperty(StringPropertyExpression). Creates a property expression referencing the exact-match companion field for the specified property expression. These companion fields provide access to an untokenized and unfiltered representation of CMS property data, which can be particularly useful for performing exact term matches and requesting refinements.

    NOTE: Companion fields for Ektron properties are always multi-value fields.

  • CreateExactStringProperty(String). Creates a property expression referencing the exact-match companion field for the specified property expression. These companion fields provide access to an untokenized and unfiltered representation of CMS property data, which can be particularly useful for performing exact term matches and requesting refinements. Note: Companion fields for Ektron properties are always multi-value fields.
  • CreateStringSortProperty(String). Creates a property expression referencing the explicit single value companion field for the specified property expression. Note: This is an internal function used to resolve companion index fields (particularly for Smart Form fields) where we must act on a multi-value field as if it were a single value field.
  • CreateIntegerSortProperty(String). Creates a property expression referencing the explicit single value companion field for the specified property expression. Note: This is an internal function used to resolve companion index fields (particularly for Smart Form fields) where we must act on a multi-value field as if it were a single value field.
  • CreateDecimalSortProperty(String). Creates a property expression referencing the explicit single value companion field for the specified property expression. Note: This is an internal function used to resolve companion index fields (particularly for Smart Form fields) where we must act on a multi-value field as if it were a single value field.
  • CreateDateSortProperty(String). Creates a property expression referencing the explicit single value companion field for the specified property expression. Note: This is an internal function used to resolve companion index fields (particularly for Smart Form fields) where we must act on a multi-value field as if it were a single value field.
  • CreateBooleanSortProperty(String). Creates a property expression referencing the explicit single value companion field for the specified property expression. Note: This is an internal function used to resolve companion index fields (particularly for Smart Form fields) where we must act on a multi-value field as if it were a single value field.

SearchType

Helper class for generating expressions to limit search result types.

Namespace

Ektron.Cms.Search.SearchType

Methods

  • IsContent(). Generates an expression that limits search result type to content.
  • IsDocument(). Generates an expression that limits search result type to CMS documents. Any valid document types added using the CMS, such as office files, images, PDF or multimedia are included when limiting results by using this property (Please note that valid file types are defined in the Asset Server Setup in the Settings section of Workarea of your site).
  • IsExternal(). Generates an expression that limits search result type to groups.
  • IsForum(). Generates an expression that limits search result type to forums.
  • IsGroup(). Generates an expression that limits search result type to groups.
  • IsMultimedia(). Generates an expression that limits search result type to multimedia.
  • IsNonUserContent(). Generates an expression that limits search result type to content.
  • IsProduct(). Generates an expression that limits search result type to products.
  • IsUser(). Generates an expression that limits search result type to users.

SearchUserProperty

The UserProperty class provides access to the default PropertyExpressions for formulating user queries.

Namespace

Ektron.Cms.Search.SearchUserProperty

Properties

  • Avatar. Gets the PropertyExpression for the user avatar field.
  • DateModified. Gets the PropertyExpression for the date modified field.
  • DisplayName. Gets the PropertyExpression for the display name field.
  • EmailAddress. Gets the PropertyExpression for the email address field.
  • FirstName. Gets the PropertyExpression for the first name field.
  • HighlightedSummary. Gets the PropertyExpression for the highlighted summary field.
  • Id. Gets the PropertyExpression for the user ID field.
  • Language. Gets the PropertyExpression for the user language field.
  • LastName. Gets the PropertyExpression for the last name field.
  • MapAddress. Gets the PropertyExpression for the map address field.
  • MapLatitude. Gets the PropertyExpression for the map latitude field.
  • MapLongitude. Gets the PropertyExpression for the map longitude field.
  • MembershipUser. Gets the PropertyExpression for the membership user field.
  • Path. Gets the PropertyExpression for the path field.
  • PrivateProfile. Gets the PropertyExpression for the private profile field.
  • QuickLink. Gets the PropertyExpression for the QuickLink field.
  • Rank. Gets the PropertyExpression for the rank field.
  • Size. Gets the PropertyExpression for the content size field.
  • Tags. Gets the PropertyExpression for the user tags field.
  • TaxonomyCategory. Gets the PropertyExpression for the taxonomy category field.
  • Type. Gets the PropertyExpression for the user type field.
  • UserFriends. Gets the PropertyExpression for the user fiends field.
  • UserName. Gets the PropertyExpression for the user name field.

Remarks

  • All Providers. The HighlightedSummary property expression is used to request a dynamically generated summary for each result item in your result set. This behavior varies from search provider to search provider. Its effectiveness also varies based on the quantity and quality of the data available in the index for a given piece of content. For example, XML-based content, such as Smart Form data, is less likely to render a meaningful summary than traditional textual content. It is recommended that static summaries are conditionally displayed for result items in cases where the dynamically generated one is insufficient.
  • Solr. The TaxonomyCategory property is a multi-value field in Solr. Multi-value fields provide a better development experience when consuming field data representing a collection of values. It is recommended that you reference the TaxonomyCategory property as a multi-value property expression to ensure that you are always working with the complete data for your result item (See: StringMultiValuePropertyExpression class):

    SearchContentProperty.TaxonomyCategory.AsMultiValue()

    General keyword searches of hierarchical field data is not supported. Fields such as TaxonomyCategory, FolderPath, and FolderIdPath have been optimized for queries that are programmatically constructed. When querying this type of data, your input should be a rooted, fully formed, path. For example, consider a taxonomy category of "\Departments\HR\Benefits". A query, against the taxonomy category field, with an input of "\Departments\HR" would return results associated with the category. A query with an input of "HR" would not.

    Solr will analyze the first 100,000 characters of an individual document when generating a HighlightedSummary value. For large content, a dynamic summary will not be generated if the search terms for your query are not found in the first 100,000 characters of the document.

StringFacet

The StringFacet class represents a classification of search results on a string index field.

Namespace

Ektron.Cms.Search.StringFacet

Properties

  • Buckets. Gets or sets the collection of facet buckets associated with this facet.
  • Property. Gets or sets the property associated with this facet.

Constructors

  • StringFacet(PropertyExpression). Constructor.
  • StringFacet(PropertyExpression,ICollection<UniqueFacetBucket<String>>). Constructor.
  • StringFacet(StringMultiValuePropertyExpression). Constructor.
  • StringFacet(StringMultiValuePropertyExpression,ICollection<UniqueFacetBucket<String>>). Constructor.
  • StringFacet(StringPropertyExpression). Constructor.
  • StringFacet(StringPropertyExpression,ICollection<UniqueFacetBucket<String>>). Constructor.

StringRefinementSpecification

The StringRefinementSpecification represents a strongly typed refinement specification for string index properties.

Namespace

Ektron.Cms.Search.StringRefinementSpecification

Properties

  • Filter. Hidden until this functionality becomes available.
  • Order. Hidden until this functionality becomes available.
  • Property. Gets or sets the refinement property.

Constructors

  • StringRefinementSpecification(). Constructor.
  • StringRefinementSpecification(StringMultiValuePropertyExpression). Constructor.
  • StringRefinementSpecification(StringMultiValuePropertyExpression,RefinementOrderData). Constructor.
  • StringRefinementSpecification(StringMultiValuePropertyExpression,String). Constructor.
  • StringRefinementSpecification(StringMultiValuePropertyExpression,String,RefinementOrderData). Constructor.
  • StringRefinementSpecification(StringPropertyExpression). Constructor.
  • StringRefinementSpecification(StringPropertyExpression,RefinementOrderData). Constructor.
  • StringRefinementSpecification(StringPropertyExpression,String). Constructor.
  • StringRefinementSpecification(StringPropertyExpression,String,RefinementOrderData). Constructor.

Remarks

  • All Providers. Add a StringRefinementSpecification to search criteria to identify a field for which facet data should be returned with the query results.
  • Search Server 2010. The StringRefinementSpecification is not applicable if your search provider is Microsoft Search Server 2010. Deep refinement of result sets is not available.
  • Solr. The terms used to generate string facets reflect the tokenization and filtering applied to the target index field when your search provider is Apache Solr. Often, it is better to reference a string field with minimal tokenization and filtering to achieve the best experience.

    All indexed Ektron properties have an exact-match companion field, which provides access to an untokenized and unfiltered representation of the property's data. When requesting string-based refinements, these fields often provide the desired experience. (To access these fields, see the SearchSolrProperty class.)

SimilarityResponseData

The SimilarityResponseData class encapsulates information describing how closely a result item relates to other items in the result set.

Namespace

Ektron.Cms.Search.SimilarityResponseData

Properties

  • SimilarityVector. Gets or sets a collection of similar tokens that provide document term relevancy data.

Constructors

  • SimilarityResponseData(). Constructor.

SimilaritySearchCriteria

The SimilaritySearchCriteria class captures metadata associated with a particular result item. This data is used to refine the parent query to a set of results that are similar to that result item.

Namespace

Ektron.Cms.Search.SimilaritySearchCriteria

Properties

  • IsEnabled. Gets or sets a flag indicating whether or not similarity search should be enabled for the parent query.
  • QueryType. Gets or sets the type of similarity query to be issued.
  • SimilarityVector. Gets a document vector describing a particular indexed item which is to be evaluated by the search provider, identifying other similar documents.

Constructors

  • SimilaritySearchCriteria(). Constructor.

SuggestedResultsData

Defines a suggested search result.

Namespace

Ektron.Cms.Search.SuggestedResultData

Properties

  • Description. Gets and sets the description of the suggested result.
  • Title. Gets and sets the title of the suggested result.
  • Url. Gets and sets the URL of the suggested result.

Methods

  • Equals(Object). Returns true if the specified suggested result is equal to this instance.
  • GetHashCode(). Returns the hash code for this instance of SuggestedResultData.
  • ToString(). Returns the string representation of this instance of SuggestedResultData.

UniqueFacetBucket

The UniqueFacetBucket class describes a facet bucket representing a single unique value.

Namespace

Ektron.Cms.Search.UniqueFacetBucket<T>

Properties

  • Value. Gets or sets the value associated with this facet bucket.

Constructors

  • UniqueFacetBucket(T,Int64). Constructor.