public class

TermAttributeImpl

extends AttributeImpl
implements Serializable Cloneable TermAttribute
java.lang.Object
   ↳ org.apache.lucene.util.AttributeImpl
     ↳ org.apache.lucene.analysis.tokenattributes.TermAttributeImpl

Class Overview

The term text of a Token.

Summary

Public Constructors
TermAttributeImpl()
Public Methods
void clear()
Clears the values in this AttributeImpl and resets it to its default value.
Object clone()
Shallow clone.
void copyTo(AttributeImpl target)
Copies the values from this Attribute into the passed-in target attribute.
boolean equals(Object other)
All values used for computation of hashCode() should be checked here for equality.
int hashCode()
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;
   }
 
see also equals(Object)
char[] resizeTermBuffer(int newSize)
Grows the termBuffer to at least size newSize, preserving the existing content.
void setTermBuffer(String buffer, int offset, int length)
Copies the contents of buffer, starting at offset and continuing for length characters, into the termBuffer array.
void setTermBuffer(String buffer)
Copies the contents of buffer into the termBuffer array.
void setTermBuffer(char[] buffer, int offset, int length)
Copies the contents of buffer, starting at offset for length characters, into the termBuffer array.
void setTermLength(int length)
Set number of valid characters (length of the term) in the termBuffer array.
String term()
Returns the Token's term text.
char[] termBuffer()
Returns the internal termBuffer character array which you can then directly alter.
int termLength()
Return number of valid characters (length of the term) in the termBuffer array.
String toString()
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;
   }
 
This method may be overridden by subclasses.
[Expand]
Inherited Methods
From class org.apache.lucene.util.AttributeImpl
From class java.lang.Object
From interface org.apache.lucene.analysis.tokenattributes.TermAttribute

Public Constructors

public TermAttributeImpl ()

Public Methods

public void clear ()

Clears the values in this AttributeImpl and resets it to its default value. If this implementation implements more than one Attribute interface it clears all.

public Object clone ()

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

public void copyTo (AttributeImpl target)

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

public boolean equals (Object other)

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

public int hashCode ()

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;
   }
 
see also equals(Object)

public char[] resizeTermBuffer (int newSize)

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.

Parameters
newSize minimum size of the new termBuffer
Returns
  • newly created termBuffer with length >= newSize

public void setTermBuffer (String buffer, int offset, int length)

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

Parameters
buffer the buffer to copy
offset the index in the buffer of the first character to copy
length the number of characters to copy

public void setTermBuffer (String buffer)

Copies the contents of buffer into the termBuffer array.

Parameters
buffer the buffer to copy

public void setTermBuffer (char[] buffer, int offset, int length)

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

Parameters
buffer the buffer to copy
offset the index in the buffer of the first character to copy
length the number of characters to copy

public void setTermLength (int length)

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.

Parameters
length the truncated length

public String term ()

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())

public char[] termBuffer ()

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.

public int termLength ()

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

public String toString ()

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;
   }
 
This method may be overridden by subclasses.