org.eclipse.persistence.sessions
Class DatabaseRecord

java.lang.Object
  org.eclipse.persistence.internal.sessions.AbstractRecord
      org.eclipse.persistence.sessions.DatabaseRecord

All Implemented Interfaces:

Serializable, Cloneable, Map, Record

public class DatabaseRecord
extends org.eclipse.persistence.internal.sessions.AbstractRecord

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 implementation class.

Responsibilities:

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

See Also:

DatabaseField, Record, Map, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord

org.eclipse.persistence.internal.sessions.AbstractRecord.NoEntry

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

Map.Entry<K,V>

Field Summary

Fields inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord

noEntry

Constructor Summary

DatabaseRecord()
INTERNAL: Returns a record (of default size).

DatabaseRecord(int initialCapacity)
INTERNAL: Returns a record of the given initial capacity.

DatabaseRecord(Vector fields, Vector values)
INTERNAL: Builds row from database result fields and values.

Method Summary

void	clear() PUBLIC: Clears the contents of the database row, both fields and values.
boolean	contains(Object value) PUBLIC: Checks if the given Object value is contained in the values held in the database row.
boolean	containsKey(Object key) PUBLIC: Checks if a key (ie.
boolean	containsKey(String fieldName) PUBLIC: Checks if a given field is contained in the database row.
boolean	containsValue(Object value) PUBLIC: Checks if the given Object value is contained in the values held in the database row.
Enumeration	elements() PUBLIC: Returns an Enumeration of the values in the database row.
Set	entrySet() PUBLIC: Returns a set of map entries (ie.
Object	get(Object key) PUBLIC: Retrieves the value for the given key.
Object	get(String fieldName) PUBLIC: Retrieves the value with the given name of the DatabaseField.
Object	getIndicatingNoEntry(String fieldName) PUBLIC: Retrieves the value with the given field name.
Object	getValues(org.eclipse.persistence.internal.helper.DatabaseField key) PUBLIC: Returns the Object associated with the given key (null if the key does not map to an Object.)
Object	getValues(String 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.
Enumeration	keys() PUBLIC: Returns an Enumeration of the DatabaseField Objects.
Set	keySet() PUBLIC: Returns a set of the keys, the DatabaseField Objects, for the database row.
Object	put(Object key, Object value) PUBLIC: Adds a field-value pair to the row.
Object	put(String key, Object value) PUBLIC: Adds a field-value pair to the row.
void	putAll(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.
Collection	values() PUBLIC: Returns a collection of the values held in the database row.

Methods inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord

add, clone, containsKey, get, getField, getFields, getIndicatingNoEntry, getValues, mergeFrom, put, remove, remove, remove, replaceAt, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

DatabaseRecord

public DatabaseRecord()

INTERNAL: Returns a record (of default size).

DatabaseRecord

public DatabaseRecord(int initialCapacity)

INTERNAL: Returns a record of the given initial capacity.

Parameters:

initialCapacity -

DatabaseRecord

public DatabaseRecord(Vector fields,
                      Vector values)

INTERNAL: Builds row from database result fields and values. Note: the entire database result will share the same fields vector.

Parameters:

fields - Vector of fields

values - Vector of values

Method Detail

clear

public void clear()

PUBLIC: Clears the contents of the database row, both fields and values.

Specified by:

clear in interface Map

Overrides:

clear in class org.eclipse.persistence.internal.sessions.AbstractRecord

contains

public boolean contains(Object value)

PUBLIC: Checks if the given Object value is contained in the values held in the database row.

Overrides:

contains in class org.eclipse.persistence.internal.sessions.AbstractRecord

Parameters:

value - the Object to be considered

Returns:

boolean - true if the Object value is in the row.

containsKey

public boolean containsKey(Object key)

PUBLIC: Checks if a key (ie. the field) is contained in the database row. Conforms to a hashtable interface.

Specified by:

containsKey in interface Map

Overrides:

containsKey in class org.eclipse.persistence.internal.sessions.AbstractRecord

Parameters:

key - an Object, either String or DatabaseField

Returns:

boolean - true if the row with the corresponding key is in the row.

containsKey

public boolean containsKey(String fieldName)

PUBLIC: Checks if a given field is contained in the database row.

Overrides:

containsKey in class org.eclipse.persistence.internal.sessions.AbstractRecord

Parameters:

key - String, the DatabaseField name

Returns:

boolean - true if the row contains the key with the corresponding fieldName.

containsValue

public boolean containsValue(Object value)

PUBLIC: Checks if the given Object value is contained in the values held in the database row.

Specified by:

containsValue in interface Map

Overrides:

containsValue in class org.eclipse.persistence.internal.sessions.AbstractRecord

Parameters:

value - the Object under consideration

Returns:

boolean - true if the row contains the Object as a value

elements

public Enumeration elements()

PUBLIC: Returns an Enumeration of the values in the database row.

Overrides:

elements in class org.eclipse.persistence.internal.sessions.AbstractRecord

Returns:

Enumeration

entrySet

public 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.

Specified by:

entrySet in interface Map

Overrides:

entrySet in class org.eclipse.persistence.internal.sessions.AbstractRecord

Returns:

Set - the set of all the field-value entries (see java.util.Map.Entry)

See Also:

Map.entrySet()

get

public Object get(Object key)

PUBLIC: Retrieves the value for the given key. A field is constructed with the key to check the hash table. If missing, null is returned.

Specified by:

get in interface Map

Overrides:

get in class org.eclipse.persistence.internal.sessions.AbstractRecord

Parameters:

key - Object, either String or DatabaseField

Returns:

Object

get

public Object get(String fieldName)

PUBLIC: Retrieves the value with the given name of the DatabaseField. A field is constructed on the name to check the hash table. If missing, null is returned.

Overrides:

get in class org.eclipse.persistence.internal.sessions.AbstractRecord

Parameters:

fieldName - String, the DatabaseField name

Returns:

Object - the value

getIndicatingNoEntry

public Object getIndicatingNoEntry(String fieldName)

PUBLIC: Retrieves the value with the given field name. A field is constructed on the name to check the hash table. If missing, DatabaseRow.noEntry is returned.

Overrides:

getIndicatingNoEntry in class org.eclipse.persistence.internal.sessions.AbstractRecord

Parameters:

fieldName - String, the DatabaseField name

Returns:

Object - the value

getValues

public Object getValues(org.eclipse.persistence.internal.helper.DatabaseField key)

PUBLIC: Returns the Object associated with the given key (null if the key does not map to an Object.)

Overrides:

getValues in class org.eclipse.persistence.internal.sessions.AbstractRecord

Parameters:

key - DatabaseField

Returns:

Object - the value associated with the key

getValues

public Object getValues(String key)

PUBLIC: Returns the Object associated with the given key (null if the key does not map to an Object.)

Overrides:

getValues in class org.eclipse.persistence.internal.sessions.AbstractRecord

Parameters:

key - String

Returns:

Object - the value associated with the key

isEmpty

public boolean isEmpty()

PUBLIC: Checks if the database row is empty (ie. there are no field-value pairs.)

Specified by:

isEmpty in interface Map

Overrides:

isEmpty in class org.eclipse.persistence.internal.sessions.AbstractRecord

Returns:

boolean - true if the database row is empty

keys

public Enumeration keys()

PUBLIC: Returns an Enumeration of the DatabaseField Objects.

Overrides:

keys in class org.eclipse.persistence.internal.sessions.AbstractRecord

Returns:

Enumeration

keySet

public Set keySet()

PUBLIC: Returns a set of the keys, the DatabaseField Objects, for the database row.

Specified by:

keySet in interface Map

Overrides:

keySet in class org.eclipse.persistence.internal.sessions.AbstractRecord

Returns:

Set of the keys

put

public Object put(Object key,
                  Object value)
           throws ValidationException

PUBLIC: Adds a field-value pair to the row.

Specified by:

put in interface Map

Overrides:

put in class org.eclipse.persistence.internal.sessions.AbstractRecord

Parameters:

key - Object, either String or DatabaseField

value - Object

Returns:

Object - the previous Object with that key, could be null

Throws:

ValidationException - if inappropriate key is used

put

public Object put(String key,
                  Object value)

PUBLIC: Adds a field-value pair to the row.

Overrides:

put in class org.eclipse.persistence.internal.sessions.AbstractRecord

Parameters:

key - String

value - Object

Returns:

Object - the previous Object with that key, could be null

putAll

public void putAll(Map map)

PUBLIC: Adds all of the elements in the given map to the database row.

Specified by:

putAll in interface Map

Overrides:

putAll in class org.eclipse.persistence.internal.sessions.AbstractRecord

Parameters:

map - Map of all the field-value elements to be added

size

public int size()

PUBLIC: Returns the number of field-value pairs in the database row.

Specified by:

size in interface Map

Overrides:

size in class org.eclipse.persistence.internal.sessions.AbstractRecord

Returns:

int

values

public Collection values()

PUBLIC: Returns a collection of the values held in the database row.

Specified by:

values in interface Map

Overrides:

values in class org.eclipse.persistence.internal.sessions.AbstractRecord

Returns:

Collection of value Objects