org.apache.lucene.analysis
Class WhitespaceTokenizer

java.lang.Object
  extended by org.apache.lucene.util.AttributeSource
      extended by org.apache.lucene.analysis.TokenStream
          extended by org.apache.lucene.analysis.Tokenizer
              extended by org.apache.lucene.analysis.CharTokenizer
                  extended by org.apache.lucene.analysis.WhitespaceTokenizer
All Implemented Interfaces:
Closeable

public final class WhitespaceTokenizer
extends CharTokenizer

A WhitespaceTokenizer is a tokenizer that divides text at whitespace. Adjacent sequences of non-Whitespace characters form tokens.

You must specify the required Version compatibility when creating WhitespaceTokenizer:


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.AttributeFactory, AttributeSource.State
 
Field Summary
 
Fields inherited from class org.apache.lucene.analysis.Tokenizer
input
 
Constructor Summary
WhitespaceTokenizer(AttributeSource.AttributeFactory factory, Reader in)
          Deprecated. use WhitespaceTokenizer(Version, AttributeSource.AttributeFactory, Reader) instead. This will be removed in Lucene 4.0.
WhitespaceTokenizer(AttributeSource source, Reader in)
          Deprecated. use WhitespaceTokenizer(Version, AttributeSource, Reader) instead. This will be removed in Lucene 4.0.
WhitespaceTokenizer(Reader in)
          Deprecated. use WhitespaceTokenizer(Version, Reader) instead. This will be removed in Lucene 4.0.
WhitespaceTokenizer(Version matchVersion, AttributeSource.AttributeFactory factory, Reader in)
          Construct a new WhitespaceTokenizer using a given AttributeSource.AttributeFactory.
WhitespaceTokenizer(Version matchVersion, AttributeSource source, Reader in)
          Construct a new WhitespaceTokenizer using a given AttributeSource.
WhitespaceTokenizer(Version matchVersion, Reader in)
          Construct a new WhitespaceTokenizer.
 
Method Summary
protected  boolean isTokenChar(int c)
          Collects only characters which do not satisfy Character.isWhitespace(int).
 
Methods inherited from class org.apache.lucene.analysis.CharTokenizer
end, incrementToken, isTokenChar, normalize, normalize, reset
 
Methods inherited from class org.apache.lucene.analysis.Tokenizer
close, correctOffset
 
Methods inherited from class org.apache.lucene.analysis.TokenStream
reset
 
Methods inherited from class org.apache.lucene.util.AttributeSource
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WhitespaceTokenizer

public WhitespaceTokenizer(Version matchVersion,
                           Reader in)
Construct a new WhitespaceTokenizer. * @param matchVersion Lucene version to match See above

Parameters:
in - the input to split up into tokens

WhitespaceTokenizer

public WhitespaceTokenizer(Version matchVersion,
                           AttributeSource source,
                           Reader in)
Construct a new WhitespaceTokenizer using a given AttributeSource.

Parameters:
matchVersion - Lucene version to match See above
source - the attribute source to use for this Tokenizer
in - the input to split up into tokens

WhitespaceTokenizer

public WhitespaceTokenizer(Version matchVersion,
                           AttributeSource.AttributeFactory factory,
                           Reader in)
Construct a new WhitespaceTokenizer using a given AttributeSource.AttributeFactory.

Parameters:
matchVersion - Lucene version to match See above
factory - the attribute factory to use for this Tokenizer
in - the input to split up into tokens

WhitespaceTokenizer

@Deprecated
public WhitespaceTokenizer(Reader in)
Deprecated. use WhitespaceTokenizer(Version, Reader) instead. This will be removed in Lucene 4.0.

Construct a new WhitespaceTokenizer.


WhitespaceTokenizer

@Deprecated
public WhitespaceTokenizer(AttributeSource source,
                                      Reader in)
Deprecated. use WhitespaceTokenizer(Version, AttributeSource, Reader) instead. This will be removed in Lucene 4.0.

Construct a new WhitespaceTokenizer using a given AttributeSource.


WhitespaceTokenizer

@Deprecated
public WhitespaceTokenizer(AttributeSource.AttributeFactory factory,
                                      Reader in)
Deprecated. use WhitespaceTokenizer(Version, AttributeSource.AttributeFactory, Reader) instead. This will be removed in Lucene 4.0.

Construct a new WhitespaceTokenizer using a given AttributeSource.AttributeFactory.

Method Detail

isTokenChar

protected boolean isTokenChar(int c)
Collects only characters which do not satisfy Character.isWhitespace(int).

Overrides:
isTokenChar in class CharTokenizer