org.apache.lucene.wikipedia.analysis
Class WikipediaTokenizer

java.lang.Object
  org.apache.lucene.analysis.TokenStream
      org.apache.lucene.analysis.Tokenizer
          org.apache.lucene.wikipedia.analysis.WikipediaTokenizer

public class WikipediaTokenizer
extends Tokenizer

Extension of StandardTokenizer that is aware of Wikipedia syntax. It is based off of the Wikipedia tutorial available at http://en.wikipedia.org/wiki/Wikipedia:Tutorial, but it may not be complete.

EXPERIMENTAL !!!!!!!!! NOTE: This Tokenizer is considered experimental and the grammar is subject to change in the trunk and in follow up releases.

Field Summary

static int	ACRONYM_ID
static int	ALPHANUM_ID
static int	APOSTROPHE_ID
static java.lang.String	BOLD
static int	BOLD_ID
static java.lang.String	BOLD_ITALICS
static int	BOLD_ITALICS_ID
static int	BOTH
static java.lang.String	CATEGORY
static int	CATEGORY_ID
static java.lang.String	CITATION
static int	CITATION_ID
static int	CJ_ID
static int	COMPANY_ID
static int	EMAIL_ID
static java.lang.String	EXTERNAL_LINK
static int	EXTERNAL_LINK_ID
static java.lang.String	EXTERNAL_LINK_URL
static int	EXTERNAL_LINK_URL_ID
static java.lang.String	HEADING
static int	HEADING_ID
static int	HOST_ID
static java.lang.String	INTERNAL_LINK
static int	INTERNAL_LINK_ID
static java.lang.String	ITALICS
static int	ITALICS_ID
static int	NUM_ID
static java.lang.String	SUB_HEADING
static int	SUB_HEADING_ID
static java.lang.String[]	TOKEN_TYPES String token types that correspond to token type int constants
static java.lang.String[]	tokenImage Deprecated. Please use TOKEN_TYPES instead
static int	TOKENS_ONLY
static int	UNTOKENIZED_ONLY

Fields inherited from class org.apache.lucene.analysis.Tokenizer

input

Constructor Summary

WikipediaTokenizer(java.io.Reader input)
Creates a new instance of the WikipediaTokenizer.

Method Summary

Token	next(Token result) Returns the next token in the stream, or null at EOS.
void	reset() Resets this stream to the beginning.
void	reset(java.io.Reader reader) Expert: Reset the tokenizer to a new reader.

Methods inherited from class org.apache.lucene.analysis.Tokenizer

close

Methods inherited from class org.apache.lucene.analysis.TokenStream

next

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INTERNAL_LINK

public static final java.lang.String INTERNAL_LINK

See Also:

Constant Field Values

EXTERNAL_LINK

public static final java.lang.String EXTERNAL_LINK

See Also:

Constant Field Values

EXTERNAL_LINK_URL

public static final java.lang.String EXTERNAL_LINK_URL

See Also:

Constant Field Values

CITATION

public static final java.lang.String CITATION

See Also:

Constant Field Values

CATEGORY

public static final java.lang.String CATEGORY

See Also:

Constant Field Values

BOLD

public static final java.lang.String BOLD

See Also:

Constant Field Values

ITALICS

public static final java.lang.String ITALICS

See Also:

Constant Field Values

BOLD_ITALICS

public static final java.lang.String BOLD_ITALICS

See Also:

Constant Field Values

HEADING

public static final java.lang.String HEADING

See Also:

Constant Field Values

SUB_HEADING

public static final java.lang.String SUB_HEADING

See Also:

Constant Field Values

ALPHANUM_ID

public static final int ALPHANUM_ID

See Also:

Constant Field Values

APOSTROPHE_ID

public static final int APOSTROPHE_ID

See Also:

Constant Field Values

ACRONYM_ID

public static final int ACRONYM_ID

See Also:

Constant Field Values

COMPANY_ID

public static final int COMPANY_ID

See Also:

Constant Field Values

EMAIL_ID

public static final int EMAIL_ID

See Also:

Constant Field Values

HOST_ID

public static final int HOST_ID

See Also:

Constant Field Values

NUM_ID

public static final int NUM_ID

See Also:

Constant Field Values

CJ_ID

public static final int CJ_ID

See Also:

Constant Field Values

INTERNAL_LINK_ID

public static final int INTERNAL_LINK_ID

See Also:

Constant Field Values

EXTERNAL_LINK_ID

public static final int EXTERNAL_LINK_ID

See Also:

Constant Field Values

CITATION_ID

public static final int CITATION_ID

See Also:

Constant Field Values

CATEGORY_ID

public static final int CATEGORY_ID

See Also:

Constant Field Values

BOLD_ID

public static final int BOLD_ID

See Also:

Constant Field Values

ITALICS_ID

public static final int ITALICS_ID

See Also:

Constant Field Values

BOLD_ITALICS_ID

public static final int BOLD_ITALICS_ID

See Also:

Constant Field Values

HEADING_ID

public static final int HEADING_ID

See Also:

Constant Field Values

SUB_HEADING_ID

public static final int SUB_HEADING_ID

See Also:

Constant Field Values

EXTERNAL_LINK_URL_ID

public static final int EXTERNAL_LINK_URL_ID

See Also:

Constant Field Values

TOKEN_TYPES

public static final java.lang.String[] TOKEN_TYPES

String token types that correspond to token type int constants

tokenImage

public static final java.lang.String[] tokenImage

Deprecated. Please use TOKEN_TYPES instead

TOKENS_ONLY

public static final int TOKENS_ONLY

See Also:

Constant Field Values

UNTOKENIZED_ONLY

public static final int UNTOKENIZED_ONLY

See Also:

Constant Field Values

BOTH

public static final int BOTH

See Also:

Constant Field Values

Constructor Detail

WikipediaTokenizer

public WikipediaTokenizer(java.io.Reader input)

Creates a new instance of the WikipediaTokenizer. Attaches the input to a newly created JFlex scanner.

Parameters:

input - The Input Reader

Method Detail

next

public Token next(Token result)
           throws java.io.IOException

Description copied from class: TokenStream

Returns the next token in the stream, or null at EOS. When possible, the input Token should be used as the returned Token (this gives fastest tokenization performance), but this is not required and a new Token may be returned. Callers may re-use a single Token instance for successive calls to this method.

This implicitly defines a "contract" between consumers (callers of this method) and producers (implementations of this method that are the source for tokens):

• A consumer must fully consume the previously returned Token before calling this method again.
• A producer must call Token.clear() before setting the fields in it & returning it

Note that a TokenFilter is considered a consumer.

Overrides:

next in class TokenStream

Parameters:

result - a Token that may or may not be used to return

Returns:

next token in the stream or null if end-of-stream was hit

Throws:

java.io.IOException

reset

public void reset()
           throws java.io.IOException

Description copied from class: TokenStream

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().

Overrides:

reset in class TokenStream

Throws:

java.io.IOException

reset

public void reset(java.io.Reader reader)
           throws java.io.IOException

Description copied from class: Tokenizer

Expert: Reset the tokenizer to a new reader. Typically, an analyzer (in its reusableTokenStream method) will use this to re-use a previously created tokenizer.

Overrides:

reset in class Tokenizer

Throws:

java.io.IOException