Class TeeSinkTokenFilter

This TokenFilter provides the ability to set aside attribute states that have already been analyzed. This is useful in situations where multiple fields share many common analysis steps and then go their separate ways.

It is also useful for doing things like entity extraction or proper noun analysis as part of the analysis workflow and saving off those tokens for use in another field. 

TeeSinkTokenFilter source1 = new TeeSinkTokenFilter(new WhitespaceTokenizer(version, reader1));
TeeSinkTokenFilter.SinkTokenStream sink1 = source1.NewSinkTokenStream();
TeeSinkTokenFilter.SinkTokenStream sink2 = source1.NewSinkTokenStream();

TeeSinkTokenFilter source2 = new TeeSinkTokenFilter(new WhitespaceTokenizer(version, reader2));
source2.AddSinkTokenStream(sink1);
source2.AddSinkTokenStream(sink2);

TokenStream final1 = new LowerCaseFilter(version, source1);
TokenStream final2 = source2;
TokenStream final3 = new EntityDetect(sink1);
TokenStream final4 = new URLDetect(sink2);

d.Add(new TextField("f1", final1, Field.Store.NO));
d.Add(new TextField("f2", final2, Field.Store.NO));
d.Add(new TextField("f3", final3, Field.Store.NO));
d.Add(new TextField("f4", final4, Field.Store.NO));

In this example, sink1 and sink2 will both get tokens from both reader1 and reader2 after whitespace tokenizer and now we can further wrap any of these in extra analysis, and more "sources" can be inserted if desired. It is important, that tees are consumed before sinks (in the above example, the field names must be less the sink's field names). If you are not sure, which stream is consumed first, you can simply add another sink and then pass all tokens to the sinks at once using ConsumeAllTokens(). This TokenFilter is exhausted after this. In the above example, change the example above to:

...
TokenStream final1 = new LowerCaseFilter(version, source1.NewSinkTokenStream());
TokenStream final2 = source2.NewSinkTokenStream();
sink1.ConsumeAllTokens();
sink2.ConsumeAllTokens();
...

In this case, the fields can be added in any order, because the sources are not used anymore and all sinks are ready.

Note, the EntityDetect and URLDetect TokenStreams are for the example and do not currently exist in Lucene.

Inheritance
System.Object
AttributeSource
TokenStream
TokenFilter
TeeSinkTokenFilter
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Lucene.Net.Analysis.Sinks
Assembly: Lucene.Net.Analysis.Common.dll
Syntax
public sealed class TeeSinkTokenFilter : TokenFilter, IDisposable

Constructors

| Improve this Doc View Source

TeeSinkTokenFilter(TokenStream)

Instantiates a new TeeSinkTokenFilter.

Declaration
public TeeSinkTokenFilter(TokenStream input)
Parameters
Type Name Description
TokenStream input

Methods

| Improve this Doc View Source

AddSinkTokenStream(TeeSinkTokenFilter.SinkTokenStream)

Adds a TeeSinkTokenFilter.SinkTokenStream created by another TeeSinkTokenFilter to this one. The supplied stream will also receive all consumed tokens. This method can be used to pass tokens from two different tees to one sink.

Declaration
public void AddSinkTokenStream(TeeSinkTokenFilter.SinkTokenStream sink)
Parameters
Type Name Description
TeeSinkTokenFilter.SinkTokenStream sink
| Improve this Doc View Source

ConsumeAllTokens()

TeeSinkTokenFilter passes all tokens to the added sinks when itself is consumed. To be sure, that all tokens from the input stream are passed to the sinks, you can call this methods. This instance is exhausted after this, but all sinks are instant available.

Declaration
public void ConsumeAllTokens()
| Improve this Doc View Source

End()

Declaration
public override sealed void End()
Overrides
| Improve this Doc View Source

IncrementToken()

Declaration
public override bool IncrementToken()
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

NewSinkTokenStream()

Returns a new TeeSinkTokenFilter.SinkTokenStream that receives all tokens consumed by this stream.

Declaration
public TeeSinkTokenFilter.SinkTokenStream NewSinkTokenStream()
Returns
Type Description
TeeSinkTokenFilter.SinkTokenStream
| Improve this Doc View Source

NewSinkTokenStream(TeeSinkTokenFilter.SinkFilter)

Returns a new TeeSinkTokenFilter.SinkTokenStream that receives all tokens consumed by this stream that pass the supplied filter.

Declaration
public TeeSinkTokenFilter.SinkTokenStream NewSinkTokenStream(TeeSinkTokenFilter.SinkFilter filter)
Parameters
Type Name Description
TeeSinkTokenFilter.SinkFilter filter
Returns
Type Description
TeeSinkTokenFilter.SinkTokenStream
See Also

Implements

System.IDisposable