|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jfree.report.util.CSVTokenizer
The csv tokenizer class allows an application to break a
Comma Separated Value format into tokens.
The tokenization method is much simpler than
the one used by the StringTokenizer
class. The
CSVTokenizer
methods do not distinguish among
identifiers, numbers, and quoted strings, nor do they recognize
and skip comments.
The set of separator (the characters that separate tokens) may be specified either at creation time or on a per-token basis.
An instance of CSVTokenizer
behaves in one of two
ways, depending on whether it was created with the
returnSeparators
flag having the value true
or false
:
false
, delimiter characters serve to
separate tokens. A token is a maximal sequence of consecutive
characters that are not separator.
true
, delimiter characters are themselves
considered to be tokens. A token is thus either one delimiter
character, or a maximal sequence of consecutive characters that are
not separator.
A CSVTokenizer object internally maintains a current position within the string to be tokenized. Some operations advance this current position past the characters processed.
A token is returned by taking a substring of the string that was used to create the CSVTokenizer object.
The following is one example of the use of the tokenizer. The code:
CSVTokenizer csvt = new CSVTokenizer("this,is,a,test"); while (csvt.hasMoreTokens()) { println(csvt.nextToken()); }
prints the following output:
this is a test
Field Summary | |
static java.lang.String |
DOUBLE_QUATE
A possible quote character constant. |
static java.lang.String |
SEPARATOR_COMMA
A possible separator constant. |
static java.lang.String |
SEPARATOR_SPACE
A possible separator constant. |
static java.lang.String |
SEPARATOR_TAB
A possible separator constant. |
static java.lang.String |
SINGLE_QUATE
A possible quote character constant. |
Constructor Summary | |
CSVTokenizer(java.lang.String aString)
Constructs a string tokenizer for the specified string. |
|
CSVTokenizer(java.lang.String aString,
java.lang.String theSeparator)
Constructs a csv tokenizer for the specified string. |
|
CSVTokenizer(java.lang.String aString,
java.lang.String theSeparator,
java.lang.String theQuate)
Constructs a csv tokenizer for the specified string. |
Method Summary | |
int |
countTokens()
Calculates the number of times that this tokenizer's nextToken method can be called before it generates an
exception. |
java.lang.String |
getQuate()
Returns the quate. |
boolean |
hasMoreElements()
Returns the same value as the hasMoreTokens
method. |
boolean |
hasMoreTokens()
Tests if there are more tokens available from this tokenizer's string. |
java.lang.Object |
nextElement()
Returns the same value as the nextToken method,
except that its declared return value is Object rather than
String . |
java.lang.String |
nextToken()
Returns the next token from this string tokenizer. |
java.lang.String |
nextToken(java.lang.String theSeparator)
Returns the next token in this string tokenizer's string. |
void |
setQuate(java.lang.String quate)
Sets the quate. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String SEPARATOR_COMMA
public static final java.lang.String SEPARATOR_TAB
public static final java.lang.String SEPARATOR_SPACE
public static final java.lang.String DOUBLE_QUATE
public static final java.lang.String SINGLE_QUATE
Constructor Detail |
public CSVTokenizer(java.lang.String aString, java.lang.String theSeparator, java.lang.String theQuate)
theSeparator
argument is the separator
for separating tokens.
If the returnSeparators
flag is true
,
then the separator string is also returned as tokens.
separator is returned as a string. If the flag is
false
, the separator string is skipped and only
serve as separator between tokens.
aString
- a string to be parsed.theSeparator
- the separator
(CSVTokenizer.SEPARATOR_COMMA, CSVTokenizer.TAB, CSVTokenizer.SPACE, etc.).theQuate
- the quate
(CSVTokenizer.SINGLE_QUATE, CSVTokenizer.DOUBLE_QUATE, etc.).public CSVTokenizer(java.lang.String aString, java.lang.String theSeparator)
theSeparator
argument are
the separator for separating tokens.
Separator string themselves will not be treated as tokens.
aString
- a string to be parsed.theSeparator
- the separator
(CSVTokenizer.SEPARATOR_COMMA, CSVTokenizer.TAB, CSVTokenizer.SPACE, etc.).public CSVTokenizer(java.lang.String aString)
CSVTokenizer.SEPARATOR_COMMA
.
Separator string themselves will not be treated as tokens.
aString
- a string to be parsed.Method Detail |
public boolean hasMoreTokens()
true
if and only if there is at least one token
in the string after the current position; false
otherwise.public java.lang.String nextToken() throws java.util.NoSuchElementException, java.lang.IllegalArgumentException
java.util.NoSuchElementException
- if there are no more tokens in this
tokenizer's string.
java.lang.IllegalArgumentException
- if given parameter string format was wrongpublic java.lang.String nextToken(java.lang.String theSeparator)
theSeparator
- the new separator.
java.util.NoSuchElementException
- if there are no more tokens in this
tokenizer's string.public boolean hasMoreElements()
hasMoreTokens
method. It exists so that this class can implement the
Enumeration
interface.
hasMoreElements
in interface java.util.Enumeration
true
if there are more tokens;
false
otherwise.Enumeration
,
hasMoreTokens()
public java.lang.Object nextElement()
nextToken
method,
except that its declared return value is Object
rather than
String
. It exists so that this class can implement the
Enumeration
interface.
nextElement
in interface java.util.Enumeration
java.util.NoSuchElementException
- if there are no more tokens in this
tokenizer's string.Enumeration
,
nextToken()
public int countTokens()
nextToken
method can be called before it generates an
exception. The current position is not advanced.
nextToken()
public java.lang.String getQuate()
public void setQuate(java.lang.String quate)
quate
- The quate to set
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |