com.dkfqs.tools.text

Class InputFileLineTokenValueExtractor

java.lang.Object

com.dkfqs.tools.text.InputFileLineTokenValueExtractor

public class InputFileLineTokenValueExtractor
extends java.lang.Object

Read a file line by line and split the line into tokens. Features:

• Inline comments are supported.
• Empty lines are skipped.
• The tokens can be trimmed and double quotes can be removed from the tokens.
• The order of the lines can be randomized.
• Support of cyclic read (start reading again at end of file - endless new lines).

The file is fully read into memory for performance reasons.
If 'cyclic read' in combination with 'randomizing the order of lines' is enabled, then the order of lines is each time again newly randomized when the end of file is reached.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_COMMENT_TAG The default comment tag = "#".
static java.lang.String	DEFAULT_TOKEN_DELIMITER The default line token delimiter = "," (comma).

Constructor Summary

Constructors

Constructor and Description
InputFileLineTokenValueExtractor(java.io.File f) Create a new instance.

Method Summary

Modifier and Type	Method and Description
void	dumpLines() For debug purpose only, dump all lines to stdout.
java.lang.String[]	getNextLineTokens() Get the next line and split it into tokens - This method is thread safe.
void	readFile() Read the file into memory.
void	setCharset(java.nio.charset.Charset charset) Set the charset (default = UTF-8).
void	setCommentTag(java.lang.String commentTag) Set the comment tag.
void	setCyclicRead(boolean cyclicRead) Set if cyclic read is enabled (default = false).
void	setRandomizeLines(boolean randomizeLines) Set if randomizing the order of lines is enabled (default = false).
void	setRemoveDoubleQuotes(boolean removeDoubleQuotes) Set if double quotes are removed from the start and from the end of the tokens (default = false).
void	setTokenDelimiter(java.lang.String tokenDelimiter) Set the token delimiter
void	setTrimExtractedValues(boolean trimExtractedValues) Set if the value of the tokens are trimmed (default = false).

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_COMMENT_TAG

public static final java.lang.String DEFAULT_COMMENT_TAG

The default comment tag = "#".

See Also:

setCommentTag(String), Constant Field Values

DEFAULT_TOKEN_DELIMITER

public static final java.lang.String DEFAULT_TOKEN_DELIMITER

The default line token delimiter = "," (comma).

See Also:

setTokenDelimiter(String), Constant Field Values

Constructor Detail

InputFileLineTokenValueExtractor

public InputFileLineTokenValueExtractor(java.io.File f)
                                 throws java.io.IOException

Create a new instance.

Parameters:

f - the file to read

Throws:

java.io.IOException - if the file not exists or if the file is a directory

Method Detail

setCharset

public void setCharset(java.nio.charset.Charset charset)

Set the charset (default = UTF-8). This method only takes effect when called before readFile().

Parameters:

charset - the charset

setCommentTag

public void setCommentTag(java.lang.String commentTag)

Set the comment tag. This method only takes effect when called before readFile().

Parameters:

commentTag - the comment tag

See Also:

DEFAULT_COMMENT_TAG

setTokenDelimiter

public void setTokenDelimiter(java.lang.String tokenDelimiter)

Set the token delimiter

Parameters:

tokenDelimiter - the token delimiter

See Also:

DEFAULT_TOKEN_DELIMITER

setCyclicRead

public void setCyclicRead(boolean cyclicRead)

Set if cyclic read is enabled (default = false). This method only takes effect when called before readFile().

Parameters:

cyclicRead - true = cyclic read is enabled

setRandomizeLines

public void setRandomizeLines(boolean randomizeLines)

Set if randomizing the order of lines is enabled (default = false). This method only takes effect when called before readFile().

Parameters:

randomizeLines - true = randomizing the order of lines is enabled

setTrimExtractedValues

public void setTrimExtractedValues(boolean trimExtractedValues)

Set if the value of the tokens are trimmed (default = false).

Parameters:

trimExtractedValues - true = the value of the tokens are trimmed

setRemoveDoubleQuotes

public void setRemoveDoubleQuotes(boolean removeDoubleQuotes)

Set if double quotes are removed from the start and from the end of the tokens (default = false). Note: The double quotes are removed after the token was (eventually) trimmed.

Parameters:

removeDoubleQuotes - true = double quotes are removed from the start and the end of the tokens

readFile

public void readFile()
              throws java.io.IOException

Read the file into memory.

Throws:

java.io.IOException - if reading of the file fails

getNextLineTokens

public java.lang.String[] getNextLineTokens()

Get the next line and split it into tokens - This method is thread safe.

Returns:

the tokens of the line, or null if ('cyclic read' is disabled AND 'end of file' is reached)

dumpLines

public void dumpLines()

For debug purpose only, dump all lines to stdout. Comments and empty lines are removed.