Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Public Member Functions | Properties | List of all members
Lucene.Net.Analysis.Miscellaneous.InjectablePrefixAwareTokenFilter Class Reference

Inherits Lucene.Net.Analysis.Miscellaneous.PrefixAwareTokenFilter.

Public Member Functions

 InjectablePrefixAwareTokenFilter (TokenStream prefix, TokenStream suffix)
override Token UpdateSuffixToken (Token suffixToken, Token lastPrefixToken)
 The default implementation adds last prefix token end offset to the suffix token start and end offsets.
- Public Member Functions inherited from Lucene.Net.Analysis.Miscellaneous.PrefixAwareTokenFilter
 PrefixAwareTokenFilter (TokenStream prefix, TokenStream suffix)
override sealed bool IncrementToken ()
 Consumers (i.e., IndexWriter) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriate Util.Attributes with the attributes of the next token.
override void Reset ()
 Resets this stream to the beginning. This is an optional operation, so subclasses may or may not implement this method. Reset() is not needed for the standard indexing process. However, if the tokens of a TokenStream are intended to be consumed more than once, it is necessary to implement Reset(). Note that if your TokenStream caches tokens and feeds them back again after a reset, it is imperative that you clone the tokens when you store them away (on the first pass) as well as when you return them (on future passes after Reset()).
- Public Member Functions inherited from Lucene.Net.Analysis.TokenStream
virtual void End ()
 This method is called by the consumer after the last token has been consumed, after IncrementToken returned false (using the new TokenStream API). Streams implementing the old API should upgrade to use this feature. This method can be used to perform any end-of-stream operations, such as setting the final offset of a stream. The final offset of a stream might differ from the offset of the last token eg in case one or more whitespaces followed after the last token, but a WhitespaceTokenizer was used.
void Close ()
 Releases resources associated with this stream.
void Dispose ()
- Public Member Functions inherited from Lucene.Net.Util.AttributeSource
 AttributeSource ()
 An AttributeSource using the default attribute factory AttributeSource.AttributeFactory.DEFAULT_ATTRIBUTE_FACTORY.
 AttributeSource (AttributeSource input)
 An AttributeSource that uses the same attributes as the supplied one.
 AttributeSource (AttributeFactory factory)
 An AttributeSource using the supplied AttributeFactory for creating new IAttribute instances.
virtual IEnumerable< Type > GetAttributeTypesIterator ()
 Returns a new iterator that iterates the attribute classes in the same order they were added in. Signature for Java 1.5: public Iterator<Class<? extends Attribute>> getAttributeClassesIterator()
virtual IEnumerable< AttributeGetAttributeImplsIterator ()
 Returns a new iterator that iterates all unique Attribute implementations. This iterator may contain less entries that GetAttributeTypesIterator, if one instance implements more than one Attribute interface. Signature for Java 1.5: public Iterator<AttributeImpl> getAttributeImplsIterator()
virtual void AddAttributeImpl (Attribute att)
 Expert: Adds a custom AttributeImpl instance with one or more Attribute interfaces.
virtual T AddAttribute< T > ()
 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.
virtual bool HasAttribute< T > ()
 The caller must pass in a Class<? extends Attribute> value. Returns true, iff this AttributeSource contains the passed-in Attribute.
virtual T GetAttribute< T > ()
 The caller must pass in a Class<? extends Attribute> value. Returns the instance of the passed in Attribute contained in this AttributeSource
virtual void ClearAttributes ()
 Resets all Attributes in this AttributeSource by calling Attribute.Clear() on each Attribute implementation.
virtual State CaptureState ()
 Captures the state of all Attributes. The return value can be passed to RestoreState to restore the state of this or another AttributeSource.
virtual void RestoreState (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).
override int GetHashCode ()
override bool Equals (System.Object obj)
override System.String ToString ()
virtual AttributeSource CloneAttributes ()
 Performs a clone of all Attribute 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))


Func< Token, Token, TokenUpdateAction [get, set]
- Properties inherited from Lucene.Net.Analysis.Miscellaneous.PrefixAwareTokenFilter
TokenStream Prefix [get, set]
TokenStream Suffix [get, set]

Additional Inherited Members

- Protected Member Functions inherited from Lucene.Net.Analysis.Miscellaneous.PrefixAwareTokenFilter
override void Dispose (bool disposing)

Detailed Description

Definition at line 22 of file InjectablePrefixAwareTokenFilter.cs.

Constructor & Destructor Documentation

Lucene.Net.Analysis.Miscellaneous.InjectablePrefixAwareTokenFilter.InjectablePrefixAwareTokenFilter ( TokenStream  prefix,
TokenStream  suffix 

Definition at line 24 of file InjectablePrefixAwareTokenFilter.cs.

Member Function Documentation

override Token Lucene.Net.Analysis.Miscellaneous.InjectablePrefixAwareTokenFilter.UpdateSuffixToken ( Token  suffixToken,
Token  lastPrefixToken 

The default implementation adds last prefix token end offset to the suffix token start and end offsets.

suffixTokena token from the suffix stream
lastPrefixTokenthe last token from the prefix stream
consumer token

Reimplemented from Lucene.Net.Analysis.Miscellaneous.PrefixAwareTokenFilter.

Definition at line 30 of file InjectablePrefixAwareTokenFilter.cs.

Property Documentation

Func<Token, Token, Token> Lucene.Net.Analysis.Miscellaneous.InjectablePrefixAwareTokenFilter.UpdateAction

Definition at line 28 of file InjectablePrefixAwareTokenFilter.cs.

The documentation for this class was generated from the following file: