public final class ReverseStringFilter extends TokenFilter
If marker is supplied, then tokens will be also prepended by
that character. For example, with a marker of \u0001, "country" =>
"\u0001yrtnuoc". This is useful when implementing efficient leading
wildcards search.
You must specify the required Version
compatibility when creating ReverseStringFilter, or when using any of
its static methods:
AttributeSource.AttributeFactory, AttributeSource.State| Modifier and Type | Field and Description |
|---|---|
static char |
INFORMATION_SEPARATOR_MARKER
Example marker character: U+001F (INFORMATION SEPARATOR ONE)
|
static char |
PUA_EC00_MARKER
Example marker character: U+EC00 (PRIVATE USE AREA: EC00)
|
static char |
RTL_DIRECTION_MARKER
Example marker character: U+200F (RIGHT-TO-LEFT MARK)
|
static char |
START_OF_HEADING_MARKER
Example marker character: U+0001 (START OF HEADING)
|
input| Constructor and Description |
|---|
ReverseStringFilter(TokenStream in)
Deprecated.
use
ReverseStringFilter(Version, TokenStream)
instead. This constructor will be removed in Lucene 4.0 |
ReverseStringFilter(TokenStream in,
char marker)
Deprecated.
use
ReverseStringFilter(Version, TokenStream, char)
instead. This constructor will be removed in Lucene 4.0 |
ReverseStringFilter(Version matchVersion,
TokenStream in)
Create a new ReverseStringFilter that reverses all tokens in the
supplied
TokenStream. |
ReverseStringFilter(Version matchVersion,
TokenStream in,
char marker)
Create a new ReverseStringFilter that reverses and marks all tokens in the
supplied
TokenStream. |
| Modifier and Type | Method and Description |
|---|---|
boolean |
incrementToken()
Consumers (i.e.,
IndexWriter) use this method to advance the stream to
the next token. |
static void |
reverse(char[] buffer)
Deprecated.
use
reverse(Version, char[]) instead. This
method will be removed in Lucene 4.0 |
static void |
reverse(char[] buffer,
int len)
Deprecated.
use
reverse(Version, char[], int) instead. This
method will be removed in Lucene 4.0 |
static void |
reverse(char[] buffer,
int start,
int len)
Deprecated.
use
reverse(Version, char[], int, int) instead. This
method will be removed in Lucene 4.0 |
static String |
reverse(String input)
Deprecated.
use
reverse(Version, String) instead. This method
will be removed in Lucene 4.0 |
static void |
reverse(Version matchVersion,
char[] buffer)
Reverses the given input buffer in-place
|
static void |
reverse(Version matchVersion,
char[] buffer,
int len)
Partially reverses the given input buffer in-place from offset 0
up to the given length.
|
static void |
reverse(Version matchVersion,
char[] buffer,
int start,
int len)
Partially reverses the given input buffer in-place from the given offset
up to the given length.
|
static String |
reverse(Version matchVersion,
String input)
Reverses the given input string
|
close, end, resetaddAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toStringpublic static final char START_OF_HEADING_MARKER
public static final char INFORMATION_SEPARATOR_MARKER
public static final char PUA_EC00_MARKER
public static final char RTL_DIRECTION_MARKER
@Deprecated public ReverseStringFilter(TokenStream in)
ReverseStringFilter(Version, TokenStream)
instead. This constructor will be removed in Lucene 4.0TokenStream.
The reversed tokens will not be marked.
in - TokenStream to filter@Deprecated public ReverseStringFilter(TokenStream in, char marker)
ReverseStringFilter(Version, TokenStream, char)
instead. This constructor will be removed in Lucene 4.0TokenStream.
The reversed tokens will be prepended (marked) by the marker
character.
in - TokenStream to filtermarker - A character used to mark reversed tokenspublic ReverseStringFilter(Version matchVersion, TokenStream in)
TokenStream.
The reversed tokens will not be marked.
matchVersion - See abovein - TokenStream to filterpublic ReverseStringFilter(Version matchVersion, TokenStream in, char marker)
TokenStream.
The reversed tokens will be prepended (marked) by the marker
character.
matchVersion - See abovein - TokenStream to filtermarker - A character used to mark reversed tokenspublic boolean incrementToken()
throws IOException
TokenStreamIndexWriter) 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().
incrementToken in class TokenStreamIOException@Deprecated public static String reverse(String input)
reverse(Version, String) instead. This method
will be removed in Lucene 4.0input - the string to reversepublic static String reverse(Version matchVersion, String input)
matchVersion - See aboveinput - the string to reverse@Deprecated public static void reverse(char[] buffer)
reverse(Version, char[]) instead. This
method will be removed in Lucene 4.0buffer - the input char array to reversepublic static void reverse(Version matchVersion, char[] buffer)
matchVersion - See abovebuffer - the input char array to reverse@Deprecated public static void reverse(char[] buffer, int len)
reverse(Version, char[], int) instead. This
method will be removed in Lucene 4.0buffer - the input char array to reverselen - the length in the buffer up to where the
buffer should be reversedpublic static void reverse(Version matchVersion, char[] buffer, int len)
matchVersion - See abovebuffer - the input char array to reverselen - the length in the buffer up to where the
buffer should be reversed@Deprecated public static void reverse(char[] buffer, int start, int len)
reverse(Version, char[], int, int) instead. This
method will be removed in Lucene 4.0buffer - the input char array to reversestart - the offset from where to reverse the bufferlen - the length in the buffer up to where the
buffer should be reversedpublic static void reverse(Version matchVersion, char[] buffer, int start, int len)
matchVersion - See abovebuffer - the input char array to reversestart - the offset from where to reverse the bufferlen - the length in the buffer up to where the
buffer should be reversed