|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TabularData
Provides an interface to a specific type of composite
data structure, where keys (the columns) map to the
CompositeData
objects that form the rows of
the table.
Method Summary | |
---|---|
Object[] |
calculateIndex(CompositeData val)
Calculates the index the specified CompositeData value
would have, if it was to be added to this TabularData
instance. |
void |
clear()
Removes all CompositeData values from the table. |
boolean |
containsKey(Object[] key)
Returns true iff this instance of the TabularData class
contains a CompositeData value at the specified index. |
boolean |
containsValue(CompositeData val)
Returns true iff this instance of the TabularData class
contains the specified CompositeData value. |
boolean |
equals(Object obj)
Compares the specified object with this object for equality. |
CompositeData |
get(Object[] key)
Retrieves the CompositeData value for the specified
key, or null if no such mapping exists. |
TabularType |
getTabularType()
Returns the tabular type which corresponds to this instance of TabularData . |
int |
hashCode()
Returns the hash code of the composite data type. |
boolean |
isEmpty()
Returns true if this TabularData instance
contains no CompositeData values. |
Set<?> |
keySet()
Returns a Set view of the keys or
indices of this TabularData instance. |
void |
put(CompositeData val)
Adds the specified CompositeData value to the
table. |
void |
putAll(CompositeData[] vals)
Adds each of the specified CompositeData values
to the table. |
CompositeData |
remove(Object[] key)
Removes the CompositeData value located at the
specified index. |
int |
size()
Returns the number of CompositeData values or rows
in the table. |
String |
toString()
Returns a textual representation of this instance. |
Collection<?> |
values()
Returns the values associated with this instance. |
Method Detail |
---|
Object[] calculateIndex(CompositeData val)
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
.
val
- the CompositeData
value whose index should
be calculated.
NullPointerException
- if the value is null
.
InvalidOpenTypeException
- if the value does not match the
row type of this instance.void clear()
CompositeData
values from the table.
boolean containsKey(Object[] key)
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.
key
- the key to test for.
CompositeData
value.boolean containsValue(CompositeData val)
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.
val
- the value to test for.
boolean equals(Object obj)
TabularData
with the same row type,
and CompositeData
values. The two compared instances may
be equivalent even if they represent different implementations
of TabularData
.
equals
in class Object
obj
- the object to compare for equality.
obj
is equal to this
.Object.hashCode()
CompositeData get(Object[] key)
CompositeData
value for the specified
key, or null
if no such mapping exists.
key
- the key whose value should be returned.
CompositeData
value, or
null
if one does not exist.
NullPointerException
- if the key is null
.
InvalidKeyException
- if the key does not match
the TabularType
of this
instance.TabularType getTabularType()
TabularData
.
int hashCode()
equals(java.lang.Object)
method, thus ensuring that the
hashcode is compatible with the equality test.
hashCode
in class Object
Object.equals(Object)
,
System.identityHashCode(Object)
boolean isEmpty()
TabularData
instance
contains no CompositeData
values.
Set<?> keySet()
Set
view of the keys or
indices of this TabularData
instance.
void put(CompositeData val)
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.
val
- the CompositeData
value to add.
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.void putAll(CompositeData[] vals)
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.
vals
- the CompositeData
values to add.
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.CompositeData remove(Object[] key)
CompositeData
value located at the
specified index. null
is returned if the
value does not exist. Otherwise, the removed value is
returned.
key
- the key of the value to remove.
null
if
there is no value for the given key.
NullPointerException
- if the key is null
.
InvalidOpenTypeException
- if the key does not match
the TabularType
of this
instance.int size()
CompositeData
values or rows
in the table.
String toString()
toString
in class Object
String
representation of the
object.Object.getClass()
,
Object.hashCode()
,
Class.getName()
,
Integer.toHexString(int)
Collection<?> values()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |