Class ScriptFacetResult

  • All Implemented Interfaces:
    java.io.Serializable

    public class ScriptFacetResult
    extends java.lang.Object
    implements java.io.Serializable
    Scriptable facet. Specific for use by Search script as part of the object model.
    Author:
    Jamal Kaabi-Mofrad
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      ScriptFacetResult​(java.lang.String facetValue, java.lang.String facetLabel, int facetLabelIndex, int hits)  
    • Constructor Detail

      • ScriptFacetResult

        public ScriptFacetResult​(java.lang.String facetValue,
                                 java.lang.String facetLabel,
                                 int facetLabelIndex,
                                 int hits)
        Parameters:
        facetValue - the facet value. e.g. the content creator's userID
        facetLabel - the display name of the facetValue. e.g. jdoe => John Doe
        facetLabelIndex - the label index to be used for sorting (Optional).The default value is -1
        hits - the number of hits
    • Method Detail

      • getFacetValue

        public java.lang.String getFacetValue()
        Returns:
        the facetValue
      • getFacetLabel

        public java.lang.String getFacetLabel()
        Returns:
        the facetLabel
      • getFacetLabelIndex

        public int getFacetLabelIndex()
        Returns:
        the facetLabelIndex
      • getHits

        public int getHits()
        Returns:
        the hits