|
EclipseLink 2.0.0, build 'v20091127-r5931' API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.persistence.queries.ReportQueryResult
public class ReportQueryResult
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:
Nested Class Summary | |
---|---|
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 | |
---|---|
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.util.Vector<java.lang.Object> |
primaryKeyValues
PK values if the retrievPKs flag was set on the ReportQuery. |
protected java.util.List<java.lang.Object> |
results
Actual converted attribute values |
Constructor Summary | |
---|---|
ReportQueryResult(java.util.List<java.lang.Object> results,
java.util.Vector primaryKeyValues)
INTERNAL: Used to create test results |
|
ReportQueryResult(ReportQuery query,
org.eclipse.persistence.internal.sessions.AbstractRecord row,
java.util.Vector toManyResults)
|
Method Summary | |
---|---|
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.util.List<java.lang.String> |
getNames()
PUBLIC: Return the names of report items, provided to ReportQuery. |
java.util.Vector<java.lang.Object> |
getPrimaryKeyValues()
PUBLIC: Return the PKs for the corresponding object or null if not requested. |
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 |
setNames(java.util.List<java.lang.String> names)
|
protected void |
setPrimaryKeyValues(java.util.Vector primaryKeyValues)
INTERNAL: Set the PK values for the result row's object. |
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 |
---|
protected java.util.List<java.lang.String> names
protected java.util.List<java.lang.Object> results
protected java.util.Vector<java.lang.Object> primaryKeyValues
protected java.lang.StringBuffer key
Constructor Detail |
---|
public ReportQueryResult(java.util.List<java.lang.Object> results, java.util.Vector primaryKeyValues)
public ReportQueryResult(ReportQuery query, org.eclipse.persistence.internal.sessions.AbstractRecord row, java.util.Vector toManyResults)
Method Detail |
---|
protected void buildResult(ReportQuery query, org.eclipse.persistence.internal.sessions.AbstractRecord row, java.util.Vector toManyData)
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)
public void clear()
clear
in interface java.util.Map
public boolean contains(java.lang.Object value)
public boolean containsKey(java.lang.Object key)
containsKey
in interface java.util.Map
public boolean containsValue(java.lang.Object value)
containsValue
in interface java.util.Map
public java.util.Enumeration elements()
values()
public java.util.Set entrySet()
entrySet
in interface java.util.Map
public boolean equals(java.lang.Object anObject)
equals
in interface java.util.Map
equals
in class java.lang.Object
public boolean equals(ReportQueryResult result)
public java.lang.Object get(java.lang.Object name)
get
in interface java.util.Map
public java.lang.Object get(java.lang.String name)
public java.lang.Object getByIndex(int index)
public java.lang.String getResultKey()
public java.util.List<java.lang.String> getNames()
public java.util.Vector<java.lang.Object> getPrimaryKeyValues()
public java.util.List<java.lang.Object> getResults()
public boolean isEmpty()
isEmpty
in interface java.util.Map
public java.util.Enumeration keys()
keySet()
public java.util.Set keySet()
keySet
in interface java.util.Map
public java.lang.Object put(java.lang.Object name, java.lang.Object value)
put
in interface java.util.Map
public void putAll(java.util.Map map)
putAll
in interface java.util.Map
public java.lang.Object readObject(java.lang.Class javaClass, Session session)
public java.lang.Object remove(java.lang.Object name)
remove
in interface java.util.Map
protected void setNames(java.util.List<java.lang.String> names)
protected void setPrimaryKeyValues(java.util.Vector primaryKeyValues)
public void setResults(java.util.List<java.lang.Object> results)
public int size()
size
in interface java.util.Map
public java.lang.Object[] toArray()
public java.util.List toList()
public java.lang.String toString()
toString
in class java.lang.Object
public java.util.Collection values()
values
in interface java.util.Map
|
EclipseLink 2.0.0, build 'v20091127-r5931' API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |