Class KeywordAttributeImpl
- java.lang.Object
-
- org.apache.lucene.util.AttributeImpl
-
- org.apache.lucene.analysis.tokenattributes.KeywordAttributeImpl
-
- All Implemented Interfaces:
Serializable
,Cloneable
,KeywordAttribute
,Attribute
public final class KeywordAttributeImpl extends AttributeImpl implements KeywordAttribute
This attribute can be used to mark a token as a keyword. Keyword awareTokenStream
s can decide to modify a token based on the return value ofisKeyword()
if the token is modified. Stemming filters for instance can use this attribute to conditionally skip a term ifisKeyword()
returnstrue
.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.util.AttributeImpl
enableBackwards
-
-
Constructor Summary
Constructors Constructor Description KeywordAttributeImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Clears the values in this AttributeImpl and resets it to its default value.void
copyTo(AttributeImpl target)
Copies the values from this Attribute into the passed-in target attribute.boolean
equals(Object obj)
int
hashCode()
boolean
isKeyword()
Returnstrue
iff the current token is a keyword, otherwisefalse
/void
setKeyword(boolean isKeyword)
Marks the current token as keyword iff set totrue
.-
Methods inherited from class org.apache.lucene.util.AttributeImpl
clone, reflectAsString, reflectWith, toString
-
-
-
-
Method Detail
-
clear
public void clear()
Description copied from class:AttributeImpl
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.- Specified by:
clear
in classAttributeImpl
-
copyTo
public void copyTo(AttributeImpl target)
Description copied from class:AttributeImpl
Copies the values from this Attribute into the passed-in target attribute. The target implementation must support all the Attributes this implementation supports.- Specified by:
copyTo
in classAttributeImpl
-
isKeyword
public boolean isKeyword()
Returnstrue
iff the current token is a keyword, otherwisefalse
/- Specified by:
isKeyword
in interfaceKeywordAttribute
- Returns:
true
iff the current token is a keyword, otherwisefalse
/
-
setKeyword
public void setKeyword(boolean isKeyword)
Marks the current token as keyword iff set totrue
.- Specified by:
setKeyword
in interfaceKeywordAttribute
- Parameters:
isKeyword
-true
iff the current token is a keyword, otherwisefalse
.
-
-