Ankiro.SearchServer.Data.Search NamespaceAnkiro Enterprise Suite Reference Documentation
This namespace contains data structures that are used by the ISearchWebService service.
Classes

  ClassDescription
Public classFacetDefinition
Public classFacetProperty
Public classFacetPropertyBucket
Public classPaginationDefinition
Public classPreFacetInfo
The PreFacetInfo class is part of a SearchResult and contains group summation information about which groups would have been matched without any SearchParameters.FacetParameters specified.
Public classPreviewSearchParameters
Public classPreviewSearchResult
Public classResultDocumentData
Public classResultDocumentHotspotInformation
Public classResultDocumentHotspotProperty
Public classResultDocumentHotspotTerm
Public classResultDocumentItemData
The ResultDocumentItemData class contains information about a matched document item.
Public classResultDocumentPropertyData
Public classSearchCommandPreview
A SearchCommandPreview allows you to inspect the generated search XML as it was sent to the search engine. Useful to debug and fine tune search profile behavior.
Public classSearchDiagnostics
Public classSearchFacet
Public classSearchFacetValue
Public classSearchFilter
Public classSearchPage
Public classSearchPagination
Public classSearchParameters
The SearchParameters class encapsulates the mandatory and optional parameters used to specify how to carry out a search.
Examples

SearchParameters example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Ankiro.Suite.Client.SearchSample.SearchService;

namespace Ankiro.Suite.Client.SearchSample
{
    public class SearchIdExample
    {
        private SearchWebService searchService;
        public SearchIdExample(SearchWebService service)
        {
            searchService = service;
            SearchProfileId = 1;
            ResultsPerPage = 10;
        }

        public int SearchProfileId { get; set; }
        public int ResultsPerPage { get; set; }
        private Guid? _searchId;

        /// <summary> 
        /// Executes a paged search. Page is assumed to be 1-offset, so that e.g. page=1 retrieves the first 'ResultsPerPage' results. 
        /// </summary> 
        /// <param name="searchString"></param> 
        /// <param name="page"></param> 
        /// <returns></returns> 
        public SearchResult ExecutePagedSearch(string searchString, int page)
        {
            if (page < 1) throw new ArgumentException("page");
            var result = searchService.Search(new SearchParameters()
                                            {
                                                SearchProfileId = SearchProfileId,
                                                SearchString =  searchString,
                                                // Calculate the logical offset of the first document to retrieve, taking paging into account.
                                                Offset = (page-1) * ResultsPerPage,
                                                MaxResults = ResultsPerPage,
                                                // Transmit any previously retrieved SearchId to make sure that logging is done correctly.
                                                SearchId = _searchId.HasValue ? _searchId.Value : Guid.Empty,
                                                // LogSearch is overriden to false if SearchId is not empty
                                                LogSearch = true,
                                                SessionId = HttpContext.Current.Session.SessionID,
                                                RequestedBy = HttpContext.Current.Request.UserHostAddress,
                                            });
            if (!_searchId.HasValue)
                _searchId = result.SearchId;

            return result;
        }
    }
}
Public classSearchPath
The SearchPath class is used to reference a data source or a location in a data source path hierarchy. One or more SearchPath instances may be passed along as a part of the SearchParameters class.
Public classSearchResult
The SearchResult class contains all information associated with a search result as e.g. obtained through the search web service.
Public classSearchResultDecorations
The DecoratedSearchResult class contains all information associated with a search operation including the search parameters, the result and additional post-processing helpers.
Public classSearchResultGroupInfo
The SearchResultGroupInfo class contains information about a grouping of result documents based on distinct property values.
Public classSearchResultGroupInfoGroup
The SearchResultGroupInfoGroup class contains information about counts and documents matching a specific distinct property value.
Public classSearchResultGroupInfoGroupKeyedCollection
Public classSearchResultGroupSummation
The SearchResultGroupSummation class contains information about the total number of documents sharing a distinct property value for a given search query.
Public classSearchResultGroupSummationGroup
The SearchResultGroupSummationGroup class contains information about the total number of documents matching a specific property value, for a given search query.
Public classSearchResultThreshold
Public classTypeAheadIndexPropertySource
Public classTypeAheadNamedIndexPropertySource
Public classTypeAheadParameters
The TypeAheadParameters class encapsulates the mandatory and optional parameters used to obtain type ahead suggestions from Ankiro Suite. Type ahead is the term used for suggestions as to what the user may be in the process of typing from within a search box. Type ahead suggestions are generated using analysis of previous searches for a specified search profile. Type ahead parameters are used in conjunction with the ISearchWebService.GetTypeAheadSuggestions method.
Public classTypeAheadSearchLogSource
Public classTypeAheadSearchProfileSource
Public classTypeAheadSource
Public classTypeAheadSuggestion
Contains a type ahead suggestion, specifying a search phrase and an historical average of the number of results matching the search phrase.
Enumerations

  EnumerationDescription
Public enumerationTypeAheadLookupMethod
Public enumerationTypeAheadSortMethod