Summary: Nested Classes | Ctors | Methods | Inherited Methods | [Expand All]

public class

AttributeSource

extends Object

java.lang.Object
↳	org.apache.lucene.util.AttributeSource

Known Direct Subclasses

TokenStream

Known Indirect Subclasses

ASCIIFoldingFilter, CachingTokenFilter, CharTokenizer, ISOLatin1AccentFilter, KeywordTokenizer, LengthFilter, LetterTokenizer, LowerCaseFilter, LowerCaseTokenizer, NumericTokenStream, PorterStemFilter, StandardFilter, StandardTokenizer, StopFilter, TeeSinkTokenFilter, TeeSinkTokenFilter.SinkTokenStream, TokenFilter, Tokenizer, WhitespaceTokenizer

ASCIIFoldingFilter	This class converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if one exists.
CachingTokenFilter	This class can be used if the token attributes of a TokenStream are intended to be consumed more than once.
CharTokenizer	An abstract base class for simple, character-oriented tokenizers.
ISOLatin1AccentFilter	This class is deprecated. If you build a new index, use `ASCIIFoldingFilter` which covers a superset of Latin 1. This class is included for use with existing indexes and will be removed in a future release (possibly Lucene 4.0).
KeywordTokenizer	Emits the entire input as a single token.
LengthFilter	Removes words that are too long or too short from the stream.
LetterTokenizer	A LetterTokenizer is a tokenizer that divides text at non-letters.
LowerCaseFilter	Normalizes token text to lower case.
LowerCaseTokenizer	LowerCaseTokenizer performs the function of LetterTokenizer and LowerCaseFilter together.
NumericTokenStream	Expert: This class provides a `TokenStream` for indexing numeric values that can be used by `NumericRangeQuery` or `NumericRangeFilter`.
PorterStemFilter	Transforms the token stream as per the Porter stemming algorithm.
StandardFilter	Normalizes tokens extracted with `StandardTokenizer`.
StandardTokenizer	A grammar-based tokenizer constructed with JFlex This should be a good tokenizer for most European-language documents: Splits words at punctuation characters, removing punctuation.
StopFilter	Removes stop words from a token stream.
TeeSinkTokenFilter	This TokenFilter provides the ability to set aside attribute states that have already been analyzed.
TeeSinkTokenFilter.SinkTokenStream
TokenFilter	A TokenFilter is a TokenStream whose input is another TokenStream.
Tokenizer	A Tokenizer is a TokenStream whose input is a Reader.
WhitespaceTokenizer	A WhitespaceTokenizer is a tokenizer that divides text at whitespace.

Class Overview

An AttributeSource contains a list of different AttributeImpls, and methods to add and get them. There can only be a single instance of an attribute in the same AttributeSource instance. This is ensured by passing in the actual type of the Attribute (Class<Attribute>) to the addAttribute(Class), which then checks if an instance of that type is already present. If yes, it returns the instance, otherwise it creates a new instance and returns it.

Summary

Nested Classes
class	AttributeSource.AttributeFactory	An AttributeFactory creates instances of `AttributeImpl`s.
class	AttributeSource.State	This class holds the state of an AttributeSource.

Public Constructors
	AttributeSource() An AttributeSource using the default attribute factory `DEFAULT_ATTRIBUTE_FACTORY`.
	AttributeSource(AttributeSource input) An AttributeSource that uses the same attributes as the supplied one.
	AttributeSource(AttributeSource.AttributeFactory factory) An AttributeSource using the supplied `AttributeSource.AttributeFactory` for creating new `Attribute` instances.

Public Methods
<A extends Attribute> A	addAttribute(Class<A> attClass) The caller must pass in a Class<? extends Attribute> value.
void	addAttributeImpl(AttributeImpl att) Expert: Adds a custom AttributeImpl instance with one or more Attribute interfaces.
AttributeSource.State	captureState() Captures the state of all Attributes.
void	clearAttributes() Resets all Attributes in this AttributeSource by calling `clear()` on each Attribute implementation.
AttributeSource	cloneAttributes() Performs a clone of all `AttributeImpl` instances returned in a new AttributeSource instance.
boolean	equals(Object obj)
<A extends Attribute> A	getAttribute(Class<A> attClass) The caller must pass in a Class<? extends Attribute> value.
Iterator<Class<? extends Attribute>>	getAttributeClassesIterator() Returns a new iterator that iterates the attribute classes in the same order they were added in.
AttributeSource.AttributeFactory	getAttributeFactory() returns the used AttributeFactory.
Iterator<AttributeImpl>	getAttributeImplsIterator() Returns a new iterator that iterates all unique Attribute implementations.
boolean	hasAttribute(Class<? extends Attribute> attClass) The caller must pass in a Class<? extends Attribute> value.
boolean	hasAttributes() Returns true, iff this AttributeSource has any attributes
int	hashCode()
void	restoreState(AttributeSource.State state) Restores this state by copying the values of all attribute implementations that this state contains into the attributes implementations of the targetStream.
String	toString()

[Expand]

Inherited Methods

From class java.lang.Object

Public Constructors

public AttributeSource ()

An AttributeSource using the default attribute factory DEFAULT_ATTRIBUTE_FACTORY.

public AttributeSource (AttributeSource input)

An AttributeSource that uses the same attributes as the supplied one.

public AttributeSource (AttributeSource.AttributeFactory factory)

An AttributeSource using the supplied AttributeSource.AttributeFactory for creating new Attribute instances.

Public Methods

public A addAttribute (Class<A> attClass)

The caller must pass in a Class<? extends Attribute> value. This method first checks if an instance of that class is already in this AttributeSource and returns it. Otherwise a new instance is created, added to this AttributeSource and returned.

public void addAttributeImpl (AttributeImpl att)

Expert: Adds a custom AttributeImpl instance with one or more Attribute interfaces.

Please note: It is not guaranteed, that att is added to the AttributeSource, because the provided attributes may already exist. You should always retrieve the wanted attributes using getAttribute(Class) after adding with this method and cast to your class. The recommended way to use custom implementations is using an AttributeSource.AttributeFactory.

public AttributeSource.State captureState ()

Captures the state of all Attributes. The return value can be passed to restoreState(AttributeSource.State) to restore the state of this or another AttributeSource.

public void clearAttributes ()

Resets all Attributes in this AttributeSource by calling clear() on each Attribute implementation.

public AttributeSource cloneAttributes ()

Performs a clone of all AttributeImpl instances returned in a new AttributeSource instance. This method can be used to e.g. create another TokenStream with exactly the same attributes (using AttributeSource(AttributeSource))

public boolean equals (Object obj)

public A getAttribute (Class<A> attClass)

The caller must pass in a Class<? extends Attribute> value. Returns the instance of the passed in Attribute contained in this AttributeSource

Throws

IllegalArgumentException if this AttributeSource does not contain the Attribute. It is recommended to always use addAttribute(Class) even in consumers of TokenStreams, because you cannot know if a specific TokenStream really uses a specific Attribute. addAttribute(Class) will automatically make the attribute available. If you want to only use the attribute, if it is available (to optimize consuming), use hasAttribute(Class).

public Iterator<Class<? extends Attribute>> getAttributeClassesIterator ()

Returns a new iterator that iterates the attribute classes in the same order they were added in.

public AttributeSource.AttributeFactory getAttributeFactory ()

returns the used AttributeFactory.

public Iterator<AttributeImpl> getAttributeImplsIterator ()

Returns a new iterator that iterates all unique Attribute implementations. This iterator may contain less entries that getAttributeClassesIterator(), if one instance implements more than one Attribute interface.

public boolean hasAttribute (Class<? extends Attribute> attClass)

The caller must pass in a Class<? extends Attribute> value. Returns true, iff this AttributeSource contains the passed-in Attribute.

public boolean hasAttributes ()

Returns true, iff this AttributeSource has any attributes

public int hashCode ()

public void restoreState (AttributeSource.State state)

Restores this state by copying the values of all attribute implementations that this state contains into the attributes implementations of the targetStream. The targetStream must contain a corresponding instance for each argument contained in this state (e.g. it is not possible to restore the state of an AttributeSource containing a TermAttribute into a AttributeSource using a Token instance as implementation).

Note that this method does not affect attributes of the targetStream that are not contained in this state. In other words, if for example the targetStream contains an OffsetAttribute, but this state doesn't, then the value of the OffsetAttribute remains unchanged. It might be desirable to reset its value to the default, in which case the caller should first call clearAttributes() on the targetStream.

Interfaces

Classes

Enums

Exceptions