|
Oracle TopLink Java API Reference 10g Release 3 (10.1.3.1) B28219-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.toplink.publicinterface.DatabaseRow
oracle.toplink.sessions.DatabaseRecord
Purpose: Define a representation of a database row as field=>value pairs. This is the database row implementation class, the Record or java.util.Map interfaces should be used to access this class instead of the implemention class.
Responsibilities:
DatabaseField
, Record
, Map
, Serialized FormNested Class Summary |
Nested classes inherited from class java.util.Map |
java.util.Map.Entry |
Method Summary | |
void |
clear() PUBLIC: Clears the contents of the database row, both fields and values. |
boolean |
contains(java.lang.Object value) PUBLIC: Checks if the given Object value is contained in the values held in the database row. |
boolean |
containsKey(java.lang.Object key) PUBLIC: Checks if a key (ie. the field) is contained in the database row. |
boolean |
containsKey(java.lang.String fieldName) PUBLIC: Checks if a given field is contained in the database row. |
boolean |
containsValue(java.lang.Object value) PUBLIC: Checks if the given Object value is contained in the values held in the database row. |
java.util.Enumeration |
elements() PUBLIC: Returns an Enumeration of the values in the database row. |
java.util.Set |
entrySet() PUBLIC: Returns a set of map entries (ie. field-value pairs)in the database row with the DatabaseFields as keys and the value Objects as values. |
java.lang.Object |
get(java.lang.Object key) PUBLIC: Retrieves the value for the given key. |
java.lang.Object |
get(java.lang.String fieldName) PUBLIC: Retrieves the value with the given name of the DatabaseField. |
java.lang.Object |
getIndicatingNoEntry(java.lang.String fieldName) PUBLIC: Retrieves the value with the given field name. |
java.lang.Object |
getValues(DatabaseField key) PUBLIC: Returns the Object associated with the given key (null if the key does not map to an Object.) |
boolean |
isEmpty() PUBLIC: Checks if the database row is empty (ie. there are no field-value pairs.) |
java.util.Enumeration |
keys() PUBLIC: Returns an Enumeration of the DatabaseField Objects. |
java.util.Set |
keySet() PUBLIC: Returns a set of the keys, the DatabaseField Objects, for the database row. |
java.lang.Object |
put(java.lang.Object key, java.lang.Object value) PUBLIC: Adds a field-value pair to the row. |
java.lang.Object |
put(java.lang.String key, java.lang.Object value) PUBLIC: Adds a field-value pair to the row. |
void |
putAll(java.util.Map map) PUBLIC: Adds all of the elements in the given map to the database row. |
int |
size() PUBLIC: Returns the number of field-value pairs in the database row. |
java.util.Collection |
values() PUBLIC: Returns a collection of the values held in the database row. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.Map |
equals, hashCode |
Method Detail |
public void clear()
clear
in interface java.util.Map
clear
in class DatabaseRow
public boolean contains(java.lang.Object value)
contains
in class DatabaseRow
value
- the Object to be consideredpublic boolean containsKey(java.lang.Object key)
containsKey
in interface java.util.Map
containsKey
in class DatabaseRow
key
- an Object, either String or DatabaseFieldpublic boolean containsKey(java.lang.String fieldName)
containsKey
in class DatabaseRow
public boolean containsValue(java.lang.Object value)
containsValue
in interface java.util.Map
containsValue
in class DatabaseRow
value
- the Object under considerationpublic java.util.Enumeration elements()
elements
in class DatabaseRow
public java.util.Set entrySet()
entrySet
in interface java.util.Map
entrySet
in class DatabaseRow
Map.entrySet()
public java.lang.Object get(java.lang.Object key)
get
in interface java.util.Map
get
in class DatabaseRow
key
- Object, either String or DatabaseFieldpublic java.lang.Object get(java.lang.String fieldName)
get
in class DatabaseRow
fieldName
- String, the DatabaseField namepublic java.lang.Object getIndicatingNoEntry(java.lang.String fieldName)
getIndicatingNoEntry
in class DatabaseRow
fieldName
- String, the DatabaseField namepublic java.lang.Object getValues(DatabaseField key)
getValues
in class DatabaseRow
key
- DatabaseFieldpublic boolean isEmpty()
isEmpty
in interface java.util.Map
isEmpty
in class DatabaseRow
public java.util.Enumeration keys()
keys
in class DatabaseRow
public java.util.Set keySet()
keySet
in interface java.util.Map
keySet
in class DatabaseRow
public java.lang.Object put(java.lang.Object key, java.lang.Object value) throws ValidationException
put
in interface java.util.Map
put
in class DatabaseRow
key
- Object, either String or DatabaseFieldvalue
- ObjectValidationException
- if inappropriate key is usedpublic java.lang.Object put(java.lang.String key, java.lang.Object value)
put
in class DatabaseRow
key
- Stringvalue
- Objectpublic void putAll(java.util.Map map)
putAll
in interface java.util.Map
putAll
in class DatabaseRow
map
- Map of all the field-value elements to be addedpublic int size()
size
in interface java.util.Map
size
in class DatabaseRow
public java.util.Collection values()
values
in interface java.util.Map
values
in class DatabaseRow
|
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |