From b7abfe844707f1d45a26f3ea86aeaa7d8201b42e Mon Sep 17 00:00:00 2001 From: Scott Murray Date: Sun, 26 May 2013 15:26:35 -0700 Subject: [PATCH] Added reference for TableRow plus methods getInt(), getFloat(), getString(), setInt(), setFloat(), setString() --- core/src/processing/data/TableRow.java | 75 +++++++++++++++++++++++--- 1 file changed, 69 insertions(+), 6 deletions(-) diff --git a/core/src/processing/data/TableRow.java b/core/src/processing/data/TableRow.java index d5b65cee3..949af30f6 100644 --- a/core/src/processing/data/TableRow.java +++ b/core/src/processing/data/TableRow.java @@ -2,21 +2,45 @@ package processing.data; /** * @webref data:composite + * @see Table + * @see Table#addRow() + * @see Table#removeRow(int) + * @see Table#clearRows() + * @see Table#getRow(int) + * @see Table#rows() */ public interface TableRow { /** * @webref tablerow:method - * @brief Get the String value from a column + * @brief Get an String value from the specified column + * @param column ID number of the column to reference + * @see TableRow#getInt(int) + * @see TableRow#getFloat(int) + * @see Table#getInt(int, int) + * @see Table#getFloat(int, int) + * @see Table#getString(int, int) */ public String getString(int column); + /** + * @param columnName title of the column to reference + */ public String getString(String columnName); /** * @webref tablerow:method - * @brief Get the int value from a column + * @brief Get an integer value from the specified column + * @param column ID number of the column to reference + * @see TableRow#getFloat(int) + * @see TableRow#getString(int) + * @see Table#getInt(int, int) + * @see Table#getFloat(int, int) + * @see Table#getString(int, int) */ public int getInt(int column); + /** + * @param columnName title of the column to reference + */ public int getInt(String columnName); public long getLong(int column); @@ -24,9 +48,18 @@ public interface TableRow { /** * @webref tablerow:method - * @brief Get the float value from a column + * @brief Get a float value from the specified column + * @param column ID number of the column to reference + * @see TableRow#getInt(int) + * @see TableRow#getString(int) + * @see Table#getInt(int, int) + * @see Table#getFloat(int, int) + * @see Table#getString(int, int) */ public float getFloat(int column); + /** + * @param columnName title of the column to reference + */ public float getFloat(String columnName); public double getDouble(int column); @@ -34,16 +67,36 @@ public interface TableRow { /** * @webref tablerow:method - * @brief Set the String value in a column + * @brief Store a String value in the specified column + * @param column ID number of the target column + * @param value value to assign + * @see TableRow#setInt(int, int) + * @see TableRow#setFloat(int, float) + * @see Table#setInt(int, int, int) + * @see Table#setFloat(int, int, float) + * @see Table#setString(int, int, String) */ public void setString(int column, String value); + /** + * @param columnName title of the target column + */ public void setString(String columnName, String value); /** * @webref tablerow:method - * @brief Set the int value in a column + * @brief Store an integer value in the specified column + * @param column ID number of the target column + * @param value value to assign + * @see TableRow#setFloat(int, float) + * @see TableRow#setString(int, String) + * @see Table#setInt(int, int, int) + * @see Table#setFloat(int, int, float) + * @see Table#setString(int, int, String) */ public void setInt(int column, int value); + /** + * @param columnName title of the target column + */ public void setInt(String columnName, int value); public void setLong(int column, long value); @@ -51,9 +104,19 @@ public interface TableRow { /** * @webref tablerow:method - * @brief Set the float value in a column + * @brief Store a float value in the specified column + * @param column ID number of the target column + * @param value value to assign + * @see TableRow#setInt(int, int) + * @see TableRow#setString(int, String) + * @see Table#setInt(int, int, int) + * @see Table#setFloat(int, int, float) + * @see Table#setString(int, int, String) */ public void setFloat(int column, float value); + /** + * @param columnName title of the target column + */ public void setFloat(String columnName, float value); public void setDouble(int column, double value);