cbelasticsearch

Class SearchResult

lucee.Component
    extended by cbelasticsearch.SearchResult

Elasticsearch Search Result Object

Class Attributes:
  • license : Apache v2.0
  •  
  • package : cbElasticsearch.models
  •  
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
  • author : Jon Clausen
  •  
    Property Summary
    type property default serializable required
    any aggregations
          The array of result of aggregations.

    • access = public
    • returntype = any
    true false
    any executionTime
          The execution time, in MS.

    • access = public
    • returntype = any
    true false
    any hitCount
          The total number of hits.

    • access = public
    • returntype = any
    true false
    any hits
          The array of result hits.

    • access = public
    • returntype = any
    true false
    any limit
          The paging limit.

    • access = public
    • returntype = any
    true false
    any maxScore
          The maximum score of the hits retrieved.

    • access = public
    • returntype = any
    true false
    any start
          The starting record number.

    • access = public
    • returntype = any
    true false
    any suggestions
          The struct result of suggestions.

    • access = public
    • returntype = any
    true false
    Constructor Summary
    init()
    Method Summary
    string getAggregations()
    string getExecutionTime()
    string getHitCount()
    string getHits()
    string getLimit()
    string getMaxScore()
    string getStart()
    string getSuggestions()
    SearchResult new([struct properties])
         Creates a new SearchResult instance.
    Document newDocument()
    SearchResult populate(struct properties)
         Populates the search result object from a struct.
    SearchResult populateHits(array hits)
         Populates the hits of the search with documents.
    any setAggregations(any aggregations)
    any setExecutionTime(any executionTime)
    any setHitCount(any hitCount)
    any setHits(any hits)
    any setLimit(any limit)
    any setMaxScore(any maxScore)
    any setStart(any start)
    any setSuggestions(any suggestions)
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init()


    Property Detail

    aggregations

    property any aggregations

    The array of result of aggregations

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    executionTime

    property any executionTime

    The execution time, in MS

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    hitCount

    property any hitCount

    The total number of hits

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    hits

    property any hits

    The array of result hits

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    limit

    property any limit

    The paging limit

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    maxScore

    property any maxScore

    The maximum score of the hits retrieved

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    start

    property any start

    The starting record number

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    suggestions

    property any suggestions

    The struct result of suggestions

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    Method Detail

    getAggregations

    public string getAggregations()


    getExecutionTime

    public string getExecutionTime()


    getHitCount

    public string getHitCount()


    getHits

    public string getHits()


    getLimit

    public string getLimit()


    getMaxScore

    public string getMaxScore()


    getStart

    public string getStart()


    getSuggestions

    public string getSuggestions()


    new

    public SearchResult new([struct properties])

    Creates a new SearchResult instance

    Parameters:
    properties - struct A search result struct ( e.g. JEST Client result object ) to populate the results object

    newDocument

    public Document newDocument()


    populate

    public SearchResult populate(struct properties)

    Populates the search result object from a struct

    Parameters:
    properties - struct A search result struct ( e.g. JEST Client result object ) to populate the results object

    populateHits

    public SearchResult populateHits(array hits)

    Populates the hits of the search with documents

    Parameters:
    hits - array The array of search results hits

    setAggregations

    public any setAggregations(any aggregations)

    Parameters:
    aggregations

    setExecutionTime

    public any setExecutionTime(any executionTime)

    Parameters:
    executionTime

    setHitCount

    public any setHitCount(any hitCount)

    Parameters:
    hitCount

    setHits

    public any setHits(any hits)

    Parameters:
    hits

    setLimit

    public any setLimit(any limit)

    Parameters:
    limit

    setMaxScore

    public any setMaxScore(any maxScore)

    Parameters:
    maxScore

    setStart

    public any setStart(any start)

    Parameters:
    start

    setSuggestions

    public any setSuggestions(any suggestions)

    Parameters:
    suggestions