de.susebox.jtopas.spi

Interface DataMapper

All Superinterfaces:

KeywordHandler, PatternHandler, SeparatorHandler, SequenceHandler, WhitespaceHandler

All Known Implementing Classes:

StandardTokenizerProperties

public interface DataMapper
extends WhitespaceHandler, SeparatorHandler, KeywordHandler, SequenceHandler, PatternHandler

This interface declares the methods that a Tokenizer will call to detect the image and type of a token. Usually, an implementation of the TokenizerProperties interface should also implement the DataMapper interface, but this is not mandatory.

If a TokenizerProperties instance given to a Tokenizer does not implement the DataMapper interface, then the Tokenizer will contruct a default DataMapper for its properties.

This interface extends the SPI interfaces specialized in handling various token types.

Author:

Heiko Blau

See Also:

Tokenizer, TokenizerProperties

Nested Class Summary

Nested classes/interfaces inherited from interface de.susebox.jtopas.spi.PatternHandler

PatternHandler.Result

Method Summary

Modifier and Type	Method and Description
TokenizerProperties	getTokenizerProperties() The method retrieves the backing TokenizerProperties instance, this DataMapper is working on.
void	setTokenizerProperties(TokenizerProperties props) Setting the backing TokenizerProperties instance this DataMapper is working with.

Methods inherited from interface de.susebox.jtopas.spi.WhitespaceHandler

countLeadingWhitespaces, isWhitespace, newlineIsWhitespace

Methods inherited from interface de.susebox.jtopas.spi.SeparatorHandler

isSeparator

Methods inherited from interface de.susebox.jtopas.spi.KeywordHandler

hasKeywords, isKeyword

Methods inherited from interface de.susebox.jtopas.spi.SequenceHandler

getSequenceMaxLength, hasSequenceCommentOrString, startsWithSequenceCommentOrString

Methods inherited from interface de.susebox.jtopas.spi.PatternHandler

hasPattern, matches

Method Detail

setTokenizerProperties

void setTokenizerProperties(TokenizerProperties props)
                     throws java.lang.UnsupportedOperationException,
                            java.lang.NullPointerException

Setting the backing TokenizerProperties instance this DataMapper is working with. Usually, the DataMapper interface is implemented by TokenizerProperties implementations, too. Otherwise the Tokenizer using the TokenizerProperties, will construct a default DataMapper an propagate the TokenizerProperties instance by calling this method.
The method should throw an UnsupportedOperationException if this DataMapper is an extension to an TokenizerProperties implementation.

Parameters:

props - the TokenizerProperties

Throws:

java.lang.UnsupportedOperationException - is this is a DataMapper implemented by a TokenizerProperties implementation

java.lang.NullPointerException - if no TokenizerProperties are given

getTokenizerProperties

TokenizerProperties getTokenizerProperties()

The method retrieves the backing TokenizerProperties instance, this DataMapper is working on. For implementations of the TokenizerProperties interface that also implement the DataMapper interface, this method returns the instance itself.
Otherwise the method returns the TokenizerProperties instance passed through the last call to setTokenizerProperties(de.susebox.jtopas.TokenizerProperties) or null if no such call has taken place so far.

Returns:

the backing TokenizerProperties or null