Interface TabularData
- All Known Implementing Classes:
TabularDataSupport
public interface TabularData
The TabularData
interface specifies the behavior of a specific type of complex open data objects which represent tabular data structures.
- Since:
- 1.5
Method Summary
Modifier and Type | Method | Description |
---|---|---|
Object[] | calculateIndex(CompositeData value) | Calculates the index that would be used in this |
void | clear() | Removes all |
boolean | containsKey(Object[] key) | Returns |
boolean | containsValue(CompositeData value) | Returns |
boolean | equals(Object obj) | Compares the specified obj parameter with this |
CompositeData | get(Object[] key) | Returns the |
TabularType | getTabularType() | Returns the tabular type describing this |
int | hashCode() | Returns the hash code value for this |
boolean | isEmpty() | Returns |
Set<?> | keySet() | Returns a set view of the keys (ie the index values) of the |
void | put(CompositeData value) | Adds value to this |
void | putAll(CompositeData[] values) | Add all the elements in values to this |
CompositeData | remove(Object[] key) | Removes the |
int | size() | Returns the number of |
String | toString() | Returns a string representation of this |
Collection<?> | values() | Returns a collection view of the |
Method Detail
getTabularType
TabularType getTabularType()
Returns the tabular type describing this TabularData
instance.
- Returns:
- the tabular type.
calculateIndex
Object[] calculateIndex(CompositeData value)
Calculates the index that would be used in this TabularData
instance to refer to the specified composite data value parameter if it were added to this instance. This method checks for the type validity of the specified value, but does not check if the calculated index is already used to refer to a value in this TabularData
instance.
- Parameters:
-
value
- the composite data value whose index in thisTabularData
instance is to be calculated; must be of the same composite type as this instance's row type; must not be null. - Returns:
- the index that the specified value would have in this
TabularData
instance. - Throws:
-
NullPointerException
- if value isnull
-
InvalidOpenTypeException
- if value does not conform to thisTabularData
instance's row type definition.
size
int size()
Returns the number of CompositeData
values (ie the number of rows) contained in this TabularData
instance.
- Returns:
- the number of values contained.
isEmpty
boolean isEmpty()
Returns true
if the number of CompositeData
values (ie the number of rows) contained in this TabularData
instance is zero.
- Returns:
- true if this
TabularData
is empty.
containsKey
boolean containsKey(Object[] key)
Returns true
if and only if this TabularData
instance contains a CompositeData
value (ie a row) whose index is the specified key. If key is null
or does not conform to this TabularData
instance's TabularType
definition, this method simply returns false
.
- Parameters:
-
key
- the index value whose presence in thisTabularData
instance is to be tested. - Returns:
-
true
if thisTabularData
indexes a row value with the specified key.
containsValue
boolean containsValue(CompositeData value)
Returns true
if and only if this TabularData
instance contains the specified CompositeData
value. If value is null
or does not conform to this TabularData
instance's row type definition, this method simply returns false
.
- Parameters:
-
value
- the row value whose presence in thisTabularData
instance is to be tested. - Returns:
-
true
if thisTabularData
instance contains the specified row value.
get
CompositeData get(Object[] key)
Returns the CompositeData
value whose index is key, or null
if there is no value mapping to key, in this TabularData
instance.
- Parameters:
-
key
- the key of the row to return. - Returns:
- the value corresponding to key.
- Throws:
-
NullPointerException
- if the key isnull
-
InvalidKeyException
- if the key does not conform to thisTabularData
instance's *TabularType
definition
put
void put(CompositeData value)
Adds value to this TabularData
instance. The composite type of value must be the same as this instance's row type (ie the composite type returned by this.getTabularType().
), and there must not already be an existing value in this getRowType()
TabularData
instance whose index is the same as the one calculated for the value to be added. The index for value is calculated according to this TabularData
instance's TabularType
definition (see TabularType.
).getIndexNames()
- Parameters:
-
value
- the composite data value to be added as a new row to thisTabularData
instance; must be of the same composite type as this instance's row type; must not be null. - Throws:
-
NullPointerException
- if value isnull
-
InvalidOpenTypeException
- if value does not conform to thisTabularData
instance's row type definition. -
KeyAlreadyExistsException
- if the index for value, calculated according to thisTabularData
instance'sTabularType
definition already maps to an existing value in the underlying HashMap.
remove
CompositeData remove(Object[] key)
Removes the CompositeData
value whose index is key from this TabularData
instance, and returns the removed value, or returns null
if there is no value whose index is key.
- Parameters:
-
key
- the index of the value to get in thisTabularData
instance; must be valid with thisTabularData
instance's row type definition; must not be null. - Returns:
- previous value associated with specified key, or
null
if there was no mapping for key. - Throws:
-
NullPointerException
- if the key isnull
-
InvalidKeyException
- if the key does not conform to thisTabularData
instance'sTabularType
definition
putAll
void putAll(CompositeData[] values)
Add all the elements in values to this TabularData
instance. If any element in values does not satisfy the constraints defined in put
, or if any two elements in values have the same index calculated according to this TabularData
instance's TabularType
definition, then an exception describing the failure is thrown and no element of values is added, thus leaving this TabularData
instance unchanged.
- Parameters:
-
values
- the array of composite data values to be added as new rows to thisTabularData
instance; if values isnull
or empty, this method returns without doing anything. - Throws:
-
NullPointerException
- if an element of values isnull
-
InvalidOpenTypeException
- if an element of values does not conform to thisTabularData
instance's row type definition -
KeyAlreadyExistsException
- if the index for an element of values, calculated according to thisTabularData
instance'sTabularType
definition already maps to an existing value in this instance, or two elements of values have the same index.
clear
void clear()
Removes all CompositeData
values (ie rows) from this TabularData
instance.
keySet
Set<?> keySet()
Returns a set view of the keys (ie the index values) of the CompositeData
values (ie the rows) contained in this TabularData
instance. The returned Set
is a Set<List<?>>
but is declared as a Set<?>
for compatibility reasons. The returned set can be used to iterate over the keys.
- Returns:
- a set view (
Set<List<?>>
) of the index values used in thisTabularData
instance.
values
Collection<?> values()
Returns a collection view of the CompositeData
values (ie the rows) contained in this TabularData
instance. The returned Collection
is a Collection<CompositeData>
but is declared as a Collection<?>
for compatibility reasons. The returned collection can be used to iterate over the values.
- Returns:
- a collection view (
Collection<CompositeData>
) of the rows contained in thisTabularData
instance.
equals
boolean equals(Object obj)
Compares the specified obj parameter with this TabularData
instance for equality.
Returns true
if and only if all of the following statements are true:
- obj is non null,
-
obj also implements the
TabularData
interface, - their row types are equal
- their contents (ie index to value mappings) are equal
equals
method works properly for obj parameters which are different implementations of the TabularData
interface. - Overrides:
-
equals
in classObject
- Parameters:
-
obj
- the object to be compared for equality with thisTabularData
instance; - Returns:
-
true
if the specified object is equal to thisTabularData
instance. - See Also:
-
Object.hashCode()
,HashMap
hashCode
int hashCode()
Returns the hash code value for this TabularData
instance.
The hash code of a TabularData
instance is the sum of the hash codes of all elements of information used in equals
comparisons (ie: its tabular type and its content, where the content is defined as all the index to value mappings).
This ensures that t1.equals(t2)
implies that t1.hashCode()==t2.hashCode()
for any two TabularDataSupport
instances t1
and t2
, as required by the general contract of the method Object.hashCode()
.
- Overrides:
-
hashCode
in classObject
- Returns:
- the hash code value for this
TabularDataSupport
instance - See Also:
-
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
toString
String toString()
Returns a string representation of this TabularData
instance.
The string representation consists of the name of the implementing class, and the tabular type of this instance.