Class StaticValueIndexer

  • All Implemented Interfaces:
    Indexer

    @Beta
    public class StaticValueIndexer
    extends java.lang.Object
    implements Indexer
    An Indexer that is creating a single Index by setting the indexed value to some static text.
    • Constructor Summary

      Constructors 
      Constructor Description
      StaticValueIndexer​(Index index, java.lang.String value)
      Creates a StaticValueIndexer.
    • Method Summary

      Modifier and Type Method Description
      java.lang.String calc​(Index index, MessageStoreEntry entry)
      Calculates the Index value from the message-store entry.
      com.google.common.collect.ImmutableSet<Index> getIndexes()
      Returns the indexes supported by this Indexer.
      MessageStoreEntry index​(MessageStoreEntry entry)  
      boolean supports​(Index index)  
      • Methods inherited from class java.lang.Object

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

      • StaticValueIndexer

        public StaticValueIndexer​(Index index,
                                  java.lang.String value)
        Creates a StaticValueIndexer.
        Parameters:
        index - the Index
        value - the static value that will be used to set the index
    • Method Detail

      • getIndexes

        @Nonnull
        public com.google.common.collect.ImmutableSet<Index> getIndexes()
        Description copied from interface: Indexer
        Returns the indexes supported by this Indexer.
        Specified by:
        getIndexes in interface Indexer
        Returns:
        Set of Index instances
      • supports

        public boolean supports​(@Nonnull
                                Index index)
        Specified by:
        supports in interface Indexer
        Parameters:
        index - the Index
        Returns:
        true, if the Index is supported, false otherwise.
      • calc

        public java.lang.String calc​(@Nonnull
                                     Index index,
                                     @Nonnull
                                     MessageStoreEntry entry)
        Description copied from interface: Indexer
        Calculates the Index value from the message-store entry.
        Specified by:
        calc in interface Indexer
        Parameters:
        index - the Index
        entry - the MessageStoreEntry
        Returns:
        indexed value