Save This Page
Home » pentaho-reporting-engine-classic-0.8.10 » org » jfree » report » util » [javadoc | source]
org.jfree.report.util
public class: CSVTokenizer [javadoc | source]
java.lang.Object
   org.jfree.report.util.CSVTokenizer

All Implemented Interfaces:
    Enumeration

Deprecated! This - class moved into LibBase. This class here will be removed in 0.8.11.

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:

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
public static final  String SEPARATOR_COMMA    A possible separator constant. 
public static final  String SEPARATOR_TAB    A possible separator constant. 
public static final  String SEPARATOR_SPACE    A possible separator constant. 
public static final  String DOUBLE_QUATE    A possible quote character constant. 
public static final  String SINGLE_QUATE    A possible quote character constant. 
Constructor:
 public CSVTokenizer(String aString) 
    Constructs a string tokenizer for the specified string. The tokenizer uses the default separator set, which is CSVTokenizer.SEPARATOR_COMMA. Separator string themselves will not be treated as tokens.
    Parameters:
    aString - a string to be parsed.
 public CSVTokenizer(String aString,
    String theSeparator) 
    Constructs a csv tokenizer for the specified string. The characters in the theSeparator argument are the separator for separating tokens. Separator string themselves will not be treated as tokens.
    Parameters:
    aString - a string to be parsed.
    theSeparator - the separator (CSVTokenizer.SEPARATOR_COMMA, CSVTokenizer.TAB, CSVTokenizer.SPACE, etc.).
 public CSVTokenizer(String aString,
    String theSeparator,
    String theQuate) 
    Constructs a csv tokenizer for the specified string. 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.

    Parameters:
    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.).
Method from org.jfree.report.util.CSVTokenizer Summary:
countTokens,   getQuate,   hasMoreElements,   hasMoreTokens,   nextElement,   nextToken,   nextToken,   setQuate
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.jfree.report.util.CSVTokenizer Detail:
 public int countTokens() 
      Deprecated!
    Calculates the number of times that this tokenizer's nextToken method can be called before it generates an exception. The current position is not advanced.
 public String getQuate() 
      Deprecated!
    Returns the quate.
 public boolean hasMoreElements() 
      Deprecated!
    Returns the same value as the hasMoreTokens method. It exists so that this class can implement the Enumeration interface.
 public boolean hasMoreTokens() 
      Deprecated!
    Tests if there are more tokens available from this tokenizer's string. If this method returns true, then a subsequent call to nextToken with no argument will successfully return a token.
 public Object nextElement() 
      Deprecated!
    Returns the same value as the nextToken method, except that its declared return value is Object rather than String. It exists so that this class can implement the Enumeration interface.
 public String nextToken() throws IllegalArgumentException, NoSuchElementException 
      Deprecated!
    Returns the next token from this string tokenizer.
 public String nextToken(String theSeparator) 
      Deprecated!
    Returns the next token in this string tokenizer's string. First, the set of characters considered to be separator by this CSVTokenizer object is changed to be the characters in the string separator. Then the next token in the string after the current position is returned. The current position is advanced beyond the recognized token. The new delimiter set remains the default after this call.
 public  void setQuate(String quate) 
      Deprecated!
    Sets the quate.