org.openquark.cal.runtime
Interface RecordValue

All Superinterfaces:

Map<FieldName,Object>, SortedMap<FieldName,Object>

public interface RecordValue
extends SortedMap<FieldName,Object>

Represents a CAL record value marshaled to Java in such a way that the field-name information is available along with the field values.

Author:

Bo Ilic

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Object	getField(FieldName fieldName)
int	getNFields()
Object	getOrdinalField(int ordinalFieldName)
Object	getTextualField(String textualFieldName)
boolean	hasField(FieldName fieldName)
boolean	hasOrdinalField(int ordinalFieldName)
boolean	hasTextualField(String textualFieldName)

Methods inherited from interface java.util.SortedMap

comparator, firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

getNFields

int getNFields()

Returns:

the number of fields in the record (both textual and ordinal).

getField

Object getField(FieldName fieldName)

Parameters:

fieldName -

Returns:

the value (possibly null) of the record at the corresponding fieldName. Returns null if the record does not have a field with the given name.

hasField

boolean hasField(FieldName fieldName)

Parameters:

fieldName -

Returns:

true if this record actually has a field of the given name

getOrdinalField

Object getOrdinalField(int ordinalFieldName)

Parameters:

ordinalFieldName - the ordinal field name as an int. For example, for field #3, this would be 3.

Returns:

the value (possibly null) of the record at the corresponding ordinalFieldName. Returns null if the record does not have a field with the given name.

hasOrdinalField

boolean hasOrdinalField(int ordinalFieldName)

Parameters:

ordinalFieldName - the ordinal field name as an int. For example, for field #3, this would be 3.

Returns:

true if this record actually has an ordinal field of the given name

getTextualField

Object getTextualField(String textualFieldName)

Parameters:

textualFieldName - a textual field-name (i.e. cannot be an ordinal field name such as #2).

Returns:

the value (possibly null) of the record at the corresponding textualFieldName (could be null). Returns null if the record does not have a field with the given name.

hasTextualField

boolean hasTextualField(String textualFieldName)

Parameters:

textualFieldName - a textual field-name (i.e. cannot be an ordinal field name such as #2).

Returns:

true if this record actually has a textual field of the given name.