de.susebox.jtopas.spi

Class StandardKeywordHandler

java.lang.Object

de.susebox.jtopas.spi.StandardKeywordHandler

All Implemented Interfaces:

KeywordHandler

public class StandardKeywordHandler
extends java.lang.Object
implements KeywordHandler

Simple implementation of the KeywordHandler interface. This class works only with the TokenizerProperties interface methods and is aware of changes in these properties. It does not cache any information and is therefore a more or less slow way to handle keywords.

This class is a bridge between arbitrary Tokenizer implementations using the SPI interface KeywordHandler and any TokenizerProperties implementation that does not implement the KeywordHandler interface itself.

Author:

Heiko Blau

See Also:

KeywordHandler, Tokenizer, TokenizerProperties

Constructor Summary

Constructors

Constructor and Description
StandardKeywordHandler(TokenizerProperties props) The constructor takes the TokenizerProperties that provide the keywords.

Method Summary

Modifier and Type	Method and Description
boolean	hasKeywords() This method can be used by a Tokenizer implementation for a fast detection if keyword matching must be performed at all.
TokenizerProperty	isKeyword(DataProvider dataProvider) This method checks if the character range given through the DataProvider comprises a keyword.

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardKeywordHandler

public StandardKeywordHandler(TokenizerProperties props)

The constructor takes the TokenizerProperties that provide the keywords.

Parameters:

props - the TokenizerProperties to take the keywords from

Method Detail

hasKeywords

public boolean hasKeywords()

This method can be used by a Tokenizer implementation for a fast detection if keyword matching must be performed at all. If the method returns false time-consuming preparations can be skipped.

Specified by:

hasKeywords in interface KeywordHandler

Returns:

true if there actually are pattern that can be tested for a match, false otherwise.

isKeyword

public TokenizerProperty isKeyword(DataProvider dataProvider)
                            throws java.lang.NullPointerException

This method checks if the character range given through the DataProvider comprises a keyword.

Specified by:

isKeyword in interface KeywordHandler

Parameters:

dataProvider - the source to get the data from, that are checked

Returns:

a TokenizerProperty if a keyword could be found, null otherwise

Throws:

TokenizerException - failure while reading more data

java.lang.NullPointerException - if no DataProvider is given