de.susebox.jtopas.spi

Interface KeywordHandler

All Known Subinterfaces:

DataMapper

All Known Implementing Classes:

NoCaseSequenceStore, SequenceStore, StandardKeywordHandler, StandardTokenizerProperties

public interface KeywordHandler

This interface must be implemented by classes that should be used as a keyword handler for a Tokenizer.

Author:

Heiko Blau

See Also:

Tokenizer, TokenizerProperties, DataMapper

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.

Method Detail

hasKeywords

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.

Returns:

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

isKeyword

TokenizerProperty isKeyword(DataProvider dataProvider)
                     throws TokenizerException,
                            java.lang.NullPointerException

This method checks if the character range given through the DataProvider comprises a keyword. An implementation should use a TokenizerException to report problems.

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 - generic exception

java.lang.NullPointerException - if no DataProvider is given