sapphire.util

Class DataSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList

sapphire.util.DataSet

All Implemented Interfaces:

com.labvantage.sapphire.gwt.shared.JSONable, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List, java.util.RandomAccess

public class DataSet
extends java.util.ArrayList
implements java.io.Serializable, com.labvantage.sapphire.gwt.shared.JSONable

This utility class is designed to hold a 2-dimensional "table" of data, and provide methods to manage and manipulate that data. The DataSet is typically populated by one of two mechanisms: 1) Passing a JDBC java.sql.ResultSet class to the constructor or setResultSet() method. 2) Manually adding columns, calling addRow() and then the "setter" methods e.g. setString() Data can be extracted out of the class using a variety of "getter" methods such as getString(), getCalendar() and getObject(). "Sort", "filter" and "find" methods can be used to manipulate and navigate the data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DataSet.ResultSetRowProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLOB
static int	DATE Constant indicating an Date column/data type.
static int	FAILURE
static int	NULLNUMBER
static int	NUMBER Constant indicating a Numeric column/data type.
static int	STRING Constant indicating a String column/data type.
static int	SUCCESS
static int	UNKNOWN Constant indicating an unknown column/data type.

Fields inherited from class java.util.AbstractList

modCount

Fields inherited from interface com.labvantage.sapphire.gwt.shared.JSONable

TYPE_SUFFIX

Constructor Summary

Constructors

Constructor and Description
DataSet() Constructs a new empty DataSet.
DataSet(com.labvantage.sapphire.services.ConnectionInfo connectionInfo) Constructs a new empty DataSet with Locale and TimeZone set according to ConnectionInfo.
DataSet(org.json.JSONObject job)
DataSet(java.util.Locale locale, java.util.TimeZone timezone) Deprecated. Use the DataSet( ConnectionInfo ) constructor instead
DataSet(java.sql.ResultSet rs) Constructs a new DataSet based on a JDBC resultset.
DataSet(java.sql.ResultSet rs, com.labvantage.sapphire.services.ConnectionInfo connectionInfo) Constructs a new DataSet based on a JDBC resultset.
DataSet(java.sql.ResultSet rs, java.util.Locale locale, java.util.TimeZone timezone) Deprecated. Use the DataSet( ResultSet, ConnectionInfo ) constructor instead
DataSet(java.lang.String xml) Constructs a new DataSet based on a XML string.
DataSet(java.lang.String xml, com.labvantage.sapphire.services.ConnectionInfo connectionInfo) Constructs a new DataSet based on a XML string.
DataSet(java.lang.String xml, java.util.Locale locale, java.util.TimeZone timezone) Deprecated. Use the DataSet( xml, ConnectionInfo ) constructor instead
DataSet(java.lang.String columnnames, java.lang.String rowdata) Constructs a new DataSet based on two strings, one containing column names (semi-colon delimted) and one containing the data (pipe and semicolon delimited).

Method Summary

Modifier and Type	Method and Description
boolean	addColumn(java.lang.String columnid, int type) Adds a blank column.
boolean	addColumn(java.lang.String columnid, int type, int length) Adds a blank column.
boolean	addColumnValues(java.lang.String columnid, int type, java.lang.String valueslist, java.lang.String delimeter) Used to simultaneously add a column and a list of values.
boolean	addColumnValues(java.lang.String columnid, int type, java.lang.String valueslist, java.lang.String delimeter, java.lang.String defaultvalue) Used to simultaneously add a column and a list of values.
int	addRow() Adds a blank row to the end of the dataset.
int	addRow(int newrow) Adds a blank row before the specifiedrow in the dataset.
DataSet	copy() Return a copy of the dataset object with no references to this object.
DataSet	copy(java.lang.String[] columns, boolean includeClobs) Return a copy of the dataset object with no references to this object.
void	copyRow(DataSet from, int copyrow, int copies) Copies a row in a different dataset 'n' times.
void	copyRow(int copyrow, int copies) Copies a row in the dataset 'n' times.
void	deleteRow(int row) Deletes a specific row.
int	findRow(java.util.HashMap findmap) Returns the row number of the first row found matching a specified find HashMap.
int	findRow(java.util.HashMap findmap, int start) Returns the row number of the first row found matching a specified find HashMap.
int	findRow(java.lang.String find) Deprecated. This method fails to find the row if any column value contains comma, hence it is recommended to use findRow(HashMap findMap) for multiple column-value pairs and for single column-value pair use findRow(String, String).
int	findRow(java.lang.String columnId, java.lang.String value) Returns the row number of the first row found matching with the value specified with the column.
java.math.BigDecimal	getBigDecimal(int row, java.lang.String columnid) Get a BigDecimal value from a Numeric column.
java.math.BigDecimal	getBigDecimal(int row, java.lang.String columnid, java.math.BigDecimal defaultvalue) Get a BigDecimal value from a Numeric column with a default value if the BigDecimal is null.
java.util.Calendar	getCalendar(int row, java.lang.String columnid) Get a Calendar object from a Date column.
java.util.Calendar	getCalendar(int row, java.lang.String columnid, java.util.Calendar defaultvalue) Get a Calendar object from a Date column with a default value if the value is null.
java.lang.String	getCdataEscape() get the CDATA escape sequence that was used when calling toXML() on the DataSet
java.lang.String	getClob(int row, java.lang.String columnid) Get a string value from a Clob column.
java.lang.String	getClob(int row, java.lang.String columnid, java.lang.String defaultvalue) Get a string value from a Clob column with a default value if the string is null (or empty).
boolean	getColidCaseSensitive() Return whether the dataset object treats columnid as case sensitive.
int	getColumnCount() Returns the number of columns.
java.lang.String	getColumnId(int col) Returns the Id (Name) of the specified column number.
int	getColumnLength(java.lang.String columnid) Returns the column length if DataSet.STRING type and from a java.sql.ResultSet.
java.lang.String[]	getColumns() Returns the list of columns.
int	getColumnType(java.lang.String columnid) Returns the column data type.
java.lang.String	getColumnValues(java.lang.String columnid, int startrow, int endrow, java.lang.String delimeter) Returns concatenated list of column values, with each value separated by a given delimeter
java.lang.String	getColumnValues(java.lang.String columnid, int startrow, int endrow, java.lang.String delimeter, boolean distinct) Returns concatenated list of column values, with each value separated by a given delimeter
java.lang.String	getColumnValues(java.lang.String columnid, java.lang.String delimeter) Returns concatenated list of column values, with each value separated by a given delimeter
java.text.DateFormat	getDateDisplayFormat(java.lang.String columnid) Returns current date display format for column.
double	getDouble(int row, java.lang.String columnid) Get an int value from a Numeric column.
double	getDouble(int row, java.lang.String columnid, double defaultvalue) Get an int value from a Numeric column with a default value if the value is null.
DataSet	getFilteredDataSet(java.util.HashMap filtermap) Returns a new DataSet representing a subset of the rows in the current DataSet, as specified by a filtering HashMap.
DataSet	getFilteredDataSet(java.util.HashMap filtermap, boolean exclusive)
java.util.ArrayList<DataSet>	getGroupedDataSets(java.lang.String columnList) Returns an ArrayList of DataSets that have been grouped by one or more columns.
java.lang.String	getId()
com.labvantage.sapphire.DataSetIndex	getIndex() Get index for this data set.
int	getInt(int row, java.lang.String columnid) Get an int value from a Numeric column.
int	getInt(int row, java.lang.String columnid, int defaultvalue) Get an int value from a Numeric column with a default value if the value is null.
java.util.Set<java.lang.String>	getKeyColumnSet() Get list of key columns of this data set.
java.util.Locale	getLocale() Return the locale the dataset object uses.
long	getLong(int row, java.lang.String columnid) Get an int value from a Numeric column.
M18NUtil	getM18n()
java.lang.Object	getObject(int row, java.lang.String columnid) Returns an object containing the String, BigDecimal or Calendar for a given row / column.
int	getRowCount() Returns the number of rows.
DataSet	getRows(int from, int to)
java.util.ArrayList<DataSet>	getSplitDataSets(int maxRows) Returns an ArrayList of DataSets that have been split from the original into datasets of a maximum size.
java.lang.String	getString(int row, java.lang.String columnid) Get a string value from a String column.
java.lang.String	getString(int row, java.lang.String columnid, java.lang.String defaultvalue) Get a string value from a String column with a default value if the string is null (or empty).
java.sql.Timestamp	getTimestamp(int row, java.lang.String columnid) Get a JDBC Timestamp object from a Date column.
java.sql.Timestamp	getTimestamp(int row, java.lang.String columnid, java.sql.Timestamp defaultvalue) Get a JDBC Timestamp object from a Date column with a default value if the value is null.
java.util.TimeZone	getTimeZone() Return the timezone the dataset object uses.
java.lang.String	getValue(int row, java.lang.String columnid) Returns a String representing the value for the specified row / column, independant of column type.
java.lang.String	getValue(int row, java.lang.String columnid, boolean ignoreMasking) Returns a String representing the value for the specified row / column, independant of column type.
java.lang.String	getValue(int row, java.lang.String columnid, java.lang.String nullvalue) Returns a String representing the value for the specified row / column, independant of column type.
boolean	isIndexing() Check if any column is indexed.
boolean	isIndexing(java.lang.String column) Check if column is indexed.
boolean	isMasked(int row, java.lang.String columnid) Checks if the value in the specified row and column is applicable for data masking when being accessed by the getValue method.
boolean	isNull(int row, java.lang.String columnid) Checks whether a value is null (or an empty string if the column is a String column).
boolean	isValidColumn(java.lang.String columnid) Checks whether the columnid has already been added.
void	moveRow(int from, int amount)
void	padColumn(java.lang.String columnid) Runs down a column and fills in any null values (or empty String values if it is a String column ) with the non-null value from the previous row.
void	padColumns() Runs down all columns and fills in any null values (or empty String values if it is a String column ) with the non-null value from the previous row.
void	removeColumn(java.lang.String oldColumnid)
void	renameColumn(java.lang.String oldColumnid, java.lang.String newColumnid) Rename a column
void	reset() Clears all data, sorts and columns from the dataset.
void	setCdataEscape(java.lang.String escape) set the CDATA escape sequence to be used when calling toXML() on the DataSet
boolean	setClob(int row, java.lang.String columnid, java.lang.String value) Adds a clob into the dataset at the specified point.
void	setColidCaseSensitive(boolean isColidCaseSensitive) Specify a whether the dataset object should treat columnid as case sensitive.
boolean	setColumnRowString(java.lang.String columns, java.lang.String rowdata) Populates the dataset from a string containing column names and a string containing row data.
boolean	setColumnRowString(java.lang.String columns, java.lang.String rowdata, java.lang.String delim1, java.lang.String delim2)
void	setConnectionInfo(com.labvantage.sapphire.services.ConnectionInfo connectionInfo) Specify a connectionInfo object(usually available in the sapphireConnection variable) for formatting date and number type column to string by getValue methods and for setValue methods to interpret inputs of date and number
boolean	setDate(int row, java.lang.String columnid, java.util.Calendar value) Adds a Calendar into the dataset at the specified point.
boolean	setDate(int row, java.lang.String columnid, long value) Adds a date (parsed from a long) into the dataset at the specified point.
boolean	setDate(int row, java.lang.String columnid, java.lang.String value) Adds a date (parsed from a String) into the dataset at the specified point.
boolean	setDate(int row, java.lang.String columnid, java.sql.Timestamp value) Adds a JDBC Timestamp into the dataset at the specified point.
void	setDateDisplayFormat(java.lang.String columnid, java.text.DateFormat dateformat) Specify a DateFormat to use for date type column by getValue methods
void	setId(java.lang.String id)
boolean	setJSONObject(org.json.JSONObject json)
void	setKeyColumns(java.util.Set<java.lang.String> columnIds) Set key columns of this data set.
void	setKeyColumns(java.lang.String columnIds) Set key columns of this data set.
void	setLocale(java.util.Locale locale) Deprecated. You should not set the locale directly. Use the DataSet( connectionInfo ) constructor or setM18NUtil instead
void	setM18NUtil(M18NUtil m18NUtil) Specify a M18NUtil object to use for formatting date and number type column to string by getValue methods and for setValue methods to interpret inputs of date and number
boolean	setMaskedString(int row, java.lang.String columnid, java.lang.String value) Sets the Masked value of the requested cell.
boolean	setNumber(int row, java.lang.String columnid, java.math.BigDecimal value) Adds a number (BigDecimal) into the dataset at the specified point.
boolean	setNumber(int row, java.lang.String columnid, double value) Adds a number (long) into the dataset at the specified point.
boolean	setNumber(int row, java.lang.String columnid, int value) Adds a number (int) into the dataset at the specified point.
boolean	setNumber(int row, java.lang.String columnid, long value) Adds a number (long) into the dataset at the specified point.
boolean	setNumber(int row, java.lang.String columnid, java.lang.String value) Adds a number (parsed from a String) into the dataset at the specified point.
boolean	setObject(int row, java.lang.String columnid, java.lang.Object o) Adds an object into the dataset at the specified point.
boolean	setResultSet(java.sql.ResultSet rs) Populates dataset with JDBC result set.
boolean	setResultSet(java.sql.ResultSet rs, boolean extendedDataTypes, java.lang.String dbms) Populates dataset with JDBC result set.
boolean	setResultSet(java.sql.ResultSet rs, boolean extendedDataTypes, java.lang.String dbms, DataSet.ResultSetRowProcessor rowProcessor) Populates dataset with JDBC result set.
boolean	setSequence(int startrow, int endrow, java.lang.String columnid, int startseq) Populates a subset of rows of a numeric column with a sequentially increasing value.
boolean	setSequence(java.lang.String columnid) Populates a numeric column with a sequentially increasing value.
boolean	setString(int row, java.lang.String columnid, java.lang.String value) Adds a string into the dataset at the specified point.
void	setTimeZone(java.util.TimeZone timezone) Deprecated. You should not set the timezone directly. Use the DataSet( connectionInfo ) constructor or setM18NUtil instead
void	setTimeZoneInsensitive(java.lang.String columnid) Specify a Date Column to use system default time zone for parsing and formatting when setValue and getValue methods are called.
boolean	setValue(int row, java.lang.String columnid, java.lang.String value) Adds a string value into the dataset at the specified point, converted to the appropriate data type.
boolean	setXML(java.lang.String xml) Populates dataset with JDBC result set.
void	showData() Writes the contents of the dataset to the System.out stream.
void	sort(java.lang.String sortstring) Sorts the dataset according to the specified sort criteria.
void	sort(java.lang.String sortstring, boolean ignoreMaskedData)
java.lang.String	toHTML() Default toHTML() method.
java.lang.String	toHTML(java.util.List titles) Default toHTML() method.
java.lang.String	toHTML(java.util.List titles, java.util.List columnIds)
java.lang.String	toHTML(java.util.List titles, java.lang.String stylePrefix) Default toHTML() method.
java.lang.String	toHTML(java.util.List titles, java.lang.String stylePrefix, java.util.List<java.lang.String> columnIds) Default toHTML() method.
org.json.JSONObject	toJSONObject()
org.json.JSONObject	toJSONObject(boolean includeClobs, boolean includeUnknows)
org.json.JSONObject	toJSONObject(boolean optimizedFormat, boolean includeClobs, boolean includeUnknows)
org.json.JSONObject	toJSONObject(boolean optimizedFormat, java.lang.String[] columns, boolean useDataTypes, boolean includeClobs, boolean includeUnknows)
java.lang.String	toJSONString()
java.lang.String	toJSONString(boolean includeClobs, boolean includeUnknows)
java.lang.String	toJSONString(boolean optimizedFormat, boolean includeClobs, boolean includeUnknows)
java.lang.String	toJSONString(boolean optimizedFormat, java.lang.String[] columns, boolean useDataTypes, boolean includeClobs, boolean includeUnknows)
java.lang.String	toString() Default toString() method.
java.lang.String	toXML() Default toXML() method.
java.lang.String	toXML(boolean includeClobs) Default toXML() method.
java.lang.String	toXML(boolean includeClobs, boolean includeColumnDefinitions) Default toXML() method.
boolean	useIndex(java.util.HashMap filter) Check if filtering data set with given filter would benefit from using indexing.

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Field Detail

SUCCESS

public static final int SUCCESS

See Also:

Constant Field Values

FAILURE

public static final int FAILURE

See Also:

Constant Field Values

UNKNOWN

public static final int UNKNOWN

Constant indicating an unknown column/data type.

See Also:

Constant Field Values

STRING

public static final int STRING

Constant indicating a String column/data type.

See Also:

Constant Field Values

NUMBER

public static final int NUMBER

Constant indicating a Numeric column/data type. This will be internally stored as a java.math.BigDecimal.

See Also:

Constant Field Values

DATE

public static final int DATE

Constant indicating an Date column/data type. This will be internally stored as a java.util.Calendar.

See Also:

Constant Field Values

CLOB

public static final int CLOB

See Also:

Constant Field Values

NULLNUMBER

public static final int NULLNUMBER

See Also:

Constant Field Values

Constructor Detail

DataSet

public DataSet()

Constructs a new empty DataSet.

DataSet

public DataSet(com.labvantage.sapphire.services.ConnectionInfo connectionInfo)

Constructs a new empty DataSet with Locale and TimeZone set according to ConnectionInfo. Dataset constructed with connectionInfo will be sapphire dateformat policy aware

Parameters:

connectionInfo - that will be used to set the locale and timezone of the DateSet instance.

DataSet

public DataSet(java.sql.ResultSet rs)

Constructs a new DataSet based on a JDBC resultset.

Parameters:

rs - JDBC result set that will be used to popuplate the dataset.

DataSet

public DataSet(java.sql.ResultSet rs,
               com.labvantage.sapphire.services.ConnectionInfo connectionInfo)

Constructs a new DataSet based on a JDBC resultset. Dataset will be sapphire dateformat policy aware

Parameters:

rs - JDBC result set that will be used to popuplate the dataset.

connectionInfo - that will be used to set the locale and timezone of the DateSet instance.

DataSet

public DataSet(java.lang.String xml)

Constructs a new DataSet based on a XML string.

Parameters:

xml - XML string or rows and columns that will be used to popuplate the dataset.

DataSet

public DataSet(org.json.JSONObject job)

DataSet

public DataSet(java.lang.String xml,
               com.labvantage.sapphire.services.ConnectionInfo connectionInfo)

Constructs a new DataSet based on a XML string. Dataset will be sapphire dateformat policy aware

Parameters:

xml - XML string or rows and columns that will be used to popuplate the dataset.

connectionInfo - that will be used to set the locale and timezone of the DateSet instance.

DataSet

public DataSet(java.lang.String columnnames,
               java.lang.String rowdata)

Constructs a new DataSet based on two strings, one containing column names (semi-colon delimted) and one containing the data (pipe and semicolon delimited).

Parameters:

columnnames - String containing columns that will be used to popuplate the dataset (must be semi-colon delimited).

rowdata - String containing data in column1|column2;column1|column2 format (columns must be pipe delimted and rows semi-colon delimited)

DataSet

public DataSet(java.util.Locale locale,
               java.util.TimeZone timezone)

Deprecated. Use the DataSet( ConnectionInfo ) constructor instead

Constructs a new empty DataSet with Locale and TimeZone set.

Parameters:

locale - that will be used to parse, format the date and number value.

timezone - that will be used to parse and format the date value.

DataSet

public DataSet(java.sql.ResultSet rs,
               java.util.Locale locale,
               java.util.TimeZone timezone)

Deprecated. Use the DataSet( ResultSet, ConnectionInfo ) constructor instead

Constructs a new DataSet based on a JDBC resultset with Locale and TimeZone set.

Parameters:

rs - JDBC result set that will be used to popuplate the dataset.

locale - that will be used to parse, format the date and number value.

timezone - that will be used to parse and format the date value.

DataSet

public DataSet(java.lang.String xml,
               java.util.Locale locale,
               java.util.TimeZone timezone)

Deprecated. Use the DataSet( xml, ConnectionInfo ) constructor instead

Constructs a new DataSet based on a XML string with Locale and TimeZone set.

Parameters:

xml - XML string or rows and columns that will be used to popuplate the dataset.

locale - that will be used to parse, format the date and number value.

timezone - that will be used to parse and format the date value.

Method Detail

setId

public void setId(java.lang.String id)

getId

public java.lang.String getId()

setCdataEscape

public void setCdataEscape(java.lang.String escape)

set the CDATA escape sequence to be used when calling toXML() on the DataSet

getCdataEscape

public java.lang.String getCdataEscape()

get the CDATA escape sequence that was used when calling toXML() on the DataSet

toXML

public java.lang.String toXML()

Default toXML() method. Clob fields will be omitted

Returns:

XML representation of the dataset.

toXML

public java.lang.String toXML(boolean includeClobs)

Default toXML() method.

Parameters:

includeClobs - indicate whether CLOB fields will be included in the final output

Returns:

XML representation of the dataset.

toJSONObject

public org.json.JSONObject toJSONObject()

toJSONObject

public org.json.JSONObject toJSONObject(boolean includeClobs,
                                        boolean includeUnknows)

toJSONObject

public org.json.JSONObject toJSONObject(boolean optimizedFormat,
                                        boolean includeClobs,
                                        boolean includeUnknows)

toJSONObject

public org.json.JSONObject toJSONObject(boolean optimizedFormat,
                                        java.lang.String[] columns,
                                        boolean useDataTypes,
                                        boolean includeClobs,
                                        boolean includeUnknows)

copy

public DataSet copy(java.lang.String[] columns,
                    boolean includeClobs)

Return a copy of the dataset object with no references to this object. More efficient as uses JSON Objects rather than XML Also includes clobs

getRows

public DataSet getRows(int from,
                       int to)

setJSONObject

public boolean setJSONObject(org.json.JSONObject json)

toJSONString

public java.lang.String toJSONString()

Specified by:

toJSONString in interface com.labvantage.sapphire.gwt.shared.JSONable

toJSONString

public java.lang.String toJSONString(boolean includeClobs,
                                     boolean includeUnknows)

toJSONString

public java.lang.String toJSONString(boolean optimizedFormat,
                                     boolean includeClobs,
                                     boolean includeUnknows)

toJSONString

public java.lang.String toJSONString(boolean optimizedFormat,
                                     java.lang.String[] columns,
                                     boolean useDataTypes,
                                     boolean includeClobs,
                                     boolean includeUnknows)

toXML

public java.lang.String toXML(boolean includeClobs,
                              boolean includeColumnDefinitions)

Default toXML() method.

Parameters:

includeClobs - indicate whether CLOB fields will be included in the final output

includeColumnDefinitions - indicate whether column definitions will be included

Returns:

XML representation of the dataset.

toHTML

public java.lang.String toHTML(java.util.List titles)

Default toHTML() method.

Parameters:

titles - A list of the titles to display for each column. Pass in a null or empty list to display no titles

Returns:

HTML table representation of the dataset.

toHTML

public java.lang.String toHTML()

Default toHTML() method. The table gets generated with the following classes: .gridtable, .gridtitle, .gridcell

Returns:

HTML table representation of the dataset.

toHTML

public java.lang.String toHTML(java.util.List titles,
                               java.util.List columnIds)

toHTML

public java.lang.String toHTML(java.util.List titles,
                               java.lang.String stylePrefix,
                               java.util.List<java.lang.String> columnIds)

Default toHTML() method.

Parameters:

titles - A list of the titles to display for each column. Pass in a null or empty list to display no titles

stylePrefix - A prefix for the classnames

columnIds - A list of columns which will be rendered only. The columns are rendered according to the order provided in the List. If null, then show all columns.

Returns:

HTML table representation of the dataset.

toHTML

public java.lang.String toHTML(java.util.List titles,
                               java.lang.String stylePrefix)

Default toHTML() method.

Parameters:

titles - A list of the titles to display for each column. Pass in a null or empty list to display no titles

stylePrefix - A prefix for the classnames

Returns:

HTML table representation of the dataset.

toString

public java.lang.String toString()

Default toString() method.

Overrides:

toString in class java.util.AbstractCollection

Returns:

Tab / Carriage Return delimeted representation of the dataset.

showData

public void showData()

Writes the contents of the dataset to the System.out stream. Call System.out once for each row in the dataset.

reset

public void reset()

Clears all data, sorts and columns from the dataset.

deleteRow

public void deleteRow(int row)

Deletes a specific row.

moveRow

public void moveRow(int from,
                    int amount)

setResultSet

public boolean setResultSet(java.sql.ResultSet rs)

Populates dataset with JDBC result set.

Parameters:

rs - JDBC result set that will be used to popuplate the dataset.

Returns:

true if the dataset is successfully created.

setResultSet

public boolean setResultSet(java.sql.ResultSet rs,
                            boolean extendedDataTypes,
                            java.lang.String dbms)

Populates dataset with JDBC result set.

Parameters:

rs - JDBC result set that will be used to popuplate the dataset.

extendedDataTypes - generates a dataset that handles extended data types, including CLOBS

dbms - either MSS or ORA

Returns:

true if the dataset is successfully created.

setResultSet

public boolean setResultSet(java.sql.ResultSet rs,
                            boolean extendedDataTypes,
                            java.lang.String dbms,
                            DataSet.ResultSetRowProcessor rowProcessor)

Populates dataset with JDBC result set.

Parameters:

rs - JDBC result set that will be used to popuplate the dataset.

extendedDataTypes - generates a dataset that handles extended data types, including CLOBS

dbms - either MSS or ORA

Returns:

true if the dataset is successfully created.

setXML

public boolean setXML(java.lang.String xml)

Populates dataset with JDBC result set.

Parameters:

xml - XML String containing rows and columns that will be used to popuplate the dataset.

Returns:

true if the dataset is successfully created.

setColumnRowString

public boolean setColumnRowString(java.lang.String columns,
                                  java.lang.String rowdata)

Populates the dataset from a string containing column names and a string containing row data. This can be used to create a dataset from a list page selection.

Parameters:

columns - String containing columns that will be used to popuplate the dataset (must be semi-colon delimited).

rowdata - String containing data in column1|column2;column1|column2 format (columns must be pipe delimted and rows semi-colon delimited)

Returns:

true if the dataset is successfully created.

setColumnRowString

public boolean setColumnRowString(java.lang.String columns,
                                  java.lang.String rowdata,
                                  java.lang.String delim1,
                                  java.lang.String delim2)

addRow

public int addRow()

Adds a blank row to the end of the dataset.

Returns:

The new row number.

addRow

public int addRow(int newrow)

Adds a blank row before the specifiedrow in the dataset.

Parameters:

newrow - rownumber at which the new row is to be inserted

Returns:

The new row number.

copyRow

public void copyRow(int copyrow,
                    int copies)

Copies a row in the dataset 'n' times. New rows are added to the end of the dataset.

Parameters:

copyrow - the row number to copy.

copies - the number of copies you want to generate.

copyRow

public void copyRow(DataSet from,
                    int copyrow,
                    int copies)

Copies a row in a different dataset 'n' times. New rows are added to the end of the dataset. New columns are added to the target if necessary.

Parameters:

from - the dataset containing the row to copy.

copyrow - the row number to copy. Use -1 to copy all rows

copies - the number of copies you want to generate.

getRowCount

public int getRowCount()

Returns the number of rows.

Returns:

the number of rows.

addColumn

public boolean addColumn(java.lang.String columnid,
                         int type)

Adds a blank column.

Parameters:

columnid - the name of the column.

type - indicate the data type. Use either DataSet.STRING, DataSet.NUMBER or DataSet.DATE.

Returns:

true if the column was added successfully.

addColumn

public boolean addColumn(java.lang.String columnid,
                         int type,
                         int length)

Adds a blank column.

Parameters:

columnid - the name of the column.

type - indicate the data type. Use either DataSet.STRING, DataSet.NUMBER or DataSet.DATE.

length - indicate the length for string type

Returns:

true if the column was added successfully.

addColumnValues

public boolean addColumnValues(java.lang.String columnid,
                               int type,
                               java.lang.String valueslist,
                               java.lang.String delimeter,
                               java.lang.String defaultvalue)

Used to simultaneously add a column and a list of values. The values are passed as a delimted String. The method performs the following actions: a) Adds a column for the given name and type. b) Splits the delimited value list into multiple items. c) Populates the new column with the values from b). d) If there are more values than rows, additional rows are added accordingly. e) If no values are provided, the column is populated with the default value.

Parameters:

columnid - the name of the column.

type - the datatype of the column. Use either DataSet.STRING, DataSet.NUMBER or DataSet.DATE.

valueslist - delimited list of values to add as rows.

delimeter - used to separate the list of values.

defaultvalue - if the valueslist is null or is an empty string

Returns:

true if the column and values are added correctly.

addColumnValues

public boolean addColumnValues(java.lang.String columnid,
                               int type,
                               java.lang.String valueslist,
                               java.lang.String delimeter)

Used to simultaneously add a column and a list of values. The values are passed as a delimted String. The method performs the following actions: a) Adds a column for the given name and type. b) Splits the delimited value list into multiple items. c) Populates the new column with the values from b). d) If there are more values than rows, additional rows are added accordingly.

Parameters:

columnid - the name of the column.

type - the datatype of the column. Use either DataSet.STRING, DataSet.NUMBER or DataSet.DATE.

valueslist - delimited list of values to add as rows.

delimeter - used to separate the list of values.

Returns:

true if the column and values are added correctly.

padColumns

public void padColumns()

Runs down all columns and fills in any null values (or empty String values if it is a String column ) with the non-null value from the previous row. This may be useful when managing groups of multi-value properties.

padColumn

public void padColumn(java.lang.String columnid)

Runs down a column and fills in any null values (or empty String values if it is a String column ) with the non-null value from the previous row.

Parameters:

columnid - the name of the column to pad

isValidColumn

public boolean isValidColumn(java.lang.String columnid)

Checks whether the columnid has already been added.

Parameters:

columnid - the name of the column to check.

Returns:

true if the column already exists.

getColumnCount

public int getColumnCount()

Returns the number of columns.

Returns:

the number of columns.

getColumns

public java.lang.String[] getColumns()

Returns the list of columns.

Returns:

the list of columns.

getColumnType

public int getColumnType(java.lang.String columnid)

Returns the column data type.

Parameters:

columnid - the name of the columns.

Returns:

either DataSet.STRING, DataSet.NUMBER, DataSet.DATE or DataSet.UNKNOWN.

getColumnLength

public int getColumnLength(java.lang.String columnid)

Returns the column length if DataSet.STRING type and from a java.sql.ResultSet.

Parameters:

columnid - the name of the columns.

Returns:

int or DataSet.UNKNOWN.

getColumnId

public java.lang.String getColumnId(int col)

Returns the Id (Name) of the specified column number.

Parameters:

col - the column number.

Returns:

the column id (name).

getColumnValues

public java.lang.String getColumnValues(java.lang.String columnid,
                                        int startrow,
                                        int endrow,
                                        java.lang.String delimeter)

Returns concatenated list of column values, with each value separated by a given delimeter

Parameters:

columnid - the column name

startrow - the rows to start from. The value in this row will be included in the final string

endrow - loop up the this row number. The value in this row will NOT be included in the final string

delimeter - the delimeter that will be used to separate the value

Returns:

the resulting string

getColumnValues

public java.lang.String getColumnValues(java.lang.String columnid,
                                        int startrow,
                                        int endrow,
                                        java.lang.String delimeter,
                                        boolean distinct)

Returns concatenated list of column values, with each value separated by a given delimeter

Parameters:

columnid - the column name

startrow - the rows to start from. The value in this row will be included in the final string

endrow - loop up the this row number. The value in this row will NOT be included in the final string

delimeter - the delimeter that will be used to separate the value

distinct - set to true to only bring distinct values

Returns:

the resulting string

getColumnValues

public java.lang.String getColumnValues(java.lang.String columnid,
                                        java.lang.String delimeter)

Returns concatenated list of column values, with each value separated by a given delimeter

Parameters:

columnid - the column name

delimeter - the delimeter that will be used to separate the value

Returns:

the resulting string

setObject

public boolean setObject(int row,
                         java.lang.String columnid,
                         java.lang.Object o)

Adds an object into the dataset at the specified point. Note that only Strings, Calendars and BigDecimals are supported.

Parameters:

row - the row to set the value. Specify -1 to set the object into all rows.

columnid - the column id.

o - the object.

Returns:

true if the object is added correctly.

setString

public boolean setString(int row,
                         java.lang.String columnid,
                         java.lang.String value)

Adds a string into the dataset at the specified point.

Parameters:

row - the row to set the value. Specify -1 to set the value into all rows.

columnid - the column id. The column is added if it does not already exist.

value - the string value.

Returns:

true if the string is added correctly.

setClob

public boolean setClob(int row,
                       java.lang.String columnid,
                       java.lang.String value)

Adds a clob into the dataset at the specified point.

Parameters:

row - the row to set the value. Specify -1 to set the value into all rows.

columnid - the column id. The column is added if it does not already exist.

value - the clob value.

Returns:

true if the clob is added correctly.

setNumber

public boolean setNumber(int row,
                         java.lang.String columnid,
                         int value)

Adds a number (int) into the dataset at the specified point.

Parameters:

row - the row to set the value. Specify -1 to set the value into all rows.

columnid - the column id. The column is added if it does not already exist.

value - the int value. (This will be interally stored as a BigDecimal).

Returns:

true if the int is added correctly.

setNumber

public boolean setNumber(int row,
                         java.lang.String columnid,
                         long value)

Adds a number (long) into the dataset at the specified point.

Parameters:

row - the row to set the value. Specify -1 to set the value into all rows.

columnid - the column id. The column is added if it does not already exist.

value - the int value. (This will be interally stored as a BigDecimal).

Returns:

true if the int is added correctly.

setNumber

public boolean setNumber(int row,
                         java.lang.String columnid,
                         double value)

Adds a number (long) into the dataset at the specified point.

Parameters:

row - the row to set the value. Specify -1 to set the value into all rows.

columnid - the column id. The column is added if it does not already exist.

value - the double value. (This will be interally stored as a BigDecimal).

Returns:

true if the double is added correctly.

setNumber

public boolean setNumber(int row,
                         java.lang.String columnid,
                         java.math.BigDecimal value)

Adds a number (BigDecimal) into the dataset at the specified point.

Parameters:

row - the row to set the value. Specify -1 to set the value into all rows.

columnid - the column id. The column is added if it does not already exist.

value - the BigDecimal value.

Returns:

true if the BigDecimal is added correctly.

setNumber

public boolean setNumber(int row,
                         java.lang.String columnid,
                         java.lang.String value)

Adds a number (parsed from a String) into the dataset at the specified point.

Parameters:

row - the row to set the value. Specify -1 to set the value into all rows.

columnid - the column id. The column is added if it does not already exist.

value - the String containing the number. (This will be parsed into and stored as a BigDecimal).

Returns:

true if the number is added correctly.

setDate

public boolean setDate(int row,
                       java.lang.String columnid,
                       long value)

Adds a date (parsed from a long) into the dataset at the specified point.

Parameters:

row - the row to set the value. Specify -1 to set the value into all rows.

columnid - the column id. The column is added if it does not already exist.

value - the long containing the date as EPOCH millisecond UTC date.

Returns:

true if the date is added correctly.

setDate

public boolean setDate(int row,
                       java.lang.String columnid,
                       java.lang.String value)

Adds a date (parsed from a String) into the dataset at the specified point.

Parameters:

row - the row to set the value. Specify -1 to set the value into all rows.

columnid - the column id. The column is added if it does not already exist.

value - the String containing the date. (This will be parsed into and stored as a Calendar). If a long number then will be parsed as EPOCH millisecond UTC date.

Returns:

true if the date is added correctly.

setDate

public boolean setDate(int row,
                       java.lang.String columnid,
                       java.util.Calendar value)

Adds a Calendar into the dataset at the specified point.

Parameters:

row - the row to set the value. Specify -1 to set the value into all rows.

columnid - the column id. The column is added if it does not already exist.

value - the Calendar containing the date.

Returns:

true if the date is added correctly.

setDate

public boolean setDate(int row,
                       java.lang.String columnid,
                       java.sql.Timestamp value)

Adds a JDBC Timestamp into the dataset at the specified point.

Parameters:

row - the row to set the value. Specify -1 to set the value into all rows.

columnid - the column id. The column is added if it does not already exist.

value - the Timestamp containing the date. (This will be internally stored as a Calendar).

Returns:

true if the date is added correctly.

setDateDisplayFormat

public void setDateDisplayFormat(java.lang.String columnid,
                                 java.text.DateFormat dateformat)

Specify a DateFormat to use for date type column by getValue methods

Parameters:

columnid - the date type columnid.

dateformat - the DateFormat object.

getDateDisplayFormat

public java.text.DateFormat getDateDisplayFormat(java.lang.String columnid)

Returns current date display format for column.

Parameters:

columnid - the date type columnid

Returns:

The date format

setTimeZoneInsensitive

public void setTimeZoneInsensitive(java.lang.String columnid)

Specify a Date Column to use system default time zone for parsing and formatting when setValue and getValue methods are called. Default formatting shows the short Date Only format that can be overridden by calling setDateDisplayFormat method.

Parameters:

columnid - the date type columnid.

setLocale

public void setLocale(java.util.Locale locale)

Deprecated. You should not set the locale directly. Use the DataSet( connectionInfo ) constructor or setM18NUtil instead

Specify a locale to use for sortting, formatting date and number type column to string by getValue methods and for setValue methods to interpret inputs of date and number using the locale

Parameters:

locale - the locale.

getLocale

public java.util.Locale getLocale()

Return the locale the dataset object uses.

setTimeZone

public void setTimeZone(java.util.TimeZone timezone)

Deprecated. You should not set the timezone directly. Use the DataSet( connectionInfo ) constructor or setM18NUtil instead

Specify a timezone to use for converting date type column to string by getValue methods and for setValue methods to interpret inputs of date string using the timezone.

Parameters:

timezone - the timezone.

getTimeZone

public java.util.TimeZone getTimeZone()

Return the timezone the dataset object uses.

setM18NUtil

public void setM18NUtil(M18NUtil m18NUtil)

Specify a M18NUtil object to use for formatting date and number type column to string by getValue methods and for setValue methods to interpret inputs of date and number

Parameters:

m18NUtil - M18N object.

getM18n

public M18NUtil getM18n()

Returns:

Return the M18N object the dataset object uses.

setConnectionInfo

public void setConnectionInfo(com.labvantage.sapphire.services.ConnectionInfo connectionInfo)

Specify a connectionInfo object(usually available in the sapphireConnection variable) for formatting date and number type column to string by getValue methods and for setValue methods to interpret inputs of date and number

Parameters:

connectionInfo - SapphireConnection object.

copy

public DataSet copy()

Return a copy of the dataset object with no references to this object.

setColidCaseSensitive

public void setColidCaseSensitive(boolean isColidCaseSensitive)

Specify a whether the dataset object should treat columnid as case sensitive.

Parameters:

isColidCaseSensitive - the isColidCaseSensitive.

getColidCaseSensitive

public boolean getColidCaseSensitive()

Return whether the dataset object treats columnid as case sensitive.

setValue

public boolean setValue(int row,
                        java.lang.String columnid,
                        java.lang.String value)

Adds a string value into the dataset at the specified point, converted to the appropriate data type.

Parameters:

row - the row to set the value. Specify -1 to set the value into all rows.

columnid - the column id.

value - the String that will be stored or parsed into a BigDecimal or Calendar, depending on the column type.

Returns:

true if the data is added correctly.

setSequence

public boolean setSequence(int startrow,
                           int endrow,
                           java.lang.String columnid,
                           int startseq)

Populates a subset of rows of a numeric column with a sequentially increasing value.

Parameters:

startrow - the dataset row to start the sequence.

endrow - the dataset row to end the sequence.

columnid - the column id that holds the sequence. The column is added as a Numeric column if it does not already exist.

startseq - the value to start the sequence from.

Returns:

true if the sequence is set correctly.

setSequence

public boolean setSequence(java.lang.String columnid)

Populates a numeric column with a sequentially increasing value.

Parameters:

columnid - the column id that holds the sequence. The column is added as a Numeric column if it does not already exist.

Returns:

true if the sequence is set correctly.

getString

public java.lang.String getString(int row,
                                  java.lang.String columnid)

Get a string value from a String column.

Parameters:

row - the row containing the required value.

columnid - the column containing the required value (this must be a String or Clob column).

Returns:

the String value.

getString

public java.lang.String getString(int row,
                                  java.lang.String columnid,
                                  java.lang.String defaultvalue)

Get a string value from a String column with a default value if the string is null (or empty).

Parameters:

row - the row containing the required value.

columnid - the column containing the required value (this must be a String or Clob column).

defaultvalue - the value to return if the String is null or an empty string.

Returns:

the String value or default value.

getClob

public java.lang.String getClob(int row,
                                java.lang.String columnid)

Get a string value from a Clob column.

Parameters:

row - the row containing the required value.

columnid - the column containing the required value (this must be a Clob column).

Returns:

the String value.

getClob

public java.lang.String getClob(int row,
                                java.lang.String columnid,
                                java.lang.String defaultvalue)

Get a string value from a Clob column with a default value if the string is null (or empty).

Parameters:

row - the row containing the required value.

columnid - the column containing the required value (this must be a Clob column).

defaultvalue - the value to return if the String is null or an empty string.

Returns:

the String value or default value.

getBigDecimal

public java.math.BigDecimal getBigDecimal(int row,
                                          java.lang.String columnid)

Get a BigDecimal value from a Numeric column.

Parameters:

row - the row containing the required value.

columnid - the column containing the required value (this must be a Numeric column).

Returns:

the BigDecimal value.

getBigDecimal

public java.math.BigDecimal getBigDecimal(int row,
                                          java.lang.String columnid,
                                          java.math.BigDecimal defaultvalue)

Get a BigDecimal value from a Numeric column with a default value if the BigDecimal is null.

Parameters:

row - the row containing the required value.

columnid - the column containing the required value (this must be a Numeric column).

defaultvalue - the value to return if the BigDecimal is null.

Returns:

the BigDecimal or default value.

getDouble

public double getDouble(int row,
                        java.lang.String columnid)

Get an int value from a Numeric column.

Parameters:

row - the row containing the required value.

columnid - the column containing the required value (this must be a Numeric column).

Returns:

the double value.

getDouble

public double getDouble(int row,
                        java.lang.String columnid,
                        double defaultvalue)

Get an int value from a Numeric column with a default value if the value is null.

Parameters:

row - the row containing the required value.

columnid - the column containing the required value (this must be a Numeric column).

defaultvalue - the value to return if the lookup value is null.

Returns:

the double value or default value.

getInt

public int getInt(int row,
                  java.lang.String columnid)

Get an int value from a Numeric column.

Parameters:

row - the row containing the required value.

columnid - the column containing the required value (this must be a Numeric column).

Returns:

the int value.

getLong

public long getLong(int row,
                    java.lang.String columnid)

Get an int value from a Numeric column.

Parameters:

row - the row containing the required value.

columnid - the column containing the required value (this must be a Numeric column).

Returns:

the int value.

getInt

public int getInt(int row,
                  java.lang.String columnid,
                  int defaultvalue)

Get an int value from a Numeric column with a default value if the value is null.

Parameters:

row - the row containing the required value.

columnid - the column containing the required value (this must be a Numeric column).

defaultvalue - the value to return if the lookup value is null.

Returns:

the int value or default value.

getCalendar

public java.util.Calendar getCalendar(int row,
                                      java.lang.String columnid)

Get a Calendar object from a Date column.

Parameters:

row - the row containing the required value.

columnid - the column containing the required value (this must be a Date column).

Returns:

the Calendar.

getCalendar

public java.util.Calendar getCalendar(int row,
                                      java.lang.String columnid,
                                      java.util.Calendar defaultvalue)

Get a Calendar object from a Date column with a default value if the value is null.

Parameters:

row - the row containing the required value.

columnid - the column containing the required value (this must be a Date column).

defaultvalue - the value to return if the lookup value is null.

Returns:

the Calendar or default value.

getTimestamp

public java.sql.Timestamp getTimestamp(int row,
                                       java.lang.String columnid)

Get a JDBC Timestamp object from a Date column.

Parameters:

row - the row containing the required value.

columnid - the column containing the required value (this must be a Date column).

Returns:

the Timestamp.

getTimestamp

public java.sql.Timestamp getTimestamp(int row,
                                       java.lang.String columnid,
                                       java.sql.Timestamp defaultvalue)

Get a JDBC Timestamp object from a Date column with a default value if the value is null.

Parameters:

row - the row containing the required value.

columnid - the column containing the required value (this must be a Date column).

defaultvalue - the value to return if the lookup value is null.

Returns:

the Timestamp or default value.

getObject

public java.lang.Object getObject(int row,
                                  java.lang.String columnid)

Returns an object containing the String, BigDecimal or Calendar for a given row / column.

Parameters:

row - the row containing the required value.

columnid - the columnid containing the required value.

Returns:

the object (if it exists) otherwise null, or null if an invalid row or column is specified.

getValue

public java.lang.String getValue(int row,
                                 java.lang.String columnid)

Returns a String representing the value for the specified row / column, independant of column type.

Parameters:

row - the row containing the required value.

columnid - the column containing the required value (this can be either a String, Number or Date column).

Returns:

String representing the specified value. BigDecimals have their double values formatted using a java.text.NumberFormat class. Calendars are formatted using the java.text.DateFormat class.

getValue

public java.lang.String getValue(int row,
                                 java.lang.String columnid,
                                 boolean ignoreMasking)

Returns a String representing the value for the specified row / column, independant of column type.

Parameters:

row - the row containing the required value.

columnid - the column containing the required value (this can be either a String, Number or Date column).

ignoreMasking - If the masked value is to be returned or not for a field which is marked as Masked.

Returns:

String representing the specified value. BigDecimals have their double values formatted using a java.text.NumberFormat class. Calendars are formatted using the java.text.DateFormat class.

getValue

public java.lang.String getValue(int row,
                                 java.lang.String columnid,
                                 java.lang.String nullvalue)

Returns a String representing the value for the specified row / column, independant of column type. If the value is null or if it is an empty string from a String column, then a default value is returned instead.

Parameters:

row - the row containing the required value.

columnid - the column containing the required value (this can be either a String, Number or Date column).

nullvalue - the value returned if the value is null or if it is an empty string from a String column.

Returns:

String representing the specified value. BigDecimals have their double values formatted using a java.text.NumberFormat class. Calendars are formatted using the java.text.DateFormat class.

isNull

public boolean isNull(int row,
                      java.lang.String columnid)

Checks whether a value is null (or an empty string if the column is a String column).

Parameters:

row - the row containing the value to check.

columnid - the column containing the value to check.

Returns:

true if the value is a null object or is an empty string if a String column.

sort

public void sort(java.lang.String sortstring)

Sorts the dataset according to the specified sort criteria.

Parameters:

sortstring - the sort criteria. Specify a comma separated list of columns to sort by. Optionally specifiy an A or D to determine whether to sort Ascending or Decending. For example, "col1, col2 D, col3" is a valid sort string.

sort

public void sort(java.lang.String sortstring,
                 boolean ignoreMaskedData)

getFilteredDataSet

public DataSet getFilteredDataSet(java.util.HashMap filtermap)

Returns a new DataSet representing a subset of the rows in the current DataSet, as specified by a filtering HashMap.

Parameters:

filtermap - java.util.HashMap containing the filter criteria. To use this method, create an empty HashMap, use the .put method to add values into the map representing the column and value pair to look for. For example, passing a HashMap that has been populated with filtermap.put( "col1", "XXX" ) will return a DataSet containing only those rows for which the "col1" column contain the value XXX.

Returns:

a DataSet contain only the matched rows. Note that the objects in the new DataSet (and hence modifications to them) refer to the same objects in the original DataSet.

getFilteredDataSet

public DataSet getFilteredDataSet(java.util.HashMap filtermap,
                                  boolean exclusive)

getSplitDataSets

public java.util.ArrayList<DataSet> getSplitDataSets(int maxRows)

Returns an ArrayList of DataSets that have been split from the original into datasets of a maximum size. The last dataset in the list returned may have fewer rows than the max, representing the remainder left after the split.

Parameters:

maxRows - The maximum size of any returned dataset

Returns:

ArrayList of datasets comprising all the orignial rows split into datasets of maximum size

getGroupedDataSets

public java.util.ArrayList<DataSet> getGroupedDataSets(java.lang.String columnList)

Returns an ArrayList of DataSets that have been grouped by one or more columns. Usually, you will have sorted the dataset with the same list of columns before calling this method.

Parameters:

columnList - Comma separated list of columns to group by

Returns:

ArrayList of datasets containing identical values for the columns specified. Note that the objects in the new DataSets (and hence modifications to them) refer to the same objects in the original DataSet.

findRow

public int findRow(java.util.HashMap findmap,
                   int start)

Returns the row number of the first row found matching a specified find HashMap.

Parameters:

findmap - java.util.HashMap containing the find criteria. To use this method, create an empty HashMap, use the .put method to add values into the map representing the column and value pair to look for. For example, passing a HashMap that has been populated with filtermap.put( "col1", "XXX" ) will return a the first row found for which the "col1" column contain the value XXX. When finding numbers and dates, it is recommended to use an alternative find syntax since the Map find requires BigDecimal and Calendar objects

start - the row from which to start looking.

Returns:

the row number of the first matching row.

findRow

public int findRow(java.util.HashMap findmap)

Returns the row number of the first row found matching a specified find HashMap.

Parameters:

findmap - java.util.HashMap containing the find criteria. To use this method, create an empty HashMap, use the .put method to add values into the map representing the column and value pair to look for. For example, passing a HashMap that has been populated with filtermap.put( "col1", "XXX" ) will return a the first row found for which the "col1" column contain the value XXX. When finding numbers and dates, it is recommended to use an alternative find syntax since the Map find requires BigDecimal and Calendar objects

Returns:

the row number of the first matching row.

findRow

public int findRow(java.lang.String find)

Deprecated. This method fails to find the row if any column value contains comma, hence it is recommended to use findRow(HashMap findMap) for multiple column-value pairs and for single column-value pair use findRow(String, String).

Returns the row number of the first row found matching a specified find String. If single column-value pair is received it calls findRow(columnId, value), for multiple it works as before

Parameters:

find - comma separated list of find criteria. e.g. "col1=XXX,col2=99,col3=YYY"

Returns:

the row number of the first matching row.

findRow

public int findRow(java.lang.String columnId,
                   java.lang.String value)

Returns the row number of the first row found matching with the value specified with the column.

Parameters:

columnId: - Column name

value: - Column value

Returns:

the row number of the first matching row.

renameColumn

public void renameColumn(java.lang.String oldColumnid,
                         java.lang.String newColumnid)

Rename a column

Parameters:

oldColumnid - the name of the old column

newColumnid - the name of the new column

removeColumn

public void removeColumn(java.lang.String oldColumnid)

getIndex

public com.labvantage.sapphire.DataSetIndex getIndex()

Get index for this data set.

Returns:

Index, never null

isIndexing

public boolean isIndexing()

Check if any column is indexed.

Returns:

Flag indicating if any column is indexed in this data set

isIndexing

public boolean isIndexing(java.lang.String column)

Check if column is indexed.

Parameters:

column - Column to check, null not permitted

Returns:

Flag indicating if column is indexed

useIndex

public boolean useIndex(java.util.HashMap filter)

Check if filtering data set with given filter would benefit from using indexing.

Parameters:

filter - Filter to check, null not permitted

Returns:

Flag indicating if any column in filter is indexed

setKeyColumns

public void setKeyColumns(java.lang.String columnIds)

Set key columns of this data set.

Parameters:

columnIds - Column ids in semicolon separated list, null not permitted

setKeyColumns

public void setKeyColumns(java.util.Set<java.lang.String> columnIds)

Set key columns of this data set.

Parameters:

columnIds - Column id set, null not permitted

getKeyColumnSet

public java.util.Set<java.lang.String> getKeyColumnSet()

Get list of key columns of this data set.

Returns:

List of key column, never null

isMasked

public boolean isMasked(int row,
                        java.lang.String columnid)

Checks if the value in the specified row and column is applicable for data masking when being accessed by the getValue method.

Parameters:

row - the row containing the value to check.

columnid - the column containing the value to check.

Returns:

true if the value is a null object or is an empty string if a String column.

setMaskedString

public boolean setMaskedString(int row,
                               java.lang.String columnid,
                               java.lang.String value)

Sets the Masked value of the requested cell.

Parameters:

row -

columnid -

value -

Returns: