org.knime.core.util.tokenizer
Class Delimiter

java.lang.Object
  org.knime.core.util.tokenizer.Delimiter

public class Delimiter
extends Object

Created for each delimiter for the FileTokenizer keeping its specifics.

Author:

Peter Ohl, University of Konstanz

Constructor Summary

Delimiter(NodeSettingsRO settings)
Creates a new Delimiter object and sets its parameters from the config object.

Delimiter(String pattern, boolean combineConsecutive, boolean returnAsSeparateToken, boolean includeInToken)
Creates a new delimiter object.

Method Summary

boolean	combineConsecutiveDelims()
boolean	equals(Object obj)
String	getDelimiter()
char	getFirstChar()
int	hashCode()
boolean	includeInToken()
boolean	returnAsToken()
(package private) void	saveToConfig(NodeSettingsWO cfg) Writes the object into a NodeSettings object.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Delimiter

public Delimiter(String pattern,
                 boolean combineConsecutive,
                 boolean returnAsSeparateToken,
                 boolean includeInToken)

Creates a new delimiter object. Only constructed by the FileTokenizerSettings class.

Parameters:

pattern - the delimiter patter

combineConsecutive - boolean flag

returnAsSeparateToken - boolean flag

includeInToken - boolean flag

See Also:

TokenizerSettings

Delimiter

Delimiter(NodeSettingsRO settings)
    throws InvalidSettingsException

Creates a new Delimiter object and sets its parameters from the config object. If config doesn't contain all necessary parameters or contains inconsistent settings it will throw an IllegalArguments exception

Parameters:

settings - an object the parameters are read from.

Throws:

InvalidSettingsException - if the config is invalid. Right?

Method Detail

saveToConfig

void saveToConfig(NodeSettingsWO cfg)

Writes the object into a NodeSettings object. If this config object is then used to construct a new Delimiter this and the new object should be identical.

Parameters:

cfg - a config object the internal values of this object will be stored into.

getDelimiter

public String getDelimiter()

Returns:

The delimiter pattern.

combineConsecutiveDelims

public boolean combineConsecutiveDelims()

Returns:

true if consecutive appearances of this delimiter should be combined.

returnAsToken

public boolean returnAsToken()

Returns:

true if this delimiter should be returned as separate token.

includeInToken

public boolean includeInToken()

Returns:

true if this delimiter should be included in the prev. token.

getFirstChar

public char getFirstChar()

Returns:

The first character of this delimiter pattern.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object