oracle.toplink.publicinterface
Class DatabaseRow

java.lang.Object
oracle.toplink.publicinterface.DatabaseRow

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map, java.io.Serializable

public class DatabaseRow

extends java.lang.Object

implements java.lang.Cloneable, java.io.Serializable, java.util.Map

Purpose: Define a representation of a database row as field=>value pairs.

Responsibilities:

• Implement the common hashtable collection protocol.
• Allow get and put on the field or field name.

See Also:

DatabaseField, Serialized Form

Nested Class Summary

static class

DatabaseRow.NoEntry NoEntry: This is used to differentiate between the two kinds of nulls: no entry exists, and the field is actually mapped to null.

Nested classes inherited from class java.util.Map

java.util.Map.Entry

Field Summary

static DatabaseRow.NoEntry

noEntry indicator showing that no entry exists for a given key.

Method Summary

void	clear() PUBLIC: Clear the contents of the row.
boolean	contains(java.lang.Object value) PUBLIC: Check if the value is contained in the row.
boolean	containsKey(java.lang.Object key) PUBLIC: Check if the field is contained in the row.
boolean	containsKey(java.lang.String fieldName) PUBLIC: Check if the field is contained in the row.
boolean	containsValue(java.lang.Object value) PUBLIC: Check if the value is contained in the row.
java.util.Enumeration	elements() PUBLIC: Returns an Enumeration of the values.
java.util.Set	entrySet() PUBLIC: Returns a set of the keys.
java.lang.Object	get(java.lang.Object key) PUBLIC: Retrieve the value for the field name.
java.lang.Object	get(java.lang.String fieldName) PUBLIC: Retrieve the value for the field name.
java.lang.Object	getIndicatingNoEntry(java.lang.String fieldName) PUBLIC: Retrieve the value for the field name.
boolean	isEmpty() PUBLIC: Return if the row is empty.
java.util.Enumeration	keys() PUBLIC: Returns an Enumeration of the DatabaseField objects.
java.util.Set	keySet() PUBLIC: Returns a set of the keys.
void	putAll(java.util.Map map) PUBLIC: Add all of the elements.
int	size() PUBLIC: Return the number of field/value pairs in the row.
java.util.Collection	values() PUBLIC: Returns an collection of the values.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

noEntry

public static DatabaseRow.NoEntry noEntry

indicator showing that no entry exists for a given key.

Method Detail

clear

public void clear()

PUBLIC: Clear the contents of the row.

Specified by:

clear in interface java.util.Map

contains

public boolean contains(java.lang.Object value)

PUBLIC: Check if the value is contained in the row.

containsKey

public boolean containsKey(java.lang.Object key)

PUBLIC: Check if the field is contained in the row. Conform to hashtable interface.

Specified by:

containsKey in interface java.util.Map

containsKey

public boolean containsKey(java.lang.String fieldName)

PUBLIC: Check if the field is contained in the row.

containsValue

public boolean containsValue(java.lang.Object value)

PUBLIC: Check if the value is contained in the row.

Specified by:

containsValue in interface java.util.Map

elements

public java.util.Enumeration elements()

PUBLIC: Returns an Enumeration of the values.

entrySet

public java.util.Set entrySet()

PUBLIC: Returns a set of the keys.

Specified by:

entrySet in interface java.util.Map

get

public java.lang.Object get(java.lang.Object key)

PUBLIC: Retrieve the value for the field name. A field is constructed on the name to check the hash table. If missing null is returned.

Specified by:

get in interface java.util.Map

get

public java.lang.Object get(java.lang.String fieldName)

PUBLIC: Retrieve the value for the field name. A field is constructed on the name to check the hash table. If missing null is returned.

getIndicatingNoEntry

public java.lang.Object getIndicatingNoEntry(java.lang.String fieldName)

PUBLIC: Retrieve the value for the field name. A field is constructed on the name to check the hash table. If missing DatabaseRow.noEntry is returned.

isEmpty

public boolean isEmpty()

PUBLIC: Return if the row is empty.

Specified by:

isEmpty in interface java.util.Map

keys

public java.util.Enumeration keys()

PUBLIC: Returns an Enumeration of the DatabaseField objects.

keySet

public java.util.Set keySet()

PUBLIC: Returns a set of the keys.

Specified by:

keySet in interface java.util.Map

putAll

public void putAll(java.util.Map map)

PUBLIC: Add all of the elements.

Specified by:

putAll in interface java.util.Map

size

public int size()

PUBLIC: Return the number of field/value pairs in the row.

Specified by:

size in interface java.util.Map

values

public java.util.Collection values()

PUBLIC: Returns an collection of the values.

Specified by:

values in interface java.util.Map