com.aspc.DBObj

Class DBResultGroupBySet

java.lang.Object

com.aspc.DBObj.DBResultGroupBySet

public class DBResultGroupBySet
extends java.lang.Object

DBResultGroupBySet THREAD MODE: SINGLE-THREADED

Since:

24 September 2006

Author:

Aloysius George

Constructor Summary

Constructors

Constructor and Description
DBResultGroupBySet(DBClassConcrete dbClassConcrete, DataSource ds) Creates a new instance of DBResultGroupBySet
DBResultGroupBySet(DBResult origRes, DBQueryColumn[] columns) Creates a new instance of DBResultGroupBySet and groups the supplied result set by the supplied grouping field paths

Method Summary

Modifier and Type	Method and Description
void	addResult(DBResult res) Add the DBResult in the result map
int	getActRowCount() Get the actual row count
DBObject	getDetailObject(int requestedRow) Returns DBObject from combined result set
DBObject	getObject(int requestedRow) Returns first DBObject from result set at specified position
DBResult	getResult(int index) Returns the result of the given row key
java.lang.String	getRowKey(int index) Returns the rowKey of the given index
void	setOrderBy(java.lang.String fieldPath) A short hand method to set the order by for a particular field.
void	setOrderBy(java.lang.String fieldPath, boolean sortDescending) A short hand method to set the order by for a particular field.
void	sort() Sets the order of that the result set is in the format of the order statement is :- fieldPath DESC;fieldPath ASC

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DBResultGroupBySet

public DBResultGroupBySet(@Nonnull
                          DBClassConcrete dbClassConcrete,
                          @Nonnull
                          DataSource ds)

Creates a new instance of DBResultGroupBySet

Parameters:

dbClassConcrete - The class of this object

ds - Your current data source

DBResultGroupBySet

public DBResultGroupBySet(@Nonnull
                          DBResult origRes,
                          @Nullable
                          DBQueryColumn[] columns)
                   throws java.lang.Exception

Creates a new instance of DBResultGroupBySet and groups the supplied result set by the supplied grouping field paths

Parameters:

origRes - The original results to group

columns - The list of column objects that results are to be grouped by

Throws:

java.lang.Exception - a serious problem.

Method Detail

getResult

@CheckReturnValue
 @Nullable
public DBResult getResult(int index)

Returns the result of the given row key

Parameters:

index - The row key

Returns:

returns result set

getActRowCount

@CheckReturnValue
public int getActRowCount()

Get the actual row count

Returns:

The number of rows

addResult

public final void addResult(@Nonnull
                            DBResult res)
                     throws java.lang.NoSuchFieldException

Add the DBResult in the result map

Parameters:

res - The result is to add

Throws:

java.lang.NoSuchFieldException

setOrderBy

public final void setOrderBy(@Nullable
                             java.lang.String fieldPath)
                      throws java.lang.NoSuchFieldException

A short hand method to set the order by for a particular field.

Parameters:

fieldPath - The field path

Throws:

java.lang.NoSuchFieldException

setOrderBy

public final void setOrderBy(@Nullable
                             java.lang.String fieldPath,
                             boolean sortDescending)
                      throws java.lang.NoSuchFieldException

A short hand method to set the order by for a particular field.

Parameters:

fieldPath - The field path

sortDescending - Descending ?

Throws:

java.lang.NoSuchFieldException

sort

public final void sort()
                throws java.lang.NoSuchFieldException

Sets the order of that the result set is in the format of the order statement is :- fieldPath DESC;fieldPath ASC

Throws:

java.lang.NoSuchFieldException

getRowKey

@CheckReturnValue
 @Nullable
public java.lang.String getRowKey(int index)

Returns the rowKey of the given index

Parameters:

index - to get row key

Returns:

the row key string

getObject

@CheckReturnValue
 @Nullable
public DBObject getObject(int requestedRow)

Returns first DBObject from result set at specified position

Parameters:

requestedRow - The row to fetch.

Returns:

The matching DBObject

getDetailObject

@CheckReturnValue
 @Nullable
public DBObject getDetailObject(int requestedRow)

Returns DBObject from combined result set

Parameters:

requestedRow - The row to fetch.

Returns:

The matching DBObject