com.f1j.data.handler
Class DelimitedText

java.lang.Object
  |
  +--com.actuate.util.Debug
        |
        +--com.f1j.util.Debug
              |
              +--com.f1j.util.ObjConst
                    |
                    +--com.f1j.util.Obj
                          |
                          +--com.f1j.data.handler.Handler
                                |
                                +--com.f1j.data.handler.Text
                                      |
                                      +--com.f1j.data.handler.DelimitedText

public class DelimitedText

extends Text

This data type handler is used to process text delimited by a specified character. Row delimiters are fixed to be CR, LF, or CRLF (one row per line), while column delimiters may be set with the setDelimiters() method.

Fields inherited from class com.f1j.data.handler.Text

kGeneral, kNumber, kSkip, kText

Fields inherited from class com.f1j.data.handler.Handler

kDelimitedText, kInvalid, kJDBCResultSet, kPositionalText, kXML

Method Summary

char	getDelimiter() Deprecated. As of version 9.0. Use getDelimiters() instead.
java.lang.String	getDelimiters() Returns a string containing the current delimiter(s) used when transferring data from a data source.
char	getTextQualifier() Returns the current text qualifier character.
boolean	isTreatConsecutiveDelimitersAsOne() Returns how two or more successive delimiter characters are interpreted to create worksheet columns.
void	setDelimiter(char delimiter) Deprecated. As of version 9.0. Use setDelimiters(String delimiters) instead.
void	setDelimiters(java.lang.String delimiters) Sets a string containing a list of all delimiter characters for columns.
void	setTextQualifier(char ch) The text qualifier character is used to escape delimiters that you would like treated as text.
void	setTreatConsecutiveDelimitersAsOne(boolean b) Sets how two or more successive delimiter characters are interpreted to create worksheet columns.

Methods inherited from class com.f1j.data.handler.Text

getColumnDataFormat, getColumnDataFormats, getColumnName, getColumnNames, getLineLimit, getStartRow, setColumnDataFormat, setColumnName, setLineLimit, setStartRow

Methods inherited from class com.f1j.data.handler.Handler

getCodePage, setCodePage

Method Detail

getDelimiter

public char getDelimiter()

Deprecated. As of version 9.0. Use getDelimiters() instead.

Returns the current delimiter being used.

Returns:

the character currently set as the delimiter used when transferring data from a data source.

See Also:

setDelimiter(char), setDelimiters(java.lang.String)

getDelimiters

public java.lang.String getDelimiters()

Returns a string containing the current delimiter(s) used when transferring data from a data source.

Returns:

the character(s) currently set as the delimiter(s) used.

See Also:

setDelimiter(char), setDelimiters(java.lang.String)

getTextQualifier

public char getTextQualifier()

Returns the current text qualifier character. The text qualifier is used to escape delimiters that you would like treated as text. By default the text qualifier is set to None or '\0'.

Returns:

the current text qualifier character.

See Also:

setTextQualifier(char)

isTreatConsecutiveDelimitersAsOne

public boolean isTreatConsecutiveDelimitersAsOne()

Returns how two or more successive delimiter characters are interpreted to create worksheet columns. If this method is called with true, two or more consecutive delimiters are treated as a single delimiter (creating one column). This method is used most often to prevent two spaces in a row from being treated as two fields when a space is used as the delimiter character. The default is true.

Returns:

boolean true/false. true = consecutive delimiters are treated as one delimiter (creates one column).

See Also:

setTreatConsecutiveDelimitersAsOne(boolean)

setDelimiter

public void setDelimiter(char delimiter)

Deprecated. As of version 9.0. Use setDelimiters(String delimiters) instead.

Sets the delimiter to use.

Parameters:

delimiter - a character used as the delimiter when transferring data from a data source.

See Also:

getDelimiters(), setDelimiters(java.lang.String)

setDelimiters

public void setDelimiters(java.lang.String delimiters)

Sets a string containing a list of all delimiter characters for columns. If more than one character is set, then any single character in the set may be used as a delimiter. For instance, if the delimiter string is ",;" then either the ',' or ';' character will be recognized as a valid delimiter.

Parameters:

delimiters - a string containing delimiter(s) used when transferring data from a data source.

See Also:

getDelimiters(), setDelimiter(char)

setTreatConsecutiveDelimitersAsOne

public void setTreatConsecutiveDelimitersAsOne(boolean b)

Sets how two or more successive delimiter characters are interpreted to create worksheet columns. Call this method with true to treat two or more consecutive delimiters as a single delimiter (creating one column). This method is used most often to prevent two spaces in a row from being treated as two fields when a space is used as the delimiter character. Defaults to true.

Parameters:

b - boolean true/false. true = treat consecutive delimiters as one delimiter.

See Also:

isTreatConsecutiveDelimitersAsOne()

setTextQualifier

public void setTextQualifier(char ch)

The text qualifier character is used to escape delimiters that you would like treated as text. By default the text qualifier is set to None or '\0'.

Parameters:

ch - the qualifier character.

See Also:

getTextQualifier()