Class PathHierarchyTokenizer
- java.lang.Object
-
- org.apache.lucene.util.AttributeSource
-
- org.apache.lucene.analysis.TokenStream
-
- org.apache.lucene.analysis.Tokenizer
-
- org.apache.lucene.analysis.path.PathHierarchyTokenizer
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
public class PathHierarchyTokenizer extends Tokenizer
Tokenizer for path-like hierarchies.Take something like:
/something/something/else
and make:/something /something/something /something/something/else
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.AttributeFactory, AttributeSource.State
-
-
Field Summary
Fields Modifier and Type Field Description static char
DEFAULT_DELIMITER
static int
DEFAULT_SKIP
-
Constructor Summary
Constructors Constructor Description PathHierarchyTokenizer(Reader input)
PathHierarchyTokenizer(Reader input, char delimiter, char replacement)
PathHierarchyTokenizer(Reader input, char delimiter, char replacement, int skip)
PathHierarchyTokenizer(Reader input, int skip)
PathHierarchyTokenizer(Reader input, int bufferSize, char delimiter)
PathHierarchyTokenizer(Reader input, int bufferSize, char delimiter, char replacement, int skip)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
end()
This method is called by the consumer after the last token has been consumed, afterTokenStream.incrementToken()
returnedfalse
(using the newTokenStream
API).boolean
incrementToken()
Consumers (i.e.,IndexWriter
) use this method to advance the stream to the next token.void
reset()
Resets this stream to the beginning.-
Methods inherited from class org.apache.lucene.analysis.Tokenizer
close, correctOffset, reset
-
Methods inherited from class org.apache.lucene.util.AttributeSource
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString
-
-
-
-
Field Detail
-
DEFAULT_DELIMITER
public static final char DEFAULT_DELIMITER
- See Also:
- Constant Field Values
-
DEFAULT_SKIP
public static final int DEFAULT_SKIP
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PathHierarchyTokenizer
public PathHierarchyTokenizer(Reader input)
-
PathHierarchyTokenizer
public PathHierarchyTokenizer(Reader input, int skip)
-
PathHierarchyTokenizer
public PathHierarchyTokenizer(Reader input, int bufferSize, char delimiter)
-
PathHierarchyTokenizer
public PathHierarchyTokenizer(Reader input, char delimiter, char replacement)
-
PathHierarchyTokenizer
public PathHierarchyTokenizer(Reader input, char delimiter, char replacement, int skip)
-
PathHierarchyTokenizer
public PathHierarchyTokenizer(Reader input, int bufferSize, char delimiter, char replacement, int skip)
-
-
Method Detail
-
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 appropriateAttributeImpl
s 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)
andAttributeSource.getAttribute(Class)
, references to allAttributeImpl
s 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 classTokenStream
- Returns:
- false for end of stream; true otherwise
- Throws:
IOException
-
end
public final void end()
Description copied from class:TokenStream
This method is called by the consumer after the last token has been consumed, afterTokenStream.incrementToken()
returnedfalse
(using the newTokenStream
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 aWhitespaceTokenizer
was used.- Overrides:
end
in classTokenStream
-
reset
public void reset() throws IOException
Description copied from class:TokenStream
Resets this stream to the beginning. This is an optional operation, so subclasses may or may not implement this method.TokenStream.reset()
is not needed for the standard indexing process. However, if the tokens of aTokenStream
are intended to be consumed more than once, it is necessary to implementTokenStream.reset()
. Note that if your TokenStream caches tokens and feeds them back again after a reset, it is imperative that you clone the tokens when you store them away (on the first pass) as well as when you return them (on future passes afterTokenStream.reset()
).- Overrides:
reset
in classTokenStream
- Throws:
IOException
-
-