QueryResultContainer

java.lang.Object
- arlut.csd.ganymede.common.QueryResultContainer

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable, java.util.Collection, java.util.List
```
public class QueryResultContainer
extends java.lang.Object
implements java.util.List, java.io.Serializable
```
This class presents a List-interface on top of a query result set. Each item in the list can be either an Object array, or a Map, depending on how the user has contructed this container.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ARRAYROWS`
`(package private) java.util.List`	`handles` An ordered list of ObjectHandles that correspond to the DBObject represented in each row of the result set.
`(package private) java.util.List`	`headers` An ordered list of headers that correspond to each column in this result set.
`(package private) java.util.Map`	`invidHash` Optimization structure that speeds up obtaining an object's label given that DBObject's invid.
`(package private) java.util.Vector`	`invidList` Optimization structure that speeds up obtaining a list of invids for each object referenced in the result set.
`(package private) java.util.Map`	`labelHash` Optimization structure that speeds up obtaining an Invid given a DBObject's label.
`(package private) java.util.Vector`	`labelList` Optimization structure that speeds up obtaining a list of labels for each object referenced in the result set.
`static int`	`MAPROWS`
`(package private) java.util.List`	`rows` A list of Object[].
`(package private) int`	`rowType`
`(package private) static long`	`serialVersionUID`
`(package private) java.util.List`	`types` An ordered list of Shorts that correspond to the DBField ID's of each column in this result set.

Constructor Summary

Constructors
Constructor and Description

QueryResultContainer()

QueryResultContainer(int rowType)
The rowType specifies what composition the result set has.

Constructors
Constructor and Description
`QueryResultContainer()`
`QueryResultContainer(int rowType)` The rowType specifies what composition the result set has.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(int index, java.lang.Object element)`
`boolean`	`add(java.lang.Object o)`
`boolean`	`addAll(java.util.Collection c)`
`boolean`	`addAll(int index, java.util.Collection c)`
`void`	`addField(java.lang.String fieldName, java.lang.Short fieldID)` Adds a field header to this query result.
`void`	`addRow(Invid invid, java.lang.String label, java.lang.Object[] row, boolean editable)` This method is used to add an object's information to the QueryResult's set of objects that matched the original query.
`void`	`addRow(Invid invid, java.lang.String label, java.lang.Object[] row, boolean inactive, boolean expirationSet, boolean removalSet, boolean editable)` This method is used to add an object's information to the QueryResult's set of objects that matched the original query.
`void`	`addRow(ObjectHandle handle, java.lang.Object[] row)` This method is used to add an object's information to the QueryResult's set of objects that matched the original query.
`void`	`changeRowType(int newRowType)` Changes this result set from using rows of one type to rows of another.
`void`	`clear()`
`boolean`	`contains(java.lang.Object o)`
`boolean`	`containsAll(java.util.Collection c)`
`boolean`	`containsInvid(Invid invid)` Returns boolean showing if the result set contains the given Invid.
`boolean`	`containsLabel(java.lang.String label)` Returns boolean showing if the result set contains an object with the given label.
`private java.util.Map`	`convertArrayRowToMapRow(java.lang.Object[] row)` Takes a row as represented in a result set with row type ARRAYROWS and converts it to one that matches the row type MAPROWS.
`private java.lang.Object[]`	`convertMapRowToArrayRow(java.util.Map row)` Takes a row as represented in a result set with row type MAPROWS and converts it to one that matches the row type ARRAYROWS.
`java.lang.Object`	`get(int index)`
`java.util.Vector`	`getFieldRow(int rowNumber)` This method can be called on the client to obtain a `Vector` containing the data values returned for the object at row row, in field order matching the field names and types returned by `getHeaders()` and `getTypes()`.
`java.util.List`	`getHandles()` This method is used by arlut.csd.ganymede.client.objectList to get access to the raw and sorted vector of ObjectHandle's post-serialization.
`java.util.List`	`getHeaders()` This method can be called on the client to obtain a `Vector` of field names, used to generate the list of column headers in the GUI client.
`Invid`	`getInvid(int row)` Grab the Invid of the object represented in the given row of the result set.
`java.util.Vector`	`getInvids()` Grab the list of Invids that are contained in this result set.
`java.lang.String`	`getLabel(int row)` Grabs the label for the object represented in the given row of the result set.
`java.util.Vector`	`getLabels()` Grab a list of the labels of each object contained in this result set.
`ObjectHandle`	`getObjectHandle(int row)` Returns the ObjectHandle for this row.
`java.lang.Object`	`getResult(int row, int col)` This method can be called on the client to obtain an Object encoding the result value for the colth field in the rowth object.
`java.util.List`	`getRows()` This method can be called on the client to obtain a `List` of Vectors, each of which contains the data values returned for each object, in field order matching the field names and types returned by `getHeaders()` and `getHeaderObjects()`.
`java.util.List`	`getTypes()` This method can be called on the client to obtain a `Vector` of field type `Shorts` (enumerated in the `FieldType` static constants), identifying the types of fields for each column in the DumpResult.
`int`	`indexOf(java.lang.Object o)`
`boolean`	`isEmpty()`
`java.util.Iterator`	`iterator()`
`int`	`lastIndexOf(java.lang.Object o)`
`java.util.ListIterator`	`listIterator()`
`java.util.ListIterator`	`listIterator(int index)`
`private void`	`rebuildTransients()` Used to rebuild any ancillary data-structures that aren't preserved during serialization/deserialization.
`java.lang.Object`	`remove(int index)`
`boolean`	`remove(java.lang.Object o)`
`boolean`	`removeAll(java.util.Collection c)`
`int`	`resultSize()` This method can be called on the client to determine the number of objects encoded in this result set.
`boolean`	`retainAll(java.util.Collection c)`
`java.lang.Object`	`set(int index, java.lang.Object element)`
`int`	`size()`
`java.util.List`	`subList(int fromIndex, int toIndex)`
`java.lang.Object[]`	`toArray()`
`java.lang.Object[]`	`toArray(java.lang.Object[] a)`
`java.lang.String`	`toString()`

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

Methods inherited from interface java.util.List
equals, hashCode

- Field Detail
  - serialVersionUID
```
static final long serialVersionUID
```
    See Also:
    Constant Field Values
  - headers
```
java.util.List headers
```
    An ordered list of headers that correspond to each column in this result set.
  - types
```
java.util.List types
```
    An ordered list of Shorts that correspond to the DBField ID's of each column in this result set.
  - rows
```
java.util.List rows
```
    A list of Object[]. This represents the actual result set. The list of rows is sorted in the order each row was added to the result set via addRow(). The length of each row is equal to the number of column headers for this result set. The types of the objects contained in each cell of each row depends on the type of the DBField that represents that cell's value. A StringDBField column, for example, will yield String objects while a NumericDBField will yield an Integer.
  - handles
```
java.util.List handles
```
    An ordered list of ObjectHandles that correspond to the DBObject represented in each row of the result set. There is one handle per row.
  - labelList
```
transient java.util.Vector labelList
```
    Optimization structure that speeds up obtaining a list of labels for each object referenced in the result set. This list has the same order of the rows of the result set.
  - invidList
```
transient java.util.Vector invidList
```
    Optimization structure that speeds up obtaining a list of invids for each object referenced in the result set. This list has the same order of the rows of the result set.
  - labelHash
```
transient java.util.Map labelHash
```
    Optimization structure that speeds up obtaining an Invid given a DBObject's label. This is not a general-purpose lookup method, as it only applies to DBObjects referenced by this result set. FIXME: There is an outstanding bug here. Using a Hash for this purpose assumes that there is a 1-to-1 mapping between labels and the DBObjects they represent. However, it's possible to have multiple DBObjects with the same Invids. In other words, the size of the keyset (or value set) of the hash may be smaller than the number of rows.
  - invidHash
```
transient java.util.Map invidHash
```
    Optimization structure that speeds up obtaining an object's label given that DBObject's invid. This is not a general-purpose lookup method, as it only applies to DBObjects referenced by this result set.
  - ARRAYROWS
```
public static final int ARRAYROWS
```
    See Also:
    Constant Field Values
  - MAPROWS
```
public static final int MAPROWS
```
    See Also:
    Constant Field Values
  - rowType
```
int rowType
```
- Constructor Detail
  - QueryResultContainer
```
public QueryResultContainer()
```
  - QueryResultContainer
```
public QueryResultContainer(int rowType)
```
    The rowType specifies what composition the result set has. It can either be a List of array objects (where each array represents one row of the result set and the array elements are ordered corresponding to the order of this container's header fields) or it can be a List of Maps (where each Map represents one row of the result set and the Map's keys are the headers defined for this container).
    
    Parameters:
    rowType - Either QueryResultContainer.ARRAYROWS or QueryResultContainer.MAPROWS
- Method Detail
  - addField
```
public void addField(java.lang.String fieldName,
            java.lang.Short fieldID)
```
    Adds a field header to this query result. Field headers are used to map column numbers in the result set to column identifiers; the first field header added using this method will be the name of column 0, the second will be the name of column 1, etc.
  - addRow
```
public void addRow(Invid invid,
          java.lang.String label,
          java.lang.Object[] row,
          boolean editable)
```
    This method is used to add an object's information to the QueryResult's set of objects that matched the original query.
  - addRow
```
public void addRow(ObjectHandle handle,
          java.lang.Object[] row)
```
    This method is used to add an object's information to the QueryResult's set of objects that matched the original query.
  - addRow
```
public void addRow(Invid invid,
          java.lang.String label,
          java.lang.Object[] row,
          boolean inactive,
          boolean expirationSet,
          boolean removalSet,
          boolean editable)
```
    This method is used to add an object's information to the QueryResult's set of objects that matched the original query.
  - getHandles
```
public java.util.List getHandles()
```
    This method is used by arlut.csd.ganymede.client.objectList to get access to the raw and sorted vector of ObjectHandle's post-serialization.
    
    Note that this method does not clone our handles vector, we'll just assume that whatever the objectList class on the client does to this vector, we're not going to disturb anyone else who will be looking at the handle list on this query result object.
  - getInvid
```
public Invid getInvid(int row)
```
    Grab the Invid of the object represented in the given row of the result set.
    
    Parameters:
    row -
    
    Returns:
    handle to the object
  - getInvids
```
public java.util.Vector getInvids()
```
    Grab the list of Invids that are contained in this result set. The invids returned are in the same order that they were added to this result set.
    
    Returns:
    list of Invids
  - getLabels
```
public java.util.Vector getLabels()
```
    Grab a list of the labels of each object contained in this result set. The labels returned are in the same order their corresponding objects were added to this result set.
    
    Returns:
    list of Invids
  - getLabel
```
public java.lang.String getLabel(int row)
```
    Grabs the label for the object represented in the given row of the result set.
    
    Parameters:
    row -
    
    Returns:
    handle to the label
  - getObjectHandle
```
public ObjectHandle getObjectHandle(int row)
```
    Returns the ObjectHandle for this row.
  - containsInvid
```
public boolean containsInvid(Invid invid)
```
    Returns boolean showing if the result set contains the given Invid.
  - containsLabel
```
public boolean containsLabel(java.lang.String label)
```
    Returns boolean showing if the result set contains an object with the given label.
  - getHeaders
```
public java.util.List getHeaders()
```
    This method can be called on the client to obtain a Vector of field names, used to generate the list of column headers in the GUI client.
  - getTypes
```
public java.util.List getTypes()
```
    This method can be called on the client to obtain a Vector of field type Shorts (enumerated in the FieldType static constants), identifying the types of fields for each column in the DumpResult.
  - getRows
```
public java.util.List getRows()
```
    This method can be called on the client to obtain a List of Vectors, each of which contains the data values returned for each object, in field order matching the field names and types returned by getHeaders() and getHeaderObjects().
  - getFieldRow
```
public java.util.Vector getFieldRow(int rowNumber)
```
    This method can be called on the client to obtain a Vector containing the data values returned for the object at row row, in field order matching the field names and types returned by getHeaders() and getTypes().
  - getResult
```
public java.lang.Object getResult(int row,
                         int col)
```
    This method can be called on the client to obtain an Object encoding the result value for the colth field in the rowth object.
    These Objects may be a Double for Float fields, an Integer for Numeric fields, a Date for Date fields, or a String for other fields.
  - resultSize
```
public int resultSize()
```
    This method can be called on the client to determine the number of objects encoded in this result set.
  - rebuildTransients
```
private void rebuildTransients()
```
    Used to rebuild any ancillary data-structures that aren't preserved during serialization/deserialization.
  - convertArrayRowToMapRow
```
private java.util.Map convertArrayRowToMapRow(java.lang.Object[] row)
```
    Takes a row as represented in a result set with row type ARRAYROWS and converts it to one that matches the row type MAPROWS.
    
    Parameters:
    row -
    
    Returns:
    newRow
  - convertMapRowToArrayRow
```
private java.lang.Object[] convertMapRowToArrayRow(java.util.Map row)
```
    Takes a row as represented in a result set with row type MAPROWS and converts it to one that matches the row type ARRAYROWS.
    
    Parameters:
    row -
    
    Returns:
    newRow
  - changeRowType
```
public void changeRowType(int newRowType)
```
    Changes this result set from using rows of one type to rows of another. This method will preserve the existing row/header ordering.
    
    Parameters:
    newRowType - This should be either MAPROWS or ARRAYROWS, which are both constants defined in this class.
  - add
```
public void add(int index,
       java.lang.Object element)
```
    Specified by:
    
    add in interface java.util.List
  - add
```
public boolean add(java.lang.Object o)
```
    Specified by:
    
    add in interface java.util.Collection
    
    Specified by:
    
    add in interface java.util.List
  - addAll
```
public boolean addAll(java.util.Collection c)
```
    Specified by:
    
    addAll in interface java.util.Collection
    
    Specified by:
    
    addAll in interface java.util.List
  - addAll
```
public boolean addAll(int index,
             java.util.Collection c)
```
    Specified by:
    
    addAll in interface java.util.List
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Collection
    
    Specified by:
    
    clear in interface java.util.List
  - contains
```
public boolean contains(java.lang.Object o)
```
    Specified by:
    
    contains in interface java.util.Collection
    
    Specified by:
    
    contains in interface java.util.List
  - containsAll
```
public boolean containsAll(java.util.Collection c)
```
    Specified by:
    
    containsAll in interface java.util.Collection
    
    Specified by:
    
    containsAll in interface java.util.List
  - get
```
public java.lang.Object get(int index)
```
    Specified by:
    
    get in interface java.util.List
  - indexOf
```
public int indexOf(java.lang.Object o)
```
    Specified by:
    
    indexOf in interface java.util.List
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Collection
    
    Specified by:
    
    isEmpty in interface java.util.List
  - iterator
```
public java.util.Iterator iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable
    
    Specified by:
    
    iterator in interface java.util.Collection
    
    Specified by:
    
    iterator in interface java.util.List
  - lastIndexOf
```
public int lastIndexOf(java.lang.Object o)
```
    Specified by:
    
    lastIndexOf in interface java.util.List
  - listIterator
```
public java.util.ListIterator listIterator()
```
    Specified by:
    
    listIterator in interface java.util.List
  - listIterator
```
public java.util.ListIterator listIterator(int index)
```
    Specified by:
    
    listIterator in interface java.util.List
  - remove
```
public java.lang.Object remove(int index)
```
    Specified by:
    
    remove in interface java.util.List
  - remove
```
public boolean remove(java.lang.Object o)
```
    Specified by:
    
    remove in interface java.util.Collection
    
    Specified by:
    
    remove in interface java.util.List
  - removeAll
```
public boolean removeAll(java.util.Collection c)
```
    Specified by:
    
    removeAll in interface java.util.Collection
    
    Specified by:
    
    removeAll in interface java.util.List
  - retainAll
```
public boolean retainAll(java.util.Collection c)
```
    Specified by:
    
    retainAll in interface java.util.Collection
    
    Specified by:
    
    retainAll in interface java.util.List
  - set
```
public java.lang.Object set(int index,
                   java.lang.Object element)
```
    Specified by:
    
    set in interface java.util.List
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Collection
    
    Specified by:
    
    size in interface java.util.List
  - subList
```
public java.util.List subList(int fromIndex,
                     int toIndex)
```
    Specified by:
    
    subList in interface java.util.List
  - toArray
```
public java.lang.Object[] toArray()
```
    Specified by:
    
    toArray in interface java.util.Collection
    
    Specified by:
    
    toArray in interface java.util.List
  - toArray
```
public java.lang.Object[] toArray(java.lang.Object[] a)
```
    Specified by:
    
    toArray in interface java.util.Collection
    
    Specified by:
    
    toArray in interface java.util.List
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class QueryResultContainer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Field Detail

serialVersionUID

headers

types

rows

handles

labelList

invidList

labelHash

invidHash

ARRAYROWS

MAPROWS

rowType

Constructor Detail

QueryResultContainer

QueryResultContainer

Method Detail

addField

addRow

addRow

addRow

getHandles

getInvid

getInvids

getLabels

getLabel

getObjectHandle

containsInvid

containsLabel

getHeaders

getTypes

getRows

getFieldRow

getResult

resultSize

rebuildTransients

convertArrayRowToMapRow

convertMapRowToArrayRow

changeRowType

add

add

addAll

addAll

clear

contains

containsAll

get

indexOf

isEmpty

iterator

lastIndexOf

listIterator

listIterator

remove

remove

removeAll

retainAll

set

size

subList

toArray

toArray

toString