Class Lookup.LookupResult

  • All Implemented Interfaces:
    java.lang.Comparable<Lookup.LookupResult>
    Enclosing class:
    Lookup

    public static final class Lookup.LookupResult
    extends java.lang.Object
    implements java.lang.Comparable<Lookup.LookupResult>
    Result of a lookup.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.Object highlightKey
      Expert: custom Object to hold the result of a highlighted suggestion.
      java.lang.CharSequence key
      the key's text
      BytesRef payload
      the key's payload (null if not present)
      long value
      the key's weight
    • Constructor Summary

      Constructors 
      Constructor Description
      LookupResult​(java.lang.CharSequence key, long value)
      Create a new result from a key+weight pair.
      LookupResult​(java.lang.CharSequence key, long value, BytesRef payload)
      Create a new result from a key+weight+payload triple.
      LookupResult​(java.lang.CharSequence key, java.lang.Object highlightKey, long value, BytesRef payload)
      Create a new result from a key+highlightKey+weight+payload triple.
    • Field Detail

      • key

        public final java.lang.CharSequence key
        the key's text
      • highlightKey

        public final java.lang.Object highlightKey
        Expert: custom Object to hold the result of a highlighted suggestion.
      • value

        public final long value
        the key's weight
      • payload

        public final BytesRef payload
        the key's payload (null if not present)
    • Constructor Detail

      • LookupResult

        public LookupResult​(java.lang.CharSequence key,
                            long value)
        Create a new result from a key+weight pair.
      • LookupResult

        public LookupResult​(java.lang.CharSequence key,
                            long value,
                            BytesRef payload)
        Create a new result from a key+weight+payload triple.
      • LookupResult

        public LookupResult​(java.lang.CharSequence key,
                            java.lang.Object highlightKey,
                            long value,
                            BytesRef payload)
        Create a new result from a key+highlightKey+weight+payload triple.
    • Method Detail

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object