DataSet

Inheritance: java.lang.Object

public class DataSet

Represents an in-memory cache of data.

Constructors

Constructor	Description
DataSet()	Initializes a new instance of the DataSet class.
DataSet(Connection connection)	Initializes a new instance of the DataSet class with data taken from Connection.
DataSet(Connection connection, String schemaName)	Initializes a new instance of the DataSet class with data taken from Connection.
DataSet(String dataSetName)	Initializes a new instance of a DataSet class with the given name.

Methods

Method	Description
IsSchemaWasRead()
clear()	Clears the DataSet of any data by removing all rows in all tables.
close()
getDataSetName()	Gets the name of the current DataSet.
getEnforceConstraints()	Gets a value indicating whether constraint rules are followed when attempting any update operation.
getNamespace()	Gets the namespace of the DataSet.
getRelations()	Get the collection of relations that link tables and allow navigation from parent tables to child tables.
getTables()	Gets the collection of tables contained in the DataSet.
isLocaleSpecified()
readXml(InputStream stream)	Reads XML schema and data into the DataSet using the specified java.io.InputStream.
readXml(InputStream xmlStream, System.Data.XmlReadMode mode)	Reads XML schema and data into the DataSet using the specified java.io.InputStream and XmlReadMode.
readXml(String fileName)	Reads XML schema and data into the DataSet using the specified file.
readXml(String xmlPath, System.Data.XmlReadMode readMode)	Reads XML schema and data into the DataSet using the specified file and XmlReadMode.
readXmlSchema(InputStream stream)	Reads the XML schema from the specified java.io.InputStream into the DataSet.
readXmlSchema(String fileName)	Reads the XML schema from the specified file into the DataSet.
reset()	Resets the DataSet to its original state.
setDataSetName(String value)	Sets the name of the current DataSet.
setEnforceConstraints(boolean value)	Sets a value indicating whether constraint rules are followed when attempting any update operation.
setLocale(Locale locale)	Sets the locale information used to compare strings within the table.

DataSet()

public DataSet()

Initializes a new instance of the DataSet class.

DataSet(Connection connection)

public DataSet(Connection connection)

Initializes a new instance of the DataSet class with data taken from Connection. Tables, Relations, Constraints and Indexes will be copied into DataSet.

By default no schema name will be used.

Parameters:

Parameter	Type	Description
connection	java.sql.Connection	which contains DB data.

DataSet(Connection connection, String schemaName)

public DataSet(Connection connection, String schemaName)

Initializes a new instance of the DataSet class with data taken from Connection. Tables, Relations, Constraints and Indexes will be copied into DataSet.

DataSet dataSet = new DataSet(conn, "PUBLIC"); // HSQLDB

or

DataSet dataSet = new DataSet(conn); // MYSQL's default schema name.

Parameters:

Parameter	Type	Description
connection	java.sql.Connection	which contains DB data.
schemaName	java.lang.String	which contains the tables to be imported.

DataSet(String dataSetName)

public DataSet(String dataSetName)

Initializes a new instance of a DataSet class with the given name.

Parameters:

Parameter	Type	Description
dataSetName	java.lang.String	The name of the DataSet.

IsSchemaWasRead()

public boolean IsSchemaWasRead()

Returns: boolean - true if schema was read

clear()

public void clear()

Clears the DataSet of any data by removing all rows in all tables.

close()

public void close()

getDataSetName()

public String getDataSetName()

Gets the name of the current DataSet.

Returns: java.lang.String - The name of the DataSet.

getEnforceConstraints()

public boolean getEnforceConstraints()

Gets a value indicating whether constraint rules are followed when attempting any update operation.

Returns: boolean - true if rules are enforced; otherwise false. The default is true.

getNamespace()

public String getNamespace()

Gets the namespace of the DataSet.

Returns: java.lang.String - The namespace of the DataSet.

getRelations()

public System.Data.DataRelationCollection getRelations()

Get the collection of relations that link tables and allow navigation from parent tables to child tables.

Returns: DataRelationCollection - A DataRelationCollection that contains a collection of DataRelation objects. An empty collection is returned if no DataRelation objects exist.

getTables()

public System.Data.DataTableCollection getTables()

Gets the collection of tables contained in the DataSet.

Returns: DataTableCollection - The DataTableCollection contained by this DataSet. An empty collection is returned if no DataTable objects exist.

isLocaleSpecified()

public boolean isLocaleSpecified()

Returns: boolean - true if locale was set

readXml(InputStream stream)

public System.Data.XmlReadMode readXml(InputStream stream)

Reads XML schema and data into the DataSet using the specified java.io.InputStream.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	An object that derives from java.io.InputStream.

Returns: XmlReadMode - The XmlReadMode used to read the data. The returned value is one of XmlReadMode constants.

readXml(InputStream xmlStream, System.Data.XmlReadMode mode)

public System.Data.XmlReadMode readXml(InputStream xmlStream, System.Data.XmlReadMode mode)

Reads XML schema and data into the DataSet using the specified java.io.InputStream and XmlReadMode.

Parameters:

Parameter	Type	Description
xmlStream	java.io.InputStream	The Stream from which to read.
mode	XmlReadMode	One of the XmlReadMode values.

Returns: XmlReadMode - The XmlReadMode used to read the data.

readXml(String fileName)

public System.Data.XmlReadMode readXml(String fileName)

Reads XML schema and data into the DataSet using the specified file.

Parameters:

Parameter	Type	Description
fileName	java.lang.String	The filename (including the path) from which to read.

Returns: XmlReadMode - The XmlReadMode used to read the data. The returned value is one of XmlReadMode constants.

readXml(String xmlPath, System.Data.XmlReadMode readMode)

public System.Data.XmlReadMode readXml(String xmlPath, System.Data.XmlReadMode readMode)

Reads XML schema and data into the DataSet using the specified file and XmlReadMode.

Parameters:

Parameter	Type	Description
xmlPath	java.lang.String	the specified file
readMode	XmlReadMode	XmlReadMode

Returns: XmlReadMode - mode which was used while reading

readXmlSchema(InputStream stream)

public void readXmlSchema(InputStream stream)

Reads the XML schema from the specified java.io.InputStream into the DataSet.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The java.io.InputStream from which to read.

readXmlSchema(String fileName)

public void readXmlSchema(String fileName)

Reads the XML schema from the specified file into the DataSet.

Parameters:

Parameter	Type	Description
fileName	java.lang.String	The file name (including the path) from which to read.

reset()

public void reset()

Resets the DataSet to its original state. Subclasses should override reset() to restore a DataSet to its original state.

setDataSetName(String value)

public void setDataSetName(String value)

Sets the name of the current DataSet.

Parameters:

Parameter	Type	Description
value	java.lang.String	The name of the DataSet.

setEnforceConstraints(boolean value)

public void setEnforceConstraints(boolean value)

Sets a value indicating whether constraint rules are followed when attempting any update operation.

Parameters:

Parameter	Type	Description
value	boolean	true if rules are enforced; otherwise false. The default is true.

setLocale(Locale locale)

public void setLocale(Locale locale)

Sets the locale information used to compare strings within the table.

Parameters:

Parameter	Type	Description
locale	java.util.Locale	of this data set