 |
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.
|
|
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.
|
Joins two token streams and leaves the last token of the first stream available to be used when updating the token values in the second stream based on that token. More...
Inherits Lucene.Net.Analysis.TokenStream.
Inherited by Lucene.Net.Analysis.Miscellaneous.InjectablePrefixAwareTokenFilter.
Public Member Functions | |
| 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. | |
| virtual Token | UpdateSuffixToken (Token suffixToken, Token lastPrefixToken) |
| The default implementation adds last prefix token end offset to the suffix token start and end offsets. | |
| 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< Attribute > | GetAttributeImplsIterator () |
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)) | |
Protected Member Functions | |
| override void | Dispose (bool disposing) |
Properties | |
| TokenStream | Prefix [get, set] |
| TokenStream | Suffix [get, set] |
Joins two token streams and leaves the last token of the first stream available to be used when updating the token values in the second stream based on that token.
The default implementation adds last prefix token end offset to the suffix token start and end offsets.
NOTE: This filter might not behave correctly if used with custom Attributes, i.e. Attributes other than the ones located in Lucene.Net.Analysis.TokenAttributes.
Definition at line 32 of file PrefixAwareTokenStream.cs.
| Lucene.Net.Analysis.Miscellaneous.PrefixAwareTokenFilter.PrefixAwareTokenFilter | ( | TokenStream | prefix, |
| TokenStream | suffix | ||
| ) |
Definition at line 53 of file PrefixAwareTokenStream.cs.
|
protectedvirtual |
Implements Lucene.Net.Analysis.TokenStream.
Definition at line 163 of file PrefixAwareTokenStream.cs.
|
virtual |
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().
Implements Lucene.Net.Analysis.TokenStream.
Definition at line 80 of file PrefixAwareTokenStream.cs.
|
virtual |
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()).
Reimplemented from Lucene.Net.Analysis.TokenStream.
Definition at line 169 of file PrefixAwareTokenStream.cs.
|
virtual |
The default implementation adds last prefix token end offset to the suffix token start and end offsets.
| suffixToken | a token from the suffix stream |
| lastPrefixToken | the last token from the prefix stream |
Reimplemented in Lucene.Net.Analysis.Miscellaneous.InjectablePrefixAwareTokenFilter.
Definition at line 156 of file PrefixAwareTokenStream.cs.
|
getset |
Definition at line 76 of file PrefixAwareTokenStream.cs.
|
getset |
Definition at line 78 of file PrefixAwareTokenStream.cs.
1.8.3
