Save This Page
Home » lucene-3.0.1-src » org.apache » lucene » analysis » [javadoc | source]
org.apache.lucene.analysis
public final class: TeeSinkTokenFilter [javadoc | source]
java.lang.Object
   org.apache.lucene.util.AttributeSource
      org.apache.lucene.analysis.TokenStream
         org.apache.lucene.analysis.TokenFilter
            org.apache.lucene.analysis.TeeSinkTokenFilter

All Implemented Interfaces:
    Closeable

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(reader1));
TeeSinkTokenFilter.SinkTokenStream sink1 = source1.newSinkTokenStream();
TeeSinkTokenFilter.SinkTokenStream sink2 = source1.newSinkTokenStream();

TeeSinkTokenFilter source2 = new TeeSinkTokenFilter(new WhitespaceTokenizer(reader2));
source2.addSinkTokenStream(sink1);
source2.addSinkTokenStream(sink2);

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

d.add(new Field("f1", final1));
d.add(new Field("f2", final2));
d.add(new Field("f3", final3));
d.add(new Field("f4", final4));
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(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.
Nested Class Summary:
abstract public static class  TeeSinkTokenFilter.SinkFilter  A filter that decides which {@link AttributeSource} states to store in the sink. 
public static final class  TeeSinkTokenFilter.SinkTokenStream   
Fields inherited from org.apache.lucene.analysis.TokenFilter:
input
Constructor:
 public TeeSinkTokenFilter(TokenStream input) 
    Instantiates a new TeeSinkTokenFilter.
Method from org.apache.lucene.analysis.TeeSinkTokenFilter Summary:
addSinkTokenStream,   consumeAllTokens,   end,   incrementToken,   newSinkTokenStream,   newSinkTokenStream
Methods from org.apache.lucene.analysis.TokenFilter:
close,   end,   reset
Methods from org.apache.lucene.analysis.TokenStream:
close,   end,   incrementToken,   reset
Methods from org.apache.lucene.util.AttributeSource:
addAttribute,   addAttributeImpl,   captureState,   clearAttributes,   cloneAttributes,   equals,   getAttribute,   getAttributeClassesIterator,   getAttributeFactory,   getAttributeImplsIterator,   hasAttribute,   hasAttributes,   hashCode,   restoreState,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.lucene.analysis.TeeSinkTokenFilter Detail:
 public  void addSinkTokenStream(SinkTokenStream sink) 
    Adds a 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.
 public  void consumeAllTokens() throws IOException 
    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.
 public final  void end() throws IOException 
 public boolean incrementToken() throws IOException 
 public SinkTokenStream newSinkTokenStream() 
    Returns a new SinkTokenStream that receives all tokens consumed by this stream.
 public SinkTokenStream newSinkTokenStream(SinkFilter filter) 
    Returns a new SinkTokenStream that receives all tokens consumed by this stream that pass the supplied filter.