org.apache.lucene.analysis.payloads
Class TypeAsPayloadTokenFilter

java.lang.Object
  extended by org.apache.lucene.util.AttributeSource
      extended by org.apache.lucene.analysis.TokenStream
          extended by org.apache.lucene.analysis.TokenFilter
              extended by org.apache.lucene.analysis.payloads.TypeAsPayloadTokenFilter

public class TypeAsPayloadTokenFilter
extends org.apache.lucene.analysis.TokenFilter

Makes the Token.type() a payload. Encodes the type using String.getBytes(String) with "UTF-8" as the encoding


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
org.apache.lucene.util.AttributeSource.AttributeFactory, org.apache.lucene.util.AttributeSource.State
 
Field Summary
 
Fields inherited from class org.apache.lucene.analysis.TokenFilter
input
 
Constructor Summary
TypeAsPayloadTokenFilter(org.apache.lucene.analysis.TokenStream input)
           
 
Method Summary
 boolean incrementToken()
           
 org.apache.lucene.analysis.Token next()
          Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer.
 org.apache.lucene.analysis.Token next(org.apache.lucene.analysis.Token reusableToken)
          Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer.
 
Methods inherited from class org.apache.lucene.analysis.TokenFilter
close, end, reset
 
Methods inherited from class org.apache.lucene.analysis.TokenStream
getOnlyUseNewAPI, setOnlyUseNewAPI
 
Methods inherited from class org.apache.lucene.util.AttributeSource
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, restoreState, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TypeAsPayloadTokenFilter

public TypeAsPayloadTokenFilter(org.apache.lucene.analysis.TokenStream input)
Method Detail

incrementToken

public final boolean incrementToken()
                             throws IOException
Overrides:
incrementToken in class org.apache.lucene.analysis.TokenStream
Throws:
IOException

next

public final org.apache.lucene.analysis.Token next(org.apache.lucene.analysis.Token reusableToken)
                                            throws IOException
Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer.

Overrides:
next in class org.apache.lucene.analysis.TokenStream
Throws:
IOException

next

public final org.apache.lucene.analysis.Token next()
                                            throws IOException
Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer.

Overrides:
next in class org.apache.lucene.analysis.TokenStream
Throws:
IOException


Copyright © 2000-2010 Apache Software Foundation. All Rights Reserved.