com.hcl.voltmx.middleware.dataobject

Class Dataset

java.lang.Object

com.hcl.voltmx.middleware.dataobject.Dataset

All Implemented Interfaces:

Serializable

public class Dataset
extends Object
implements Serializable

A Dataset is list of Records, identified using an unique id.

See Also:

Record, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	index Deprecated. As of Foundry 7.3.2, instead use getIndex() or setIndex(int).

Constructor Summary

Constructors

Constructor and Description
Dataset() Creates an empty Dataset.
Dataset(String id) Creates an empty Dataset with given id.

Method Summary

Modifier and Type	Method and Description
void	addAllRecords(Collection<Record> recordsToAdd) Adds all the Records to the Dataset.
void	addRecord(Record record) Adds a Record to the Dataset.
List<Record>	getAllRecords() Gets the read-only list of Records contained in the Dataset.
String	getId() Gets the unique id of the Dataset.
int	getIndex() Gets the index of the Dataset.
Record	getRecord(int indexToGet) Gets the Record at the specified index from the list of Records contained in the Dataset.
Record	getRecordOrder(int order) Deprecated. As of Foundry 7.3.2, this method is redundant as order is not used anymore. To get Record by index, use getRecord(int).
ArrayList<Record>	getRecords() Deprecated. As of Foundry 7.3.2, instead use getAllRecords().
void	setId(String id) Sets the id for the Dataset.
void	setIndex(int index) Sets the index for the Dataset.
void	setRecord(Record record) Deprecated. As of Foundry 7.3.2, instead use addRecord(Record).
void	setRecords(ArrayList<Record> records) Deprecated. As of Foundry 7.3.2, instead use addAllRecords(Collection).
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

index

@Deprecated
public int index

Deprecated. As of Foundry 7.3.2, instead use getIndex() or setIndex(int).

The index of the Dataset in its parent.

Constructor Detail

Dataset

public Dataset()

Creates an empty Dataset.

Dataset

public Dataset(String id)

Creates an empty Dataset with given id.

Parameters:

id - The given id

Method Detail

getId

public String getId()

Gets the unique id of the Dataset.

Returns:

The unique id

setId

public void setId(String id)

Sets the id for the Dataset.

Parameters:

id - The id to set

getIndex

public int getIndex()

Gets the index of the Dataset.

Returns:

The index

Since:

Foundry 7.3.2

setIndex

public void setIndex(int index)

Sets the index for the Dataset.

Parameters:

index - The index to set

Since:

Foundry 7.3.2

getRecords

@Deprecated
public ArrayList<Record> getRecords()

Deprecated. As of Foundry 7.3.2, instead use getAllRecords().

Gets the list of Records contained in the Dataset.

Returns:

The list of Records

See Also:

Record

getAllRecords

public List<Record> getAllRecords()

Gets the read-only list of Records contained in the Dataset.

Returns:

The read-only list of Records

Since:

Foundry 7.3.2

See Also:

Record

setRecords

@Deprecated
public void setRecords(ArrayList<Record> records)

Deprecated. As of Foundry 7.3.2, instead use addAllRecords(Collection).

Sets the list of Records in the Dataset, overwriting any previous list of Records.

Parameters:

records - The list of Records to set

See Also:

Record

setRecord

@Deprecated
public void setRecord(Record record)

Deprecated. As of Foundry 7.3.2, instead use addRecord(Record).

Adds a Record to the Dataset.

Parameters:

record - The Record to add

See Also:

Record

addRecord

public void addRecord(Record record)

Adds a Record to the Dataset.

Parameters:

record - The Record to add

Since:

Foundry 7.3.2

See Also:

Record

addAllRecords

public void addAllRecords(Collection<Record> recordsToAdd)

Adds all the Records to the Dataset.

Parameters:

recordsToAdd - The Records to add

Since:

Foundry 7.3.2

See Also:

Record

getRecord

public Record getRecord(int indexToGet)

Gets the Record at the specified index from the list of Records contained in the Dataset.

Parameters:

indexToGet - The index to get

Returns:

The Record corresponding to index. If index is out of range, this returns null.

See Also:

Record

getRecordOrder

@Deprecated
public Record getRecordOrder(int order)

Deprecated. As of Foundry 7.3.2, this method is redundant as order is not used anymore. To get Record by index, use getRecord(int).

Gets the Record with the specified order from the list of Records contained in the Dataset.

Parameters:

order - The order

Returns:

The Record with specified order. If no matching record found, this returns null.

See Also:

Record

toString

public String toString()

Overrides:

toString in class Object