org.eclipse.persistence.queries
Class ReportQueryResult

java.lang.Object
  extended by org.eclipse.persistence.queries.ReportQueryResult
All Implemented Interfaces:
Serializable, Map

public class ReportQueryResult
extends Object
implements Serializable, Map

Purpose: A single row (type) result for a ReportQuery

Description: Represents a single row of attribute values (converted using mapping) for a ReportQuery. The attributes can be from various objects. Responsibilities:

Since:
TOPLink/Java 2.0
Author:
Doug Clarke
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Constructor Summary
ReportQueryResult(List<Object> results, Object primaryKeyValues)
          INTERNAL: Used to create test results
ReportQueryResult(ReportQuery query, org.eclipse.persistence.internal.sessions.AbstractRecord row, Vector toManyResults)
           
 
Method Summary
 void clear()
          PUBLIC: Clear the contents of the result.
 boolean contains(Object value)
          PUBLIC: Check if the value is contained in the result.
 boolean containsKey(Object key)
          PUBLIC: Check if the key is contained in the result.
 boolean containsValue(Object value)
          PUBLIC: Check if the value is contained in the result.
 Enumeration elements()
          OBSOLETE: Return an enumeration of the result values.
 Set entrySet()
          PUBLIC: Returns a set of the keys.
 boolean equals(Object anObject)
          PUBLIC: Compare if the two results are equal.
 boolean equals(ReportQueryResult result)
          INTERNAL: Used in testing to compare if results are correct.
 Object get(Object name)
          PUBLIC: Return the value for given item name.
 Object get(String name)
          PUBLIC: Return the value for given item name.
 Object getByIndex(int index)
          PUBLIC: Return the indexed value from result.
 Object getId()
          PUBLIC: Return the Id for the result or null if not requested.
 List<String> getNames()
          PUBLIC: Return the names of report items, provided to ReportQuery.
 Vector<Object> getPrimaryKeyValues()
          Deprecated. 
 String getResultKey()
          INTERNAL: Return the unique key for this result
 List<Object> getResults()
          PUBLIC: Return the results.
 boolean isEmpty()
          PUBLIC: Return if the result is empty.
 Enumeration keys()
          OBSOLETE: Return an enumeration of the result names.
 Set keySet()
          PUBLIC: Returns a set of the keys.
 Object put(Object name, Object value)
          ADVANCED: Set the value for given item name.
 void putAll(Map map)
          PUBLIC: Add all of the elements.
 Object readObject(Class javaClass, Session session)
          PUBLIC: If the PKs were retrieved with the attributes then this method can be used to read the real object from the database.
 Object remove(Object name)
          INTERNAL: Remove the name key and value from the result.
 void setResults(List<Object> results)
          INTERNAL: Set the results.
 int size()
          PUBLIC: Return the number of name/value pairs in the result.
 Object[] toArray()
          INTERNAL: Converts the ReportQueryResult to a simple array of values.
 List toList()
          INTERNAL: Converts the ReportQueryResult to a simple list of values.
 String toString()
           
 Collection values()
          PUBLIC: Returns an collection of the values.
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
hashCode
 

Constructor Detail

ReportQueryResult

public ReportQueryResult(List<Object> results,
                         Object primaryKeyValues)
INTERNAL: Used to create test results


ReportQueryResult

public ReportQueryResult(ReportQuery query,
                         org.eclipse.persistence.internal.sessions.AbstractRecord row,
                         Vector toManyResults)
Method Detail

clear

public void clear()
PUBLIC: Clear the contents of the result.

Specified by:
clear in interface Map

contains

public boolean contains(Object value)
PUBLIC: Check if the value is contained in the result.


containsKey

public boolean containsKey(Object key)
PUBLIC: Check if the key is contained in the result.

Specified by:
containsKey in interface Map

containsValue

public boolean containsValue(Object value)
PUBLIC: Check if the value is contained in the result.

Specified by:
containsValue in interface Map

elements

public Enumeration elements()
OBSOLETE: Return an enumeration of the result values.

See Also:
values()

entrySet

public Set entrySet()
PUBLIC: Returns a set of the keys.

Specified by:
entrySet in interface Map

equals

public boolean equals(Object anObject)
PUBLIC: Compare if the two results are equal.

Specified by:
equals in interface Map
Overrides:
equals in class Object

equals

public boolean equals(ReportQueryResult result)
INTERNAL: Used in testing to compare if results are correct.


get

public Object get(Object name)
PUBLIC: Return the value for given item name.

Specified by:
get in interface Map

get

public Object get(String name)
PUBLIC: Return the value for given item name.


getByIndex

public Object getByIndex(int index)
PUBLIC: Return the indexed value from result.


getResultKey

public String getResultKey()
INTERNAL: Return the unique key for this result


getNames

public List<String> getNames()
PUBLIC: Return the names of report items, provided to ReportQuery.


getId

public Object getId()
PUBLIC: Return the Id for the result or null if not requested.


getPrimaryKeyValues

@Deprecated
public Vector<Object> getPrimaryKeyValues()
Deprecated. 

PUBLIC: Return the PKs for the corresponding object or null if not requested.

See Also:
getId()

getResults

public List<Object> getResults()
PUBLIC: Return the results.


isEmpty

public boolean isEmpty()
PUBLIC: Return if the result is empty.

Specified by:
isEmpty in interface Map

keys

public Enumeration keys()
OBSOLETE: Return an enumeration of the result names.

See Also:
keySet()

keySet

public Set keySet()
PUBLIC: Returns a set of the keys.

Specified by:
keySet in interface Map

put

public Object put(Object name,
                  Object value)
ADVANCED: Set the value for given item name.

Specified by:
put in interface Map

putAll

public void putAll(Map map)
PUBLIC: Add all of the elements.

Specified by:
putAll in interface Map

readObject

public Object readObject(Class javaClass,
                         Session session)
PUBLIC: If the PKs were retrieved with the attributes then this method can be used to read the real object from the database.


remove

public Object remove(Object name)
INTERNAL: Remove the name key and value from the result.

Specified by:
remove in interface Map

setResults

public void setResults(List<Object> results)
INTERNAL: Set the results.


size

public int size()
PUBLIC: Return the number of name/value pairs in the result.

Specified by:
size in interface Map

toArray

public Object[] toArray()
INTERNAL: Converts the ReportQueryResult to a simple array of values.


toList

public List toList()
INTERNAL: Converts the ReportQueryResult to a simple list of values.


toString

public String toString()
Overrides:
toString in class Object

values

public Collection values()
PUBLIC: Returns an collection of the values.

Specified by:
values in interface Map