Class WikipediaTokenizer
- All Implemented Interfaces:
Closeable
,AutoCloseable
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final String
static final int
static final String
static final int
static final int
Output the both the untokenized token and the splitsstatic final String
static final int
static final String
static final int
static final int
static final int
static final int
static final String
static final int
static final String
static final int
private boolean
private final FlagsAttribute
static final String
static final int
static final int
static final String
static final int
static final String
static final int
static final int
private final OffsetAttribute
private final PositionIncrementAttribute
private final WikipediaTokenizerImpl
A private instance of the JFlex-constructed scannerstatic final String
static final int
private final CharTermAttribute
static final String[]
String token types that correspond to token type int constantsprivate int
private Iterator
<AttributeSource.State> static final int
Only output tokensprivate final TypeAttribute
static final int
Only output untokenized tokens, which are tokens that would normally be split into several tokensstatic final int
This flag is used to indicate that the produced "Token" would, ifTOKENS_ONLY
was used, produce multiple tokens.Fields inherited from class org.apache.lucene.analysis.TokenStream
DEFAULT_TOKEN_ATTRIBUTE_FACTORY
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new instance of theWikipediaTokenizer
.WikipediaTokenizer
(int tokenOutput, Set<String> untokenizedTypes) Creates a new instance of theWikipediaTokenizer
.WikipediaTokenizer
(AttributeFactory factory, int tokenOutput, Set<String> untokenizedTypes) Creates a new instance of theWikipediaTokenizer
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Releases resources associated with this stream.private void
collapseAndSaveTokens
(int tokenType, String type) private void
collapseTokens
(int tokenType) void
end()
This method is called by the consumer after the last token has been consumed, afterTokenStream.incrementToken()
returnedfalse
(using the newTokenStream
API).final boolean
Consumers (i.e.,IndexWriter
) use this method to advance the stream to the next token.private void
void
reset()
This method is called by a consumer before it begins consumption usingTokenStream.incrementToken()
.private void
setupSavedToken
(int positionInc, String type) private void
Methods inherited from class org.apache.lucene.analysis.Tokenizer
correctOffset, setReader, setReaderTestPoint
Methods inherited from class org.apache.lucene.util.AttributeSource
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, endAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, removeAllAttributes, restoreState, toString
-
Field Details
-
INTERNAL_LINK
- See Also:
-
EXTERNAL_LINK
- See Also:
-
EXTERNAL_LINK_URL
- See Also:
-
CITATION
- See Also:
-
CATEGORY
- See Also:
-
BOLD
- See Also:
-
ITALICS
- See Also:
-
BOLD_ITALICS
- See Also:
-
HEADING
- See Also:
-
SUB_HEADING
- See Also:
-
ALPHANUM_ID
public static final int ALPHANUM_ID- See Also:
-
APOSTROPHE_ID
public static final int APOSTROPHE_ID- See Also:
-
ACRONYM_ID
public static final int ACRONYM_ID- See Also:
-
COMPANY_ID
public static final int COMPANY_ID- See Also:
-
EMAIL_ID
public static final int EMAIL_ID- See Also:
-
HOST_ID
public static final int HOST_ID- See Also:
-
NUM_ID
public static final int NUM_ID- See Also:
-
CJ_ID
public static final int CJ_ID- See Also:
-
INTERNAL_LINK_ID
public static final int INTERNAL_LINK_ID- See Also:
-
EXTERNAL_LINK_ID
public static final int EXTERNAL_LINK_ID- See Also:
-
CITATION_ID
public static final int CITATION_ID- See Also:
-
CATEGORY_ID
public static final int CATEGORY_ID- See Also:
-
BOLD_ID
public static final int BOLD_ID- See Also:
-
ITALICS_ID
public static final int ITALICS_ID- See Also:
-
BOLD_ITALICS_ID
public static final int BOLD_ITALICS_ID- See Also:
-
HEADING_ID
public static final int HEADING_ID- See Also:
-
SUB_HEADING_ID
public static final int SUB_HEADING_ID- See Also:
-
EXTERNAL_LINK_URL_ID
public static final int EXTERNAL_LINK_URL_ID- See Also:
-
TOKEN_TYPES
String token types that correspond to token type int constants -
TOKENS_ONLY
public static final int TOKENS_ONLYOnly output tokens- See Also:
-
UNTOKENIZED_ONLY
public static final int UNTOKENIZED_ONLYOnly output untokenized tokens, which are tokens that would normally be split into several tokens- See Also:
-
BOTH
public static final int BOTHOutput the both the untokenized token and the splits- See Also:
-
UNTOKENIZED_TOKEN_FLAG
public static final int UNTOKENIZED_TOKEN_FLAGThis flag is used to indicate that the produced "Token" would, ifTOKENS_ONLY
was used, produce multiple tokens.- See Also:
-
scanner
A private instance of the JFlex-constructed scanner -
tokenOutput
private int tokenOutput -
untokenizedTypes
-
tokens
-
offsetAtt
-
typeAtt
-
posIncrAtt
-
termAtt
-
flagsAtt
-
first
private boolean first
-
-
Constructor Details
-
WikipediaTokenizer
public WikipediaTokenizer()Creates a new instance of theWikipediaTokenizer
. Attaches theinput
to a newly created JFlex scanner. -
WikipediaTokenizer
Creates a new instance of theWikipediaTokenizer
. Attaches theinput
to the newly created JFlex scanner.- Parameters:
tokenOutput
- One ofTOKENS_ONLY
,UNTOKENIZED_ONLY
,BOTH
-
WikipediaTokenizer
Creates a new instance of theWikipediaTokenizer
. Attaches theinput
to the newly created JFlex scanner. Uses the givenAttributeFactory
.- Parameters:
tokenOutput
- One ofTOKENS_ONLY
,UNTOKENIZED_ONLY
,BOTH
-
-
Method Details
-
init
-
incrementToken
Description copied from class:TokenStream
Consumers (i.e.,IndexWriter
) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriateAttributeImpl
s with the attributes of the next token.The producer must make no assumptions about the attributes after the method has been returned: the caller may arbitrarily change it. If the producer needs to preserve the state for subsequent calls, it can use
AttributeSource.captureState()
to create a copy of the current attribute state.This method is called for every token of a document, so an efficient implementation is crucial for good performance. To avoid calls to
AttributeSource.addAttribute(Class)
andAttributeSource.getAttribute(Class)
, references to allAttributeImpl
s that this stream uses should be retrieved during instantiation.To ensure that filters and consumers know which attributes are available, the attributes must be added during instantiation. Filters and consumers are not required to check for availability of attributes in
TokenStream.incrementToken()
.- Specified by:
incrementToken
in classTokenStream
- Returns:
- false for end of stream; true otherwise
- Throws:
IOException
-
collapseAndSaveTokens
- Throws:
IOException
-
setupSavedToken
-
collapseTokens
- Throws:
IOException
-
setupToken
private void setupToken() -
close
Description copied from class:Tokenizer
Releases resources associated with this stream.If you override this method, always call
super.close()
, otherwise some internal state will not be correctly reset (e.g.,Tokenizer
will throwIllegalStateException
on reuse).NOTE: The default implementation closes the input Reader, so be sure to call
super.close()
when overriding this method.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classTokenizer
- Throws:
IOException
-
reset
Description copied from class:TokenStream
This method is called by a consumer before it begins consumption usingTokenStream.incrementToken()
.Resets this stream to a clean state. Stateful implementations must implement this method so that they can be reused, just as if they had been created fresh.
If you override this method, always call
super.reset()
, otherwise some internal state will not be correctly reset (e.g.,Tokenizer
will throwIllegalStateException
on further usage).- Overrides:
reset
in classTokenizer
- Throws:
IOException
-
end
Description copied from class:TokenStream
This method is called by the consumer after the last token has been consumed, afterTokenStream.incrementToken()
returnedfalse
(using the newTokenStream
API). Streams implementing the old API should upgrade to use this feature.This method can be used to perform any end-of-stream operations, such as setting the final offset of a stream. The final offset of a stream might differ from the offset of the last token eg in case one or more whitespaces followed after the last token, but a WhitespaceTokenizer was used.
Additionally any skipped positions (such as those removed by a stopfilter) can be applied to the position increment, or any adjustment of other attributes where the end-of-stream value may be important.
If you override this method, always call
super.end()
.- Overrides:
end
in classTokenStream
- Throws:
IOException
- If an I/O error occurs
-