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 | List of all members
Lucene.Net.Analysis.Fr.FrenchStemFilter Class Reference

Inherits Lucene.Net.Analysis.TokenFilter.

Public Member Functions

 FrenchStemFilter (TokenStream _in)
 FrenchStemFilter (TokenStream _in, ISet< string > exclusiontable)
override 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.
void SetStemmer (FrenchStemmer stemmer)
void SetExclusionTable (IDictionary< string, string > exclusiontable)
- Public Member Functions inherited from Lucene.Net.Analysis.TokenFilter
override void End ()
 Performs end-of-stream operations, if any, and calls then end() on the input TokenStream.NOTE: Be sure to call super.end() first when overriding this method.
override void Reset ()
 Reset the filter as well as the input TokenStream.
- Public Member Functions inherited from Lucene.Net.Analysis.TokenStream
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))

Additional Inherited Members

- Protected Member Functions inherited from Lucene.Net.Analysis.TokenFilter
override void Dispose (bool disposing)
- Properties inherited from Lucene.Net.Util.AttributeSource
virtual AttributeFactory Factory [get]
 Returns the used AttributeFactory.
virtual bool HasAttributes [get]
 Returns true, iff this AttributeSource has any attributes

Detailed Description

Definition at line 45 of file FrenchStemFilter.cs.

Constructor & Destructor Documentation

Lucene.Net.Analysis.Fr.FrenchStemFilter.FrenchStemFilter ( TokenStream  _in)

Definition at line 56 of file FrenchStemFilter.cs.

Lucene.Net.Analysis.Fr.FrenchStemFilter.FrenchStemFilter ( TokenStream  _in,
ISet< string >  exclusiontable 

Definition at line 65 of file FrenchStemFilter.cs.

Member Function Documentation

override bool Lucene.Net.Analysis.Fr.FrenchStemFilter.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.

The producer must make no assumptions about the attributes after the method has been returned: the caller may arbitrarily change it. If the producer needs to preserve the state for subsequent calls, it can use AttributeSource.CaptureState to create a copy of the current attribute state.

This method is called for every token of a document, so an efficient implementation is crucial for good performance. To avoid calls to AttributeSource.AddAttribute{T}() and AttributeSource.GetAttribute{T}(), references to all Util.Attributes that this stream uses should be retrieved during instantiation.

To ensure that filters and consumers know which attributes are available, the attributes must be added during instantiation. Filters and consumers are not required to check for availability of attributes in IncrementToken().

false for end of stream; true otherwise

Implements Lucene.Net.Analysis.TokenStream.

Definition at line 74 of file FrenchStemFilter.cs.

void Lucene.Net.Analysis.Fr.FrenchStemFilter.SetExclusionTable ( IDictionary< string, string >  exclusiontable)

Definition at line 108 of file FrenchStemFilter.cs.

void Lucene.Net.Analysis.Fr.FrenchStemFilter.SetStemmer ( FrenchStemmer  stemmer)

Definition at line 98 of file FrenchStemFilter.cs.

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