ReportQueryResult (EclipseLink 2.6.6, API Reference)

java.lang.Object
- org.eclipse.persistence.queries.ReportQueryResult

All Implemented Interfaces:

java.io.Serializable, java.util.Map
```
public class ReportQueryResult
extends java.lang.Object
implements java.io.Serializable, java.util.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:
- Converted field values into object attribute values.
- Provide access to values by index or item name
See Also:
Serialized Form
Author:

Doug Clarke

Since:

TOPLink/Java 2.0

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`ReportQueryResult.EntryIterator` Defines the virtual entrySet iterator.
`protected class`	`ReportQueryResult.EntrySet` Defines the virtual entrySet.
`protected class`	`ReportQueryResult.KeyIterator` Defines the virtual keySet iterator.
`protected class`	`ReportQueryResult.KeySet` Defines the virtual keySet.
`protected static class`	`ReportQueryResult.RecordEntry` Entry class for implementing Map interface.

Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.StringBuffer`	`key` If an objectLevel distinct is used then generate unique key for this result
`protected java.util.List<java.lang.String>`	`names` Item names to lookup result values
`protected java.lang.Object`	`primaryKey` Id value if the retrievPKs flag was set on the ReportQuery.
`protected java.util.List<java.lang.Object>`	`results` Actual converted attribute values

Constructor Summary

Constructors
Constructor and Description
`ReportQueryResult(java.util.List<java.lang.Object> results, java.lang.Object primaryKeyValues)` INTERNAL: Used to create test results
`ReportQueryResult(ReportQuery query, org.eclipse.persistence.internal.sessions.AbstractRecord row, java.util.Vector toManyResults)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`buildResult(ReportQuery query, org.eclipse.persistence.internal.sessions.AbstractRecord row, java.util.Vector toManyData)` INTERNAL: Create an array of attribute values (converted from raw field values using the mapping).
`void`	`clear()` PUBLIC: Clear the contents of the result.
`boolean`	`contains(java.lang.Object value)` PUBLIC: Check if the value is contained in the result.
`boolean`	`containsKey(java.lang.Object key)` PUBLIC: Check if the key is contained in the result.
`boolean`	`containsValue(java.lang.Object value)` PUBLIC: Check if the value is contained in the result.
`java.util.Enumeration`	`elements()` OBSOLETE: Return an enumeration of the result values.
`java.util.Set`	`entrySet()` PUBLIC: Returns a set of the keys.
`boolean`	`equals(java.lang.Object anObject)` PUBLIC: Compare if the two results are equal.
`boolean`	`equals(ReportQueryResult result)` INTERNAL: Used in testing to compare if results are correct.
`java.lang.Object`	`get(java.lang.Object name)` PUBLIC: Return the value for given item name.
`java.lang.Object`	`get(java.lang.String name)` PUBLIC: Return the value for given item name.
`java.lang.Object`	`getByIndex(int index)` PUBLIC: Return the indexed value from result.
`java.lang.Object`	`getId()` PUBLIC: Return the Id for the result or null if not requested.
`java.util.List<java.lang.String>`	`getNames()` PUBLIC: Return the names of report items, provided to ReportQuery.
`java.util.Vector<java.lang.Object>`	`getPrimaryKeyValues()` Deprecated. since 2.1, replaced by getId()
`java.lang.String`	`getResultKey()` INTERNAL: Return the unique key for this result
`java.util.List<java.lang.Object>`	`getResults()` PUBLIC: Return the results.
`boolean`	`isEmpty()` PUBLIC: Return if the result is empty.
`java.util.Enumeration`	`keys()` OBSOLETE: Return an enumeration of the result names.
`java.util.Set`	`keySet()` PUBLIC: Returns a set of the keys.
`protected java.lang.Object`	`processItem(ReportQuery query, org.eclipse.persistence.internal.sessions.AbstractRecord row, java.util.Vector toManyData, org.eclipse.persistence.internal.queries.ReportItem item)` INTERNAL: Return a value from an item and database row (converted from raw field values using the mapping).
`java.lang.Object`	`put(java.lang.Object name, java.lang.Object value)` ADVANCED: Set the value for given item name.
`void`	`putAll(java.util.Map map)` PUBLIC: Add all of the elements.
`java.lang.Object`	`readObject(java.lang.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.
`java.lang.Object`	`remove(java.lang.Object name)` INTERNAL: Remove the name key and value from the result.
`protected void`	`setId(java.lang.Object primaryKey)` INTERNAL: Set the Id for the result row's object.
`protected void`	`setNames(java.util.List<java.lang.String> names)`
`void`	`setResults(java.util.List<java.lang.Object> results)` INTERNAL: Set the results.
`int`	`size()` PUBLIC: Return the number of name/value pairs in the result.
`java.lang.Object[]`	`toArray()` INTERNAL: Converts the ReportQueryResult to a simple array of values.
`java.util.List`	`toList()` INTERNAL: Converts the ReportQueryResult to a simple list of values.
`java.lang.String`	`toString()`
`java.util.Collection`	`values()` PUBLIC: Returns an collection of the values.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
hashCode

- Field Detail
  - names
```
protected java.util.List<java.lang.String> names
```
    Item names to lookup result values
  - results
```
protected java.util.List<java.lang.Object> results
```
    Actual converted attribute values
  - primaryKey
```
protected java.lang.Object primaryKey
```
    Id value if the retrievPKs flag was set on the ReportQuery. These can be used to get the actual object
  - key
```
protected java.lang.StringBuffer key
```
    If an objectLevel distinct is used then generate unique key for this result
- Constructor Detail
  - ReportQueryResult
```
public ReportQueryResult(java.util.List<java.lang.Object> results,
                 java.lang.Object primaryKeyValues)
```
    INTERNAL: Used to create test results
  - ReportQueryResult
```
public ReportQueryResult(ReportQuery query,
                 org.eclipse.persistence.internal.sessions.AbstractRecord row,
                 java.util.Vector toManyResults)
```
- Method Detail
  - buildResult
```
protected void buildResult(ReportQuery query,
               org.eclipse.persistence.internal.sessions.AbstractRecord row,
               java.util.Vector toManyData)
```
    INTERNAL: Create an array of attribute values (converted from raw field values using the mapping).
  - processItem
```
protected java.lang.Object processItem(ReportQuery query,
                           org.eclipse.persistence.internal.sessions.AbstractRecord row,
                           java.util.Vector toManyData,
                           org.eclipse.persistence.internal.queries.ReportItem item)
```
    INTERNAL: Return a value from an item and database row (converted from raw field values using the mapping).
  - clear
```
public void clear()
```
    PUBLIC: Clear the contents of the result.
    
    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 result.
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    PUBLIC: Check if the key is contained in the result.
    
    Specified by:
    
    containsKey in interface java.util.Map
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    PUBLIC: Check if the value is contained in the result.
    
    Specified by:
    
    containsValue in interface java.util.Map
  - elements
```
public java.util.Enumeration elements()
```
    OBSOLETE: Return an enumeration of the result values.
    
    See Also:
    values()
  - entrySet
```
public java.util.Set entrySet()
```
    PUBLIC: Returns a set of the keys.
    
    Specified by:
    
    entrySet in interface java.util.Map
  - equals
```
public boolean equals(java.lang.Object anObject)
```
    PUBLIC: Compare if the two results are equal.
    
    Specified by:
    
    equals in interface java.util.Map
    
    Overrides:
    
    equals in class java.lang.Object
  - equals
```
public boolean equals(ReportQueryResult result)
```
    INTERNAL: Used in testing to compare if results are correct.
  - get
```
public java.lang.Object get(java.lang.Object name)
```
    PUBLIC: Return the value for given item name.
    
    Specified by:
    
    get in interface java.util.Map
  - get
```
public java.lang.Object get(java.lang.String name)
```
    PUBLIC: Return the value for given item name.
  - getByIndex
```
public java.lang.Object getByIndex(int index)
```
    PUBLIC: Return the indexed value from result.
  - getResultKey
```
public java.lang.String getResultKey()
```
    INTERNAL: Return the unique key for this result
  - getNames
```
public java.util.List<java.lang.String> getNames()
```
    PUBLIC: Return the names of report items, provided to ReportQuery.
  - getId
```
public java.lang.Object getId()
```
    PUBLIC: Return the Id for the result or null if not requested.
  - getPrimaryKeyValues
```
@Deprecated
public java.util.Vector<java.lang.Object> getPrimaryKeyValues()
```
    Deprecated. since 2.1, replaced by getId()
    
    PUBLIC: Return the PKs for the corresponding object or null if not requested.
    
    See Also:
    getId()
  - getResults
```
public java.util.List<java.lang.Object> getResults()
```
    PUBLIC: Return the results.
  - isEmpty
```
public boolean isEmpty()
```
    PUBLIC: Return if the result is empty.
    
    Specified by:
    
    isEmpty in interface java.util.Map
  - keys
```
public java.util.Enumeration keys()
```
    OBSOLETE: Return an enumeration of the result names.
    
    See Also:
    keySet()
  - keySet
```
public java.util.Set keySet()
```
    PUBLIC: Returns a set of the keys.
    
    Specified by:
    
    keySet in interface java.util.Map
  - put
```
public java.lang.Object put(java.lang.Object name,
                   java.lang.Object value)
```
    ADVANCED: Set the value for given item name.
    
    Specified by:
    
    put 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
  - readObject
```
public java.lang.Object readObject(java.lang.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 java.lang.Object remove(java.lang.Object name)
```
    INTERNAL: Remove the name key and value from the result.
    
    Specified by:
    
    remove in interface java.util.Map
  - setNames
```
protected void setNames(java.util.List<java.lang.String> names)
```
  - setId
```
protected void setId(java.lang.Object primaryKey)
```
    INTERNAL: Set the Id for the result row's object.
  - setResults
```
public void setResults(java.util.List<java.lang.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 java.util.Map
  - toArray
```
public java.lang.Object[] toArray()
```
    INTERNAL: Converts the ReportQueryResult to a simple array of values.
  - toList
```
public java.util.List toList()
```
    INTERNAL: Converts the ReportQueryResult to a simple list of values.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - values
```
public java.util.Collection values()
```
    PUBLIC: Returns an collection of the values.
    
    Specified by:
    
    values in interface java.util.Map

Class ReportQueryResult

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

names

results

primaryKey

key

Constructor Detail

ReportQueryResult

ReportQueryResult

Method Detail

buildResult

processItem

clear

contains

containsKey

containsValue

elements

entrySet

equals

equals

get

get

getByIndex

getResultKey

getNames

getId

getPrimaryKeyValues

getResults

isEmpty

keys

keySet

put

putAll

readObject

remove

setNames

setId

setResults

size

toArray

toList

toString

values