Package org.apache.lucene.analysis.tokenattributes

Class TypeAttributeImpl

java.lang.Object

org.apache.lucene.util.AttributeImpl

org.apache.lucene.analysis.tokenattributes.TypeAttributeImpl

All Implemented Interfaces:

Cloneable, TypeAttribute, Attribute

public class TypeAttributeImpl
extends AttributeImpl
implements TypeAttribute

Default implementation of TypeAttribute.

Field Summary

Fields inherited from interface org.apache.lucene.analysis.tokenattributes.TypeAttribute

DEFAULT_TYPE

Constructor Summary

Constructors

Constructor	Description
TypeAttributeImpl()	Initialize this attribute with TypeAttribute.DEFAULT_TYPE
TypeAttributeImpl(String type)	Initialize this attribute with type

Method Summary

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 other)
int	hashCode()
void	reflectWith(AttributeReflector reflector)	This method is for introspection of attributes, it should simply add the key/values this attribute holds to the given AttributeReflector.
void	setType(String type)	Set the lexical type.
String	type()	Returns this Token's lexical type.

Methods inherited from class org.apache.lucene.util.AttributeImpl

clone, end, reflectAsString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TypeAttributeImpl

public TypeAttributeImpl()

Initialize this attribute with TypeAttribute.DEFAULT_TYPE

TypeAttributeImpl

public TypeAttributeImpl(String type)

Initialize this attribute with type

Method Detail

type

public String type()

Description copied from interface: TypeAttribute

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

Specified by:

type in interface TypeAttribute

See Also:

TypeAttribute.setType(String)

setType

public void setType(String type)

Description copied from interface: TypeAttribute

Set the lexical type.

Specified by:

setType in interface TypeAttribute

See Also:

TypeAttribute.type()

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 class AttributeImpl

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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 class AttributeImpl

reflectWith

public void reflectWith(AttributeReflector reflector)

Description copied from class: AttributeImpl

This method is for introspection of attributes, it should simply add the key/values this attribute holds to the given AttributeReflector.

Implementations look like this (e.g. for a combined attribute implementation):

   public void reflectWith(AttributeReflector reflector) {
     reflector.reflect(CharTermAttribute.class, "term", term());
     reflector.reflect(PositionIncrementAttribute.class, "positionIncrement", getPositionIncrement());
   }
 

If you implement this method, make sure that for each invocation, the same set of Attribute interfaces and keys are passed to AttributeReflector.reflect(java.lang.Class<? extends org.apache.lucene.util.Attribute>, java.lang.String, java.lang.Object) in the same order, but possibly different values. So don't automatically exclude e.g. null properties!

Specified by:

reflectWith in class AttributeImpl

See Also:

AttributeImpl.reflectAsString(boolean)