Interface TabularData

public Object[] calculateIndex(CompositeData val)

Calculates the index the specified CompositeData value would have, if it was to be added to this TabularData instance. This method includes a check that the type of the given value is the same as the row type of this instance, but not a check for existing instances of the given value. The value must also not be null. Possible indices are returned by the TabularType.getIndexNames() method of this instance's tabular type. The returned indices are the values of the fields in the supplied CompositeData instance that match the names given in the TabularType.

Parameters:

val - the CompositeData value whose index should be calculated.

Returns:

the index the value would take on, if it were to be added.

Throws:

NullPointerException - if the value is null.

InvalidOpenTypeException - if the value does not match the row type of this instance.

public void clear()

Removes all CompositeData values from the table.

public boolean containsKey(Object[] key)

Returns true iff this instance of the TabularData class contains a CompositeData value at the specified index. In any other circumstance, including if the given key is null or of the incorrect type, according to the TabularType of this instance, this method returns false.

Parameters:

key - the key to test for.

Returns:

true if the key maps to a CompositeData value.

public boolean containsValue(CompositeData val)

Returns true iff this instance of the TabularData class contains the specified CompositeData value. In any other circumstance, including if the given value is null or of the incorrect type, according to the TabularType of this instance, this method returns false.

Parameters:

val - the value to test for.

Returns:

true if the value exists.

public boolean equals(Object obj)

Compares the specified object with this object for equality. The object is judged equivalent if it is non-null, and also an instance of TabularData with the same row type, and CompositeData values. The two compared instances may be equivalent even if they represent different implementations of TabularData.

Overrides:

equals in interface Object

Parameters:

obj - the object to compare for equality.

Returns:

true if obj is equal to this.

public CompositeData get(Object[] key)

Retrieves the CompositeData value for the specified key, or null if no such mapping exists.

Parameters:

key - the key whose value should be returned.

Returns:

the matching CompositeData value, or null if one does not exist.

Throws:

NullPointerException - if the key is null.

InvalidKeyException - if the key does not match the TabularType of this instance.

public TabularType getTabularType()

Returns the tabular type which corresponds to this instance of TabularData.

Returns:

the tabular type for this instance.

public int hashCode()

Returns the hash code of the composite data type. This is computed as the sum of the hash codes of each value, together with the hash code of the tabular type. These are the same elements of the type that are compared as part of the equals(Object) method, thus ensuring that the hashcode is compatible with the equality test.

Overrides:

hashCode in interface Object

Returns:

the hash code of this instance.

public boolean isEmpty()

Returns true if this TabularData instance contains no CompositeData values.

Returns:

true if the instance is devoid of rows.

public Set keySet()

Returns a Set view of the keys or indices of this TabularData instance.

Returns:

a set containing the keys of this instance.

public void put(CompositeData val)

Adds the specified CompositeData value to the table. The value must be non-null, of the same type as the row type of this instance, and must not have the same index as an existing value. The index is calculated using the index names of the TabularType for this instance.

Parameters:

val - the CompositeData value to add.

Throws:

NullPointerException - if val is null.

InvalidOpenTypeException - if the type of the given value does not match the row type.

KeyAlreadyExistsException - if the value has the same calculated index as an existing value.

public void putAll(CompositeData[] vals)

Adds each of the specified CompositeData values to the table. Each element of the array must meet the conditions given for the put(CompositeData) method. In addition, the index of each value in the array must be distinct from the index of the other values in the array, as well as from the existing values in the table. The operation should be atomic; if one value can not be added, then none of the values should be. If the array is null or empty, the method simply returns.

Parameters:

vals - the CompositeData values to add.

Throws:

NullPointerException - if a value from the array is null.

InvalidOpenTypeException - if the type of a given value does not match the row type.

KeyAlreadyExistsException - if a value has the same calculated index as an existing value or of one of the other specified values.

public CompositeData remove(Object[] key)

Removes the CompositeData value located at the specified index. null is returned if the value does not exist. Otherwise, the removed value is returned.

Parameters:

key - the key of the value to remove.

Returns:

the removed value, or null if there is no value for the given key.

Throws:

NullPointerException - if the key is null.

InvalidOpenTypeException - if the key does not match the TabularType of this instance.

public int size()

Returns the number of CompositeData values or rows in the table.

Returns:

the number of rows in the table.

public String toString()

Returns a textual representation of this instance. The exact format is left up to the implementation, but it should contain the name of the implementing class and the tabular type.

Overrides:

toString in interface Object

Returns:

a String representation of the object.

public Collection values()

Returns the values associated with this instance.

Returns:

the values of this instance.