sapphire.util

Class DataStore

java.lang.Object

sapphire.util.DataStore

All Implemented Interfaces:

java.io.Serializable

public class DataStore
extends java.lang.Object
implements java.io.Serializable

This class wraps a dataset class and tracks the state of rows - whether they are added, updated or deleted. This class exposes most of the methods of the wrapped DataSet and tracks the row status as the methods are called. The status of a row can be fetched using isRowInsert and isRowUpdate methods. A DataSet of all added, modified or deleted row can be fetched using the getInsertDataSet(), getUpdateDataSet() and getDeleteDataSet() methods.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	INSERT Constant indicating the row was inserted
static int	UPDATE Constant indicating the row was updated

Constructor Summary

Constructors

Constructor and Description
DataStore(DataSet dataSet) Constructs a new DataStore, wrapping the provided DataSet.
DataStore(JsonObject jso) Constructs a new DataStore that was previously serialized with .toJsonObject()
DataStore(JsonObject jso, com.labvantage.sapphire.services.ConnectionInfo connectionInfo)

Method Summary

Modifier and Type	Method and Description
boolean	addColumn(java.lang.String columnid, int type) See documentation for the DataSet class for details of this method.
int	addRow() Adds a new row to the end of the dataset.
int	addRow(int newrow) Adds a new row as a specified position in the dataset.
static java.lang.String	convertDateToUserFormat(java.lang.String dateVal, M18NUtil userM18NUtil, boolean isTimeZoneIndependent, boolean isDateOnly)
void	deleteRow(int row) Deletes the specified row from the wrapped dataset.
int	findRow(java.util.HashMap findmap) See documentation for the DataSet class for details of this method.
int	findRow(java.util.HashMap findmap, int start) See documentation for the DataSet class for details of this method.
int	findRow(java.lang.String columnId, java.lang.String value) See documentation for the DataSet class for details of this method.
java.math.BigDecimal	getBigDecimal(int row, java.lang.String columnid) See documentation for the DataSet class for details of this method.
java.math.BigDecimal	getBigDecimal(int row, java.lang.String columnid, java.math.BigDecimal defaultvalue) See documentation for the DataSet class for details of this method.
java.util.Calendar	getCalendar(int row, java.lang.String columnid) See documentation for the DataSet class for details of this method.
java.util.Calendar	getCalendar(int row, java.lang.String columnid, java.util.Calendar defaultvalue) See documentation for the DataSet class for details of this method.
int	getColumnCount() See documentation for the DataSet class for details of this method.
java.lang.String[]	getColumns() See documentation for the DataSet class for details of this method.
int	getColumnType(java.lang.String columnid) See documentation for the DataSet class for details of this method.
java.lang.String	getColumnValues(java.lang.String columnid, int startrow, int endrow, java.lang.String delimeter) See documentation for the DataSet class for details of this method.
DataSet	getDataSet() Returns the wrapped dataset Note: This returned dataset should only be used for reading data passively.
java.text.DateFormat	getDateDisplayFormat(java.lang.String columnid) See documentation for the DataSet class for details of this method.
DataSet	getDeleteDataSet() Returns a dataset comprising those rows that were deleted
double	getDouble(int row, java.lang.String columnid) See documentation for the DataSet class for details of this method.
double	getDouble(int row, java.lang.String columnid, double defaultvalue) See documentation for the DataSet class for details of this method.
JsonArray	getEncryptedColumns()
DataSet	getFilteredDataSet(java.util.HashMap filtermap) See documentation for the DataSet class for details of this method.
DataSet	getFilteredDataSet(java.util.HashMap filtermap, boolean exclusive) See documentation for the DataSet class for details of this method.
java.util.ArrayList<DataSet>	getGroupedDataSets(java.lang.String columnList) See documentation for the DataSet class for details of this method.
DataSet	getInsertDataSet() Returns a dataset comprising only those rows that were inserted
int	getInt(int row, java.lang.String columnid) See documentation for the DataSet class for details of this method.
int	getInt(int row, java.lang.String columnid, int defaultvalue) See documentation for the DataSet class for details of this method.
long	getLong(int row, java.lang.String columnid) See documentation for the DataSet class for details of this method.
M18NUtil	getM18n() See documentation for the DataSet class for details of this method.
java.lang.Object	getObject(int row, java.lang.String columnid) See documentation for the DataSet class for details of this method.
int	getRowCount() See documentation for the DataSet class for details of this method.
java.lang.String	getString(int row, java.lang.String columnid) See documentation for the DataSet class for details of this method.
java.lang.String	getString(int row, java.lang.String columnid, java.lang.String defaultvalue) See documentation for the DataSet class for details of this method.
DataSet	getUnlinkDataSet() Returns a dataset comprising those rows that were unlinked
DataSet	getUpdateDataSet() Returns a dataset comprising only those rows that were updated
java.lang.String	getValue(int row, java.lang.String columnid) See documentation for the DataSet class for details of this method.
java.lang.String	getValue(int row, java.lang.String columnid, java.lang.String nullvalue) See documentation for the DataSet class for details of this method.
boolean	isNull(int row, java.lang.String columnid) See documentation for the DataSet class for details of this method.
boolean	isRowInsert(int row) Returns whether the specified row has been inserted
boolean	isRowUpdate(int row) Returns whether the specified row has been updated
void	reset()
void	setConnectionInfo(com.labvantage.sapphire.services.ConnectionInfo connectionInfo) See documentation for the DataSet class for details of this method.
boolean	setDate(int row, java.lang.String columnid, java.util.Calendar value) See documentation for the DataSet class for details of this method.
boolean	setDate(int row, java.lang.String columnid, long value) See documentation for the DataSet class for details of this method.
boolean	setDate(int row, java.lang.String columnid, java.lang.String value) See documentation for the DataSet class for details of this method.
boolean	setDate(int row, java.lang.String columnid, java.sql.Timestamp value) See documentation for the DataSet class for details of this method.
void	setEncrypted(java.lang.String columnid)
void	setM18NUtil(M18NUtil m18NUtil) See documentation for the DataSet class for details of this method.
boolean	setNumber(int row, java.lang.String columnid, java.math.BigDecimal value) See documentation for the DataSet class for details of this method.
boolean	setNumber(int row, java.lang.String columnid, double value) See documentation for the DataSet class for details of this method.
boolean	setNumber(int row, java.lang.String columnid, int value) See documentation for the DataSet class for details of this method.
boolean	setNumber(int row, java.lang.String columnid, long value) See documentation for the DataSet class for details of this method.
boolean	setNumber(int row, java.lang.String columnid, java.lang.String value) See documentation for the DataSet class for details of this method.
boolean	setObject(int row, java.lang.String columnid, java.lang.Object o) See documentation for the DataSet class for details of this method.
void	setRowInsert(int row) Can be used to flag that a row has been Inserted
void	setRowUpdate(int row) Can be used to flag that a row has been Updated
boolean	setSequence(java.lang.String columnid) See documentation for the DataSet class for details of this method.
boolean	setString(int row, java.lang.String columnid, java.lang.String value) See documentation for the DataSet class for details of this method.
void	setTimeZoneInsensitive(java.lang.String columnid) See documentation for the DataSet class for details of this method.
boolean	setValue(int row, java.lang.String columnid, java.lang.String value) See documentation for the DataSet class for details of this method.
int	size() See documentation for the DataSet class for details of this method.
void	sort(java.lang.String sortstring) See documentation for the DataSet class for details of this method.
JsonObject	toJsonObject() Serialized the DataStore object
JsonObject	toJsonObject(boolean onlyChanges)
JsonObject	toJsonObject(boolean onlyChanges, boolean optimizedFormat, boolean includeClobs, boolean includeUnknows)
JsonObject	toJsonObject(boolean onlyChanges, boolean optimizedFormat, java.lang.String[] columns, boolean includeClobs, boolean includeUnknows)
void	unlinkRow(int row) Unlinks the specified row from the wrapped dataset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSERT

public static int INSERT

Constant indicating the row was inserted

UPDATE

public static int UPDATE

Constant indicating the row was updated

Constructor Detail

DataStore

public DataStore(DataSet dataSet)

Constructs a new DataStore, wrapping the provided DataSet. Note that pre-existing rows in the dataset do NOT pick up an Insert status. Only rows inserted (or updated) via methods in this class get flagged.

DataStore

public DataStore(JsonObject jso)

Constructs a new DataStore that was previously serialized with .toJsonObject()

DataStore

public DataStore(JsonObject jso,
                 com.labvantage.sapphire.services.ConnectionInfo connectionInfo)

Method Detail

convertDateToUserFormat

public static java.lang.String convertDateToUserFormat(java.lang.String dateVal,
                                                       M18NUtil userM18NUtil,
                                                       boolean isTimeZoneIndependent,
                                                       boolean isDateOnly)
                                                throws java.text.ParseException

Throws:

java.text.ParseException

toJsonObject

public JsonObject toJsonObject()
                        throws SapphireException

Serialized the DataStore object

Throws:

SapphireException

toJsonObject

public JsonObject toJsonObject(boolean onlyChanges)
                        throws SapphireException

Throws:

SapphireException

toJsonObject

public JsonObject toJsonObject(boolean onlyChanges,
                               boolean optimizedFormat,
                               boolean includeClobs,
                               boolean includeUnknows)

toJsonObject

public JsonObject toJsonObject(boolean onlyChanges,
                               boolean optimizedFormat,
                               java.lang.String[] columns,
                               boolean includeClobs,
                               boolean includeUnknows)

setRowInsert

public void setRowInsert(int row)

Can be used to flag that a row has been Inserted

setRowUpdate

public void setRowUpdate(int row)

Can be used to flag that a row has been Updated

isRowInsert

public boolean isRowInsert(int row)

Returns whether the specified row has been inserted

isRowUpdate

public boolean isRowUpdate(int row)

Returns whether the specified row has been updated

getDataSet

public DataSet getDataSet()

Returns the wrapped dataset Note: This returned dataset should only be used for reading data passively. Modifying, adding or deleting rows on the dataset directly will result in incorrect status tracking.

getInsertDataSet

public DataSet getInsertDataSet()

Returns a dataset comprising only those rows that were inserted

getUpdateDataSet

public DataSet getUpdateDataSet()

Returns a dataset comprising only those rows that were updated

getDeleteDataSet

public DataSet getDeleteDataSet()

Returns a dataset comprising those rows that were deleted

deleteRow

public void deleteRow(int row)

Deletes the specified row from the wrapped dataset. Note that if the row has an Insert status, it is permanently deleted. Otherwise, the row is retained separately, and can be fetched using the getDeleteDataSet() method.

getUnlinkDataSet

public DataSet getUnlinkDataSet()

Returns a dataset comprising those rows that were unlinked

unlinkRow

public void unlinkRow(int row)

Unlinks the specified row from the wrapped dataset. Note that if the row has an Insert status, it is deleted. Otherwise, the row is retained separately, and can be fetched using the getUnlinkDataSet() method.

addRow

public int addRow()

Adds a new row to the end of the dataset. The row is flagged with an Insert status.

addRow

public int addRow(int newrow)

Adds a new row as a specified position in the dataset. The row is flagged with an Insert status.

getRowCount

public int getRowCount()

See documentation for the DataSet class for details of this method.

size

public int size()

See documentation for the DataSet class for details of this method.

addColumn

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

See documentation for the DataSet class for details of this method.

getColumnCount

public int getColumnCount()

See documentation for the DataSet class for details of this method.

getColumns

public java.lang.String[] getColumns()

See documentation for the DataSet class for details of this method.

getColumnType

public int getColumnType(java.lang.String columnid)

See documentation for the DataSet class for details of this method.

getColumnValues

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

See documentation for the DataSet class for details of this method.

setObject

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

See documentation for the DataSet class for details of this method.

setString

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

See documentation for the DataSet class for details of this method.

setNumber

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

See documentation for the DataSet class for details of this method.

setNumber

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

See documentation for the DataSet class for details of this method.

setNumber

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

See documentation for the DataSet class for details of this method.

setNumber

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

See documentation for the DataSet class for details of this method.

setNumber

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

See documentation for the DataSet class for details of this method.

setDate

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

See documentation for the DataSet class for details of this method.

setDate

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

See documentation for the DataSet class for details of this method.

setDate

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

See documentation for the DataSet class for details of this method.

setDate

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

See documentation for the DataSet class for details of this method.

setValue

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

See documentation for the DataSet class for details of this method.

getDateDisplayFormat

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

See documentation for the DataSet class for details of this method.

setTimeZoneInsensitive

public void setTimeZoneInsensitive(java.lang.String columnid)

See documentation for the DataSet class for details of this method.

setM18NUtil

public void setM18NUtil(M18NUtil m18NUtil)

See documentation for the DataSet class for details of this method.

getM18n

public M18NUtil getM18n()

See documentation for the DataSet class for details of this method.

setConnectionInfo

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

See documentation for the DataSet class for details of this method.

setSequence

public boolean setSequence(java.lang.String columnid)

See documentation for the DataSet class for details of this method.

getString

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

See documentation for the DataSet class for details of this method.

getString

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

See documentation for the DataSet class for details of this method.

getBigDecimal

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

See documentation for the DataSet class for details of this method.

getBigDecimal

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

See documentation for the DataSet class for details of this method.

getDouble

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

See documentation for the DataSet class for details of this method.

getDouble

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

See documentation for the DataSet class for details of this method.

getInt

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

See documentation for the DataSet class for details of this method.

getInt

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

See documentation for the DataSet class for details of this method.

getLong

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

See documentation for the DataSet class for details of this method.

getCalendar

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

See documentation for the DataSet class for details of this method.

getCalendar

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

See documentation for the DataSet class for details of this method.

getObject

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

See documentation for the DataSet class for details of this method.

getValue

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

See documentation for the DataSet class for details of this method.

getValue

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

See documentation for the DataSet class for details of this method.

isNull

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

See documentation for the DataSet class for details of this method.

sort

public void sort(java.lang.String sortstring)

See documentation for the DataSet class for details of this method.

getFilteredDataSet

public DataSet getFilteredDataSet(java.util.HashMap filtermap)

See documentation for the DataSet class for details of this method.

getFilteredDataSet

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

See documentation for the DataSet class for details of this method.

getGroupedDataSets

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

See documentation for the DataSet class for details of this method.

findRow

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

See documentation for the DataSet class for details of this method.

findRow

public int findRow(java.util.HashMap findmap)

See documentation for the DataSet class for details of this method.

findRow

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

See documentation for the DataSet class for details of this method.

setEncrypted

public void setEncrypted(java.lang.String columnid)

getEncryptedColumns

public JsonArray getEncryptedColumns()

reset

public void reset()