Class Lookup

    • Constructor Detail

      • Lookup

        public Lookup()
        Sole constructor. (For invocation by subclass constructors, typically implicit.)
    • Method Detail

      • getCount

        public abstract long getCount()
        Get the number of entries the lookup was built with
        Returns:
        total number of suggester entries
      • lookup

        public abstract List<Lookup.LookupResult> lookup​(CharSequence key,
                                                         boolean onlyMorePopular,
                                                         int num)
        Look up a key and return possible completion for this key.
        Parameters:
        key - lookup key. Depending on the implementation this may be a prefix, misspelling, or even infix.
        onlyMorePopular - return only more popular results
        num - maximum number of results to return
        Returns:
        a list of possible completions, with their relative weight (e.g. popularity)
      • store

        public abstract boolean store​(DataOutput output)
                               throws IOException
        Persist the constructed lookup data to a directory. Optional operation.
        Parameters:
        output - DataOutput to write the data to.
        Returns:
        true if successful, false if unsuccessful or not supported.
        Throws:
        IOException - when fatal IO error occurs.
      • load

        public abstract boolean load​(DataInput input)
                              throws IOException
        Discard current lookup data and load it from a previously saved copy. Optional operation.
        Parameters:
        input - the DataInput to load the lookup data.
        Returns:
        true if completed successfully, false if unsuccessful or not supported.
        Throws:
        IOException - when fatal IO error occurs.
      • sizeInBytes

        public abstract long sizeInBytes()
        Get the size of the underlying lookup implementation in memory
        Returns:
        ram size of the lookup implementation in bytes