de.susebox.jtopas.impl

Class SequenceStore

java.lang.Object

de.susebox.jtopas.impl.SequenceStore

All Implemented Interfaces:

KeywordHandler, SequenceHandler

Direct Known Subclasses:

NoCaseSequenceStore

public class SequenceStore
extends java.lang.Object
implements SequenceHandler, KeywordHandler

This class is used by StandardTokenizerProperties to store and search special sequences, comments and strings as well as keywords. The class is not suitable for standalone use since it does not check parameters for null values, assumes a thread-safe context etc.

Author:

Heiko Blau

See Also:

StandardTokenizerProperties, SequenceHandler

Field Summary

Fields

Modifier and Type	Field and Description
static char	DIRECT_INDEX_COUNT This number is the size of the array that is directly indexed by letters

Constructor Summary

Constructors

Constructor and Description
SequenceStore(boolean useExactLength) The constructor initializes a SequenceStore with the given comparision policy (prefix comparison).

Method Summary

Modifier and Type	Method and Description
TokenizerProperty	addKeyword(TokenizerProperty property) Addingt or replacing a keyword.
TokenizerProperty	addSpecialSequence(TokenizerProperty property) Addingt or replacing a special sequence, comment or string.
TokenizerProperty	getKeyword(java.lang.String image) Get the full description of a keyword property.
java.util.Iterator	getKeywords() This method returns an Iterator of TokenizerProperty objects describing keywords.
int	getSequenceMaxLength() This method returns the length of the longest special sequence, comment or string prefix that is known to this SequenceStore.
TokenizerProperty	getSpecialSequence(java.lang.String image) Get the full description of a special sequence property.
java.util.Iterator	getSpecialSequences(int type) This method returns an Iterator of TokenizerProperty objects.
boolean	hasKeywords() This method returns true if there are any keywords registered in this instance.
boolean	hasSequenceCommentOrString() This method returns true if there are any special sequences, strings or comments registered in this instance.
TokenizerProperty	isKeyword(DataProvider dataProvider) This method checks if the given data form a keyword.
TokenizerProperty	removeKeyword(java.lang.String image) Removing a special sequence from the store.
TokenizerProperty	removeSpecialSequence(java.lang.String image) Removing a special sequence from the store.
TokenizerProperty	startsWithSequenceCommentOrString(DataProvider dataProvider) This method checks if a given range of data starts with a special sequence, a comment or a string.

Methods inherited from class java.lang.Object

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

Field Detail

DIRECT_INDEX_COUNT

public static char DIRECT_INDEX_COUNT

This number is the size of the array that is directly indexed by letters

Constructor Detail

SequenceStore

public SequenceStore(boolean useExactLength)

The constructor initializes a SequenceStore with the given comparision policy (prefix comparison).

Parameters:

useExactLength - if true search only for a property that has the length of DataProvider.getLength()

Method Detail

hasSequenceCommentOrString

public boolean hasSequenceCommentOrString()

This method returns true if there are any special sequences, strings or comments registered in this instance. See the SequenceHandler interface for details.

Specified by:

hasSequenceCommentOrString in interface SequenceHandler

Returns:

true if there are any special sequences, strings or comments available, false otherwise.

startsWithSequenceCommentOrString

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

This method checks if a given range of data starts with a special sequence, a comment or a string. See SequenceHandler for details.

Specified by:

startsWithSequenceCommentOrString in interface SequenceHandler

Parameters:

dataProvider - the source to get the data range from

Returns:

a TokenizerProperty if a special sequence, comment or string could be detected, null otherwise

Throws:

TokenizerException - generic exception

java.lang.NullPointerException - if no DataProvider is given

getSequenceMaxLength

public int getSequenceMaxLength()

This method returns the length of the longest special sequence, comment or string prefix that is known to this SequenceStore. See SequenceHandler for details.

Specified by:

getSequenceMaxLength in interface SequenceHandler

Returns:

the number of characters needed in the worst case to identify a special sequence

hasKeywords

public boolean hasKeywords()

This method returns true if there are any keywords registered in this instance. See the KeywordHandler interface for details.

Specified by:

hasKeywords in interface KeywordHandler

Returns:

true if there are any keywords available, false otherwise.

isKeyword

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

This method checks if the given data form a keyword. See KeywordHandler for details.

Specified by:

isKeyword in interface KeywordHandler

Parameters:

dataProvider - the source to get the data range from

Returns:

a TokenizerProperty if keyword has been found, null otherwise

Throws:

TokenizerException - generic exception

java.lang.NullPointerException - if no DataProvider is given

addSpecialSequence

public TokenizerProperty addSpecialSequence(TokenizerProperty property)

Addingt or replacing a special sequence, comment or string.

Parameters:

property - the description of the new sequence

Returns:

the previously version of the given property or null

removeSpecialSequence

public TokenizerProperty removeSpecialSequence(java.lang.String image)

Removing a special sequence from the store. If the special sequence denoted by the given string does not exist the method returns null.

Parameters:

image - sequence to remove

Returns:

the removed property or null if the sequence was not found

getSpecialSequence

public TokenizerProperty getSpecialSequence(java.lang.String image)

Get the full description of a special sequence property.

Parameters:

image - sequence to find

Returns:

the full sequence description or null

getSpecialSequences

public java.util.Iterator getSpecialSequences(int type)

This method returns an Iterator of TokenizerProperty objects.

Parameters:

type - type of special sequence like Token.STRING

Returns:

enumeration of TokenizerProperty objects

addKeyword

public TokenizerProperty addKeyword(TokenizerProperty property)

Addingt or replacing a keyword.

Parameters:

property - the description of the new keyword

Returns:

the previously version of the given property or null

removeKeyword

public TokenizerProperty removeKeyword(java.lang.String image)

Removing a special sequence from the store. If the special sequence denoted by the given string does not exist the method returns null.

Parameters:

image - sequence to remove

Returns:

the removed property or null if the sequence was not found

getKeyword

public TokenizerProperty getKeyword(java.lang.String image)

Get the full description of a keyword property.

Parameters:

image - keyword candidate to look for

Returns:

the full keyword description or null

getKeywords

public java.util.Iterator getKeywords()

This method returns an Iterator of TokenizerProperty objects describing keywords.

Returns:

enumeration of TokenizerProperty objects representing keywords