Skip to content

Adding missing docs and keywords for TableRow. #4333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benfry merged 2 commits into from
Nov 10, 2016
Merged

Adding missing docs and keywords for TableRow. #4333

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3bccc17
Adding missing docs and keywords for TableRow.
suheb Feb 27, 2016
7067a33
Removing manually added keywords
suheb Nov 10, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 72 additions & 7 deletions core/src/processing/data/TableRow.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,17 @@ public interface TableRow {
* @param columnName title of the column to reference
*/
public int getInt(String columnName);

/**
* @webref tablerow:method
* @brief Get a long value from the specified column
* @param column ID number of the column to reference
* @see TableRow#getFloat(int)
* @see TableRow#getString(int)
*/
public long getLong(int column);
/**
* @param columnName title of the column to reference
*/
public long getLong(String columnName);

/**
Expand All @@ -52,8 +61,17 @@ public interface TableRow {
* @param columnName title of the column to reference
*/
public float getFloat(String columnName);

/**
* @webref tablerow:method
* @brief Get a double value from the specified column
* @param column ID number of the column to reference
* @see TableRow#getInt(int)
* @see TableRow#getString(int)
*/
public double getDouble(int column);
/**
* @param columnName title of the column to reference
*/
public double getDouble(String columnName);

/**
Expand Down Expand Up @@ -83,8 +101,18 @@ public interface TableRow {
* @param columnName title of the target column
*/
public void setInt(String columnName, int value);

/**
* @webref tablerow:method
* @brief Store a long 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)
*/
public void setLong(int column, long value);
/**
* @param columnName title of the target column
*/
public void setLong(String columnName, long value);

/**
Expand All @@ -100,16 +128,53 @@ public interface TableRow {
* @param columnName title of the target column
*/
public void setFloat(String columnName, float value);

/**
* @webref tablerow:method
* @brief Store a double 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)
*/
public void setDouble(int column, double value);
/**
* @param columnName title of the target column
*/
public void setDouble(String columnName, double value);

/**
* @webref tablerow:method
* @brief Get the column count.
* @return count of all columns
*/
public int getColumnCount();
/**
* @webref tablerow:method
* @brief Get the column type.
* @param columnName title of the target column
* @return type of the column
*/
public int getColumnType(String columnName);
/**
* @param column ID number of the target column
*/
public int getColumnType(int column);

/**
* @webref tablerow:method
* @brief Get the all column types.
* @return list of all column types
*/
public int[] getColumnTypes();

/**
* @webref tablerow:method
* @brief Get the column title.
* @param column ID number of the target column
* @return title of the column
*/
public String getColumnTitle(int column);
/**
* @webref tablerow:method
* @brief Get the all column titles.
* @return list of all column titles
*/
public String[] getColumnTitles();
}