Pulled some static methods into a CSVUtils class, switched CSVPrinter to use a CSVStrategy though it doesn't use it fully yet, added a COMMENTS_DISABLED constant instead of relying on (char) 0.

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/sandbox/csv/trunk@415323 13f79535-47bb-0310-9956-ffa450edef68

Author: hen

src/java/org/apache/commons/csv/CSVParser.java

@@ -90,53 +90,6 @@ class Token {
     }
   }
 
-  // ======================================================
-  //  static parsers
-  // ======================================================
-  
-  /**
-   * Parses the given String according to the default CSV strategy.
-   * 
-   * @param s CSV String to be parsed.
-   * @return parsed String matrix (which is never null)
-   * @throws IOException in case of error
-   * @see #setStrategy()
-   */
-  public static String[][] parse(String s) throws IOException {
-    if (s == null) {
-      throw new IllegalArgumentException("Null argument not allowed.");
-    }
-    String[][] result = (new CSVParser(new StringReader(s))).getAllValues();
-    if (result == null) {
-      // since CSVStrategy ignores empty lines an empty array is returned
-      // (i.e. not "result = new String[][] {{""}};")
-      result = new String[0][0];
-    }
-    return result;
-  }
-  
-  /**
-   * Parses the first line only according to the default CSV strategy.
-   * 
-   * Parsing empty string will be handled as valid records containing zero
-   * elements, so the following property holds: parseLine("").length == 0.
-   * 
-   * @param s CSV String to be parsed.
-   * @return parsed String vector (which is never null)
-   * @throws IOException in case of error
-   * @see #setStrategy()
-   */
-  public static String[] parseLine(String s) throws IOException {
-    if (s == null) {
-      throw new IllegalArgumentException("Null argument not allowed.");
-    }
-    // uh,jh: make sure that parseLine("").length == 0
-    if (s.length() == 0) {
-      return new String[0];
-    }
-    return (new CSVParser(new StringReader(s))).getLine();
-  }
-  
   // ======================================================
   //  the constructor
   // ======================================================
@@ -366,7 +319,7 @@ protected Token nextToken() throws IOException {
         eol = isEndOfLine(c);
       }
       // ok, start of token reached: comment, encapsulated, or token
-      if (c == strategy.getCommentStart()) {
+      if (!strategy.isCommentingDisabled() && c == strategy.getCommentStart()) {
         // ignore everything till end of line and continue (incr linecount)
         in.readLine();
         tkn = nextToken();
@@ -602,7 +555,7 @@ public CSVStrategy getStrategy() {
   // ======================================================
 
   /**
-   * @return true if the given char is a whitespache character
+   * @return true if the given char is a whitespace character
    */
   private boolean isWhitespace(int c) {
     return Character.isWhitespace((char) c);

src/java/org/apache/commons/csv/CSVPrinter.java

@@ -31,11 +31,7 @@ public class CSVPrinter {
   /** True if we just began a new line. */
   protected boolean newLine = true;
 
-  /** Character used to start comments. (Default is '#') */
-  protected char commentStart = '#';
-  
-  /** Character used to separate entities. (Default is ',') */
-  protected char separatorChar = ',';
+  private CSVStrategy strategy = CSVStrategy.DEFAULT_STRATEGY;
 
   /**
    * Create a printer that will print values to the given
@@ -66,67 +62,33 @@ public CSVPrinter(Writer out) {
   }
 
 
-  /**
-   * Create a printer that will print values to the given
-   * stream. Character to byte conversion is done using
-   * the default character encoding.
-   *
-   * @param out stream to which to print.
-   * @param commentStart Character used to start comments.
-   */
-  public CSVPrinter(OutputStream out, char commentStart) {
-    this(out);
-    this.commentStart = commentStart;
-  }
-
-
-  /**
-   * Create a printer that will print values to the given
-   * stream.
-   *
-   * @param out stream to which to print.
-   * @param commentStart Character used to start comments.
-   */
-  public CSVPrinter(Writer out, char commentStart) {
-    this(out);
-    this.commentStart = commentStart;
-  }
-
-  /**
-   * Gets the comment start character.
-   * 
-   * @return the commentStart character
-   */
-  public char getCommentStart() {
-    return commentStart;
-  }
+  // ======================================================
+  //  strategies
+  // ======================================================
 
   /**
-   * Sets the comment start character.
-   * 
-   * @param commentStart commentStart character to set.
+   * Sets the specified CSV Strategy
+   *
+   * @return current instance of CSVParser to allow chained method calls
    */
-  public void setCommentStart(char commentStart) {
-    this.commentStart = commentStart;
+  public CSVPrinter setStrategy(CSVStrategy strategy) {
+    this.strategy = strategy;
+    return this;
   }
 
   /**
-   * Gets the separator character.
-   * 
-   * @return Returns the separatorChar.
-   */
-  public char getSeparatorChar() {
-    return separatorChar;
-  }
-  /**
-   * Sets the separator character.
+   * Obtain the specified CSV Strategy
    * 
-   * @param separatorChar The separatorChar to set.
+   * @return strategy currently being used
    */
-  public void setSeparatorChar(char separatorChar) {
-    this.separatorChar = separatorChar;
+  public CSVStrategy getStrategy() {
+    return this.strategy;
   }
 
+  // ======================================================
+  //  printing implementation
+  // ======================================================
+
   /**
    * Print the string as the last value on the line. The value
    * will be quoted if needed.
@@ -197,10 +159,13 @@ public void println(String[][] values) {
    * @param comment the comment to output
    */
   public void printlnComment(String comment) {
+    if(this.strategy.isCommentingDisabled()) {
+        return;
+    }
     if (!newLine) {
       out.println();
     }
-    out.print(commentStart);
+    out.print(this.strategy.getCommentStart());
     out.print(' ');
     for (int i = 0; i < comment.length(); i++) {
       char c = comment.charAt(i);
@@ -212,7 +177,7 @@ public void printlnComment(String comment) {
           // break intentionally excluded.
         case '\n' :
           out.println();
-          out.print(commentStart);
+          out.print(this.strategy.getCommentStart());
           out.print(' ');
           break;
         default :
@@ -248,7 +213,7 @@ public void print(String value) {
       }
       for (int i = 0; i < value.length(); i++) {
         c = value.charAt(i);
-        if (c == '"' || c == separatorChar || c == '\n' || c == '\r') {
+        if (c == '"' || c == this.strategy.getDelimiter() || c == '\n' || c == '\r') {
           quote = true;
         }
       }
@@ -265,7 +230,7 @@ public void print(String value) {
     if (newLine) {
       newLine = false;
     } else {
-      out.print(separatorChar);
+      out.print(this.strategy.getDelimiter());
     }
     if (quote) {
       out.print(escapeAndQuote(value));
@@ -276,40 +241,6 @@ public void print(String value) {
   }
 
 
-  /**
-   * Converts an array of string values into a single CSV line. All
-   * <code>null</code> values are converted to the string <code>"null"</code>,
-   * all strings equal to <code>"null"</code> will additionally get quotes
-   * around.
-   *
-   * @param values the value array
-   * @return the CSV string, will be an empty string if the length of the
-   * value array is 0
-   */
-  public static String printLine(String[] values) {
-
-    // set up a CSVPrinter
-    StringWriter csvWriter = new StringWriter();
-    CSVPrinter csvPrinter = new CSVPrinter(csvWriter);
-
-    // check for null values an "null" as strings and convert them
-    // into the strings "null" and "\"null\""
-    for (int i = 0; i < values.length; i++) {
-      if (values[i] == null) {
-        values[i] = "null";
-      } else if (values[i].equals("null")) {
-        values[i] = "\"null\"";
-      }
-    }
-
-    // convert to CSV
-    csvPrinter.println(values);
-
-    // as the resulting string has \r\n at the end, we will trim that away
-    return csvWriter.toString().trim();
-  }
-
-
   /**
    * Enclose the value in quotes and escape the quote
    * and comma characters that are inside.

src/java/org/apache/commons/csv/CSVStrategy.java

@@ -29,8 +29,11 @@ public class CSVStrategy {
     private boolean interpretUnicodeEscapes;
     private boolean ignoreEmptyLines;
 
-    public static CSVStrategy DEFAULT_STRATEGY = new CSVStrategy(',', '"', (char) 0, true,  false, true);
-    public static CSVStrategy EXCEL_STRATEGY   = new CSVStrategy(';', '"', (char) 0, false, false, false);
+    public static char COMMENTS_DISABLED       = (char) 0;
+
+    public static CSVStrategy DEFAULT_STRATEGY = new CSVStrategy(',', '"', COMMENTS_DISABLED, true,  false, true);
+    public static CSVStrategy EXCEL_STRATEGY   = new CSVStrategy(';', '"', COMMENTS_DISABLED, false, false, false);
+    public static CSVStrategy TDF_STRATEGY     = new CSVStrategy('	', '"', COMMENTS_DISABLED, true,  false, true);
 
 
     public CSVStrategy(char delimiter, char encapsulator, char commentStart) {
@@ -74,6 +77,7 @@ public CSVStrategy(
 
     public void setCommentStart(char commentStart) { this.commentStart = commentStart; }
     public char getCommentStart() { return this.commentStart; }
+    public boolean isCommentingDisabled() { return this.commentStart == COMMENTS_DISABLED; }
 
     public void setIgnoreLeadingWhitespaces(boolean ignoreLeadingWhitespaces) { this.ignoreLeadingWhitespaces = ignoreLeadingWhitespaces; }
     public boolean getIgnoreLeadingWhitespaces() { return this.ignoreLeadingWhitespaces; }

src/java/org/apache/commons/csv/CSVUtils.java

@@ -0,0 +1,116 @@
+/*
+ * Copyright 2005 The Apache Software Foundation.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.csv;
+
+import java.io.StringWriter;
+import java.io.StringReader;
+import java.io.IOException;
+
+/**
+ * Utility methods for dealing with CSV files
+ */
+public class CSVUtils {
+
+    /**
+     * <p><code>CSVUtils</code> instances should NOT be constructed in
+     * standard programming. 
+     *
+     * <p>This constructor is public to permit tools that require a JavaBean
+     * instance to operate.</p>
+     */
+    public CSVUtils() {
+    }
+  
+    /**
+     * Converts an array of string values into a single CSV line. All
+     * <code>null</code> values are converted to the string <code>"null"</code>,
+     * all strings equal to <code>"null"</code> will additionally get quotes
+     * around.
+     *
+     * @param values the value array
+     * @return the CSV string, will be an empty string if the length of the
+     * value array is 0
+     */
+    public static String printLine(String[] values) {
+        // set up a CSVUtils
+        StringWriter stringWriter = new StringWriter();
+        CSVPrinter csvPrinter = new CSVPrinter(stringWriter);
+  
+        // check for null values an "null" as strings and convert them
+        // into the strings "null" and "\"null\""
+        for (int i = 0; i < values.length; i++) {
+            if (values[i] == null) {
+                values[i] = "null";
+            } else if (values[i].equals("null")) {
+                values[i] = "\"null\"";
+            }
+        }
+  
+        // convert to CSV
+        csvPrinter.println(values);
+  
+        // as the resulting string has \r\n at the end, we will trim that away
+        return stringWriter.toString().trim();
+    }
+  
+  // ======================================================
+  //  static parsers
+  // ======================================================
+  
+  /**
+   * Parses the given String according to the default CSV strategy.
+   * 
+   * @param s CSV String to be parsed.
+   * @return parsed String matrix (which is never null)
+   * @throws IOException in case of error
+   * @see #setStrategy()
+   */
+  public static String[][] parse(String s) throws IOException {
+    if (s == null) {
+      throw new IllegalArgumentException("Null argument not allowed.");
+    }
+    String[][] result = (new CSVParser(new StringReader(s))).getAllValues();
+    if (result == null) {
+      // since CSVStrategy ignores empty lines an empty array is returned
+      // (i.e. not "result = new String[][] {{""}};")
+      result = new String[0][0];
+    }
+    return result;
+  }
+  
+  /**
+   * Parses the first line only according to the default CSV strategy.
+   * 
+   * Parsing empty string will be handled as valid records containing zero
+   * elements, so the following property holds: parseLine("").length == 0.
+   * 
+   * @param s CSV String to be parsed.
+   * @return parsed String vector (which is never null)
+   * @throws IOException in case of error
+   * @see #setStrategy()
+   */
+  public static String[] parseLine(String s) throws IOException {
+    if (s == null) {
+      throw new IllegalArgumentException("Null argument not allowed.");
+    }
+    // uh,jh: make sure that parseLine("").length == 0
+    if (s.length() == 0) {
+      return new String[0];
+    }
+    return (new CSVParser(new StringReader(s))).getLine();
+  }
+  
+}