Module org.apache.lucene.analysis.common
Package org.apache.lucene.analysis.path

Class ReversePathHierarchyTokenizer

java.lang.Object
org.apache.lucene.util.AttributeSource
org.apache.lucene.analysis.TokenStream
org.apache.lucene.analysis.Tokenizer
org.apache.lucene.analysis.path.ReversePathHierarchyTokenizer
All Implemented Interfaces:
Closeable, AutoCloseable
public class ReversePathHierarchyTokenizer extends Tokenizer
Tokenizer for domain-like hierarchies.

Take something like: 

 www.site.co.uk
and make: 
 www.site.co.uk
 site.co.uk
 co.uk
 uk

  • Field Details

    • DEFAULT_BUFFER_SIZE

      private static final int DEFAULT_BUFFER_SIZE
      See Also:

    • DEFAULT_DELIMITER

      public static final char DEFAULT_DELIMITER
      See Also:

    • DEFAULT_SKIP

      public static final int DEFAULT_SKIP
      See Also:

    • delimiter

      private final char delimiter

    • replacement

      private final char replacement

    • skip

      private final int skip

    • termAtt

      private final CharTermAttribute termAtt

    • offsetAtt

      private final OffsetAttribute offsetAtt

    • posAtt

      private final PositionIncrementAttribute posAtt

    • endPosition

      private int endPosition

    • finalOffset

      private int finalOffset

    • skipped

      private int skipped

    • resultToken

      private StringBuilder resultToken

    • delimiterPositions

      private IntArrayList delimiterPositions

    • delimitersCount

      private int delimitersCount

    • resultTokenBuffer

      private char[] resultTokenBuffer

  • Constructor Details

    • ReversePathHierarchyTokenizer

      public ReversePathHierarchyTokenizer()

    • ReversePathHierarchyTokenizer

      public ReversePathHierarchyTokenizer(int skip)

    • ReversePathHierarchyTokenizer

      public ReversePathHierarchyTokenizer(int bufferSize, char delimiter)

    • ReversePathHierarchyTokenizer

      public ReversePathHierarchyTokenizer(char delimiter, char replacement)

    • ReversePathHierarchyTokenizer

      public ReversePathHierarchyTokenizer(int bufferSize, char delimiter, char replacement)

    • ReversePathHierarchyTokenizer

      public ReversePathHierarchyTokenizer(char delimiter, int skip)

    • ReversePathHierarchyTokenizer

      public ReversePathHierarchyTokenizer(char delimiter, char replacement, int skip)

    • ReversePathHierarchyTokenizer

      public ReversePathHierarchyTokenizer(AttributeFactory factory, char delimiter, char replacement, int skip)

    • ReversePathHierarchyTokenizer

      public ReversePathHierarchyTokenizer(int bufferSize, char delimiter, char replacement, int skip)

    • ReversePathHierarchyTokenizer

      public ReversePathHierarchyTokenizer(AttributeFactory factory, int bufferSize, char delimiter, char replacement, int skip)

  • Method Details

    • incrementToken

      public final boolean incrementToken() throws IOException
      Description copied from class: TokenStream
      Consumers (i.e., IndexWriter) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriate AttributeImpls with the attributes of the next token.

      The producer must make no assumptions about the attributes after the method has been returned: the caller may arbitrarily change it. If the producer needs to preserve the state for subsequent calls, it can use AttributeSource.captureState() to create a copy of the current attribute state.

      This method is called for every token of a document, so an efficient implementation is crucial for good performance. To avoid calls to AttributeSource.addAttribute(Class) and AttributeSource.getAttribute(Class), references to all AttributeImpls that this stream uses should be retrieved during instantiation.

      To ensure that filters and consumers know which attributes are available, the attributes must be added during instantiation. Filters and consumers are not required to check for availability of attributes in TokenStream.incrementToken().

      Specified by:
      incrementToken in class TokenStream
      Returns:
      false for end of stream; true otherwise
      Throws:
      IOException

    • end

      public final void end() throws IOException
      Description copied from class: TokenStream
      This method is called by the consumer after the last token has been consumed, after TokenStream.incrementToken() returned false (using the new TokenStream API). Streams implementing the old API should upgrade to use this feature.

      This method can be used to perform any end-of-stream operations, such as setting the final offset of a stream. The final offset of a stream might differ from the offset of the last token eg in case one or more whitespaces followed after the last token, but a WhitespaceTokenizer was used.

      Additionally any skipped positions (such as those removed by a stopfilter) can be applied to the position increment, or any adjustment of other attributes where the end-of-stream value may be important.

      If you override this method, always call super.end().

      Overrides:
      end in class TokenStream
      Throws:
      IOException - If an I/O error occurs

    • reset

      public void reset() throws IOException
      Description copied from class: TokenStream
      This method is called by a consumer before it begins consumption using TokenStream.incrementToken().

      Resets this stream to a clean state. Stateful implementations must implement this method so that they can be reused, just as if they had been created fresh.

      If you override this method, always call super.reset(), otherwise some internal state will not be correctly reset (e.g., Tokenizer will throw IllegalStateException on further usage).

      Overrides:
      reset in class Tokenizer
      Throws:
      IOException