Class TSTLookup

    • Constructor Detail

      • TSTLookup

        public TSTLookup()
        Creates a new TSTLookup with an empty Ternary Search Tree.
        See Also:
        build(InputIterator)
    • Method Detail

      • add

        public boolean add​(CharSequence key,
                           Object value)
        Adds a new node if key already exists, otherwise replaces its value.

        This method always returns true.

      • get

        public Object get​(CharSequence key)
        Returns the value for the specified key, or null if the key does not exist.
      • lookup

        public List<Lookup.LookupResult> lookup​(CharSequence key,
                                                boolean onlyMorePopular,
                                                int num)
        Description copied from class: Lookup
        Look up a key and return possible completion for this key.
        Specified by:
        lookup in class Lookup
        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 boolean store​(DataOutput output)
                      throws IOException
        Description copied from class: Lookup
        Persist the constructed lookup data to a directory. Optional operation.
        Specified by:
        store in class Lookup
        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 boolean load​(DataInput input)
                     throws IOException
        Description copied from class: Lookup
        Discard current lookup data and load it from a previously saved copy. Optional operation.
        Specified by:
        load in class Lookup
        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 long sizeInBytes()
        Returns byte size of the underlying TST
        Specified by:
        sizeInBytes in class Lookup
        Returns:
        ram size of the lookup implementation in bytes
      • getCount

        public long getCount()
        Description copied from class: Lookup
        Get the number of entries the lookup was built with
        Specified by:
        getCount in class Lookup
        Returns:
        total number of suggester entries