Token

Convenience factory that returns Token as implementation for the basic attributes and return the default impl (with "Impl" appended) for all other attributes.

Constructs a Token will null text.

Constructs a Token with null text and start & end offsets.

Constructs a Token with null text and start & end offsets plus the Token type.

Constructs a Token with null text and start & end offsets plus flags. NOTE: flags is EXPERIMENTAL.

Constructs a Token with the given term text, and start & end offsets. The type defaults to "word." NOTE: for better indexing speed you should instead use the char[] termBuffer methods to set the term text.

Constructs a Token with the given text, start and end offsets, & type. NOTE: for better indexing speed you should instead use the char[] termBuffer methods to set the term text.

Constructs a Token with the given text, start and end offsets, & type. NOTE: for better indexing speed you should instead use the char[] termBuffer methods to set the term text.

Constructs a Token with the given term buffer (offset & length), start and end offsets

Resets the term text, payload, flags, and positionIncrement, startOffset, endOffset and token type to default.

Makes a clone, but replaces the term buffer & start/end offset in the process. This is more efficient than doing a full clone (and then calling setTermBuffer) because it saves a wasted copy of the old termBuffer.

Shallow clone. Subclasses must override this if they need to clone any members deeply,

Copies the values from this Attribute into the passed-in target attribute. The target implementation must support all the Attributes this implementation supports.

Returns this Token's ending offset, one greater than the position of the last character corresponding to this token in the source text. The length of the token in the source text is (endOffset - startOffset).

All values used for computation of hashCode() should be checked here for equality. see also equals(Object)

EXPERIMENTAL: While we think this is here to stay, we may want to change it to be a long.

Get the bitset for any bits that have been set. This is completely distinct from type(), although they do share similar purposes. The flags can be used to encode information about the token for use by other TokenFilters.

Returns this Token's payload.

Returns the position increment of this Token.

Subclasses must implement this method and should compute a hashCode similar to this:

   public int hashCode() {
     int code = startOffset;
     code = code * 31 + endOffset;
     return code;
   }
 

Shorthand for calling clear(), setTermBuffer(String, int, int), setStartOffset(int), setEndOffset(int) setType(String) on Token.DEFAULT_TYPE

Shorthand for calling clear(), setTermBuffer(String, int, int), setStartOffset(int), setEndOffset(int) setType(String)

Shorthand for calling clear(), setTermBuffer(String), setStartOffset(int), setEndOffset(int) setType(String)

Copy the prototype token's fields into this one, with a different term. Note: Payloads are shared.

Shorthand for calling clear(), setTermBuffer(char[], int, int), setStartOffset(int), setEndOffset(int), setType(String)

Shorthand for calling clear(), setTermBuffer(char[], int, int), setStartOffset(int), setEndOffset(int) setType(String) on Token.DEFAULT_TYPE

Copy the prototype token's fields into this one. Note: Payloads are shared.

Copy the prototype token's fields into this one, with a different term. Note: Payloads are shared.

Shorthand for calling clear(), setTermBuffer(String), setStartOffset(int), setEndOffset(int) setType(String) on Token.DEFAULT_TYPE

Grows the termBuffer to at least size newSize, preserving the existing content. Note: If the next operation is to change the contents of the term buffer use setTermBuffer(char[], int, int), setTermBuffer(String), or setTermBuffer(String, int, int) to optimally combine the resize with the setting of the termBuffer.

Set the ending offset.

Set the starting and ending offset.

Sets this Token's payload.

Set the position increment. This determines the position of this token relative to the previous Token in a TokenStream, used in phrase searching.

The default value is one.

Some common uses for this are:

• Set it to zero to put multiple terms in the same position. This is useful if, e.g., a word has multiple stems. Searches for phrases including either stem will match. In this case, all but the first stem's increment should be set to zero: the increment of the first instance should be one. Repeating a token with an increment of zero can also be used to boost the scores of matches on that token.
• Set it to values greater than one to inhibit exact phrase matches. If, for example, one does not want phrases to match across removed stop words, then one could build a stop word filter that removes stop words and also sets the increment to the number of stop words removed before each non-stop word. Then exact phrase queries will only match when the terms occur with no intervening stop words.

Set the starting offset.

Copies the contents of buffer into the termBuffer array.

Copies the contents of buffer, starting at offset for length characters, into the termBuffer array.

Copies the contents of buffer, starting at offset and continuing for length characters, into the termBuffer array.

Set number of valid characters (length of the term) in the termBuffer array. Use this to truncate the termBuffer or to synchronize with external manipulation of the termBuffer. Note: to grow the size of the array, use resizeTermBuffer(int) first.

Set the lexical type.

Returns this Token's starting offset, the position of the first character corresponding to this token in the source text. Note that the difference between endOffset() and startOffset() may not be equal to termLength(), as the term text may have been altered by a stemmer or some other filter.

Returns the Token's term text. This method has a performance penalty because the text is stored internally in a char[]. If possible, use termBuffer() and termLength() directly instead. If you really need a String, use this method, which is nothing more than a convenience call to new String(token.termBuffer(), 0, token.termLength())

Returns the internal termBuffer character array which you can then directly alter. If the array is too small for your token, use resizeTermBuffer(int) to increase it. After altering the buffer be sure to call setTermLength(int) to record the number of valid characters that were placed into the termBuffer.

Return number of valid characters (length of the term) in the termBuffer array.

The default implementation of this method accesses all declared fields of this object and prints the values in the following syntax:

   public String toString() {
     return "start=" + startOffset + ",end=" + endOffset;
   }
 

Returns this Token's lexical type. Defaults to "word".