Class InputIterator.InputIteratorWrapper

  • All Implemented Interfaces:
    InputIterator, BytesRefIterator
    Enclosing interface:
    InputIterator

    public static class InputIterator.InputIteratorWrapper
    extends java.lang.Object
    implements InputIterator
    Wraps a BytesRefIterator as a suggester InputIterator, with all weights set to 1 and carries no payload
    • Constructor Summary

      Constructors 
      Constructor Description
      InputIteratorWrapper​(BytesRefIterator wrapped)
      Creates a new wrapper, wrapping the specified iterator and specifying a weight value of 1 for all terms and nullifies associated payloads.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Set<BytesRef> contexts()
      A term's contexts context can be used to filter suggestions.
      boolean hasContexts()
      Returns true if the iterator has contexts
      boolean hasPayloads()
      Returns true if the iterator has payloads
      BytesRef next()
      Increments the iteration to the next BytesRef in the iterator.
      BytesRef payload()
      An arbitrary byte[] to record per suggestion.
      long weight()
      A term's weight, higher numbers mean better suggestions.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • InputIteratorWrapper

        public InputIteratorWrapper​(BytesRefIterator wrapped)
        Creates a new wrapper, wrapping the specified iterator and specifying a weight value of 1 for all terms and nullifies associated payloads.
    • Method Detail

      • weight

        public long weight()
        Description copied from interface: InputIterator
        A term's weight, higher numbers mean better suggestions.
        Specified by:
        weight in interface InputIterator
      • next

        public BytesRef next()
                      throws java.io.IOException
        Description copied from interface: BytesRefIterator
        Increments the iteration to the next BytesRef in the iterator. Returns the resulting BytesRef or null if the end of the iterator is reached. The returned BytesRef may be re-used across calls to next. After this method returns null, do not call it again: the results are undefined.
        Specified by:
        next in interface BytesRefIterator
        Returns:
        the next BytesRef in the iterator or null if the end of the iterator is reached.
        Throws:
        java.io.IOException - If there is a low-level I/O error.
      • hasPayloads

        public boolean hasPayloads()
        Description copied from interface: InputIterator
        Returns true if the iterator has payloads
        Specified by:
        hasPayloads in interface InputIterator
      • contexts

        public java.util.Set<BytesRef> contexts()
        Description copied from interface: InputIterator
        A term's contexts context can be used to filter suggestions. May return null, if suggest entries do not have any context
        Specified by:
        contexts in interface InputIterator
      • hasContexts

        public boolean hasContexts()
        Description copied from interface: InputIterator
        Returns true if the iterator has contexts
        Specified by:
        hasContexts in interface InputIterator