From 8436388f18a493f54605acb5129498f8a8a4aa8e Mon Sep 17 00:00:00 2001
From: Tim Molter <tim.molter@gmail.com>
Date: Thu, 9 May 2013 20:50:02 +0200
Subject: [PATCH] JavaDocs
---
.../main/java/com/xeiam/xchart/CSVExporter.java | 17 +++++++++++++++++
.../main/java/com/xeiam/xchart/CSVImporter.java | 14 ++++++++++++++
2 files changed, 31 insertions(+)
diff --git a/xchart/src/main/java/com/xeiam/xchart/CSVExporter.java b/xchart/src/main/java/com/xeiam/xchart/CSVExporter.java
index 3a77bf19..54632222 100644
--- a/xchart/src/main/java/com/xeiam/xchart/CSVExporter.java
+++ b/xchart/src/main/java/com/xeiam/xchart/CSVExporter.java
@@ -22,6 +22,12 @@ import java.util.Iterator;
*/
public class CSVExporter {
+ /**
+ * Write a Chart series as rows in a CSV file.
+ *
+ * @param series
+ * @param path2Dir - ex. "./path/to/directory/" *make sure you have the '/' on the end
+ */
public static void writeCSVRows(Series series, String path2Dir) {
File newFile = new File(path2Dir + series.getName() + ".csv");
@@ -48,6 +54,12 @@ public class CSVExporter {
}
}
+ /**
+ * Write a Chart series as columns in a CSV file.
+ *
+ * @param series
+ * @param path2Dir - ex. "./path/to/directory/" *make sure you have the '/' on the end
+ */
public static void writeCSVColumns(Series series, String path2Dir) {
File newFile = new File(path2Dir + series.getName() + ".csv");
@@ -81,6 +93,11 @@ public class CSVExporter {
}
+ /**
+ * @param collection
+ * @param separator
+ * @return
+ */
private static String join(Collection<? extends Object> collection, String separator) {
if (collection == null) {
diff --git a/xchart/src/main/java/com/xeiam/xchart/CSVImporter.java b/xchart/src/main/java/com/xeiam/xchart/CSVImporter.java
index 9c02ad6a..cdd401ba 100644
--- a/xchart/src/main/java/com/xeiam/xchart/CSVImporter.java
+++ b/xchart/src/main/java/com/xeiam/xchart/CSVImporter.java
@@ -92,6 +92,12 @@ public class CSVImporter {
return getChartFromCSVDir(path2Directory, dataOrientation, width, height, null);
}
+ /**
+ * Get the series's data from a file
+ *
+ * @param csvFile
+ * @return
+ */
private static String[] getSeriesDataFromCSVRows(File csvFile) {
String[] xAndYData = new String[2];
@@ -119,6 +125,10 @@ public class CSVImporter {
return xAndYData;
}
+ /**
+ * @param csvFile
+ * @return
+ */
private static String[] getSeriesDataFromCSVColumns(File csvFile) {
String[] xAndYData = new String[2];
@@ -149,6 +159,10 @@ public class CSVImporter {
return xAndYData;
}
+ /**
+ * @param stringData
+ * @return
+ */
private static List<Number> getAxisData(String stringData) {
List<Number> axisData = new ArrayList<Number>();
--
GitLab