planetj.database.report
Class ReportBreakRowCollection

java.lang.Object
  |
  +--planetj.database.RowCollection
        |
        +--planetj.database.report.ReportBreakRowCollection

All Implemented Interfaces:

Cloneable, Collection, IBatchProcessObject, IDistributedExecutableObject, IFDFObject, INavigationObject, IXMLObject, List, Serializable

public class ReportBreakRowCollection

extends RowCollection

A RowCollection which knows how to generate report breaks.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class planetj.database.RowCollection

RowCollection.LinkedRowCollection

Field Summary

Fields inherited from class planetj.database.RowCollection

className, FIRST_ROW, LAST_ROW

Constructor Summary

ReportBreakRowCollection()
ReportRowCollection constructor comment.

Method Summary

int	addRows(int pFirstRow, int pRowCount, ResultSet pRS) Adds rows from the results set to this RowCollection.
int	getReportRowCount() Gets the number of ReportBreakRows currently contained in this ReportBreakRowCollection.
static int	getReportRowCount(RowCollection rc) Gets the number of ReportBreakRows currently contained in the RowCollection.

Methods inherited from class planetj.database.RowCollection

add, add, addAll, addAll, addFDRows, addRow, addRow, addRowEventListener, addTable, batchProcess, clear, clearRows, clearTables, clone, cloneRowCollection, contains, contains, containsAll, containsRowWithFieldsEqualTo, copyToConnection, copyToConnection, copyToConnection, createFieldDescriptor, createRowCollection, delete, delete, delete, delete, doesFieldDescriptorExist, executeDistributedAction, filter, filter, filter, firstRow, get, getAttribute, getColumnCount, getColumnValues, getColumnValues, getColumnValuesByUsageId, getCompleteRowCollection, getCompleteRowCollection, getConfigProperty, getConnectedChildren, getContainedClass, getDistributedRequestorURL, getEstimatedSize, getExternalName, getExternalNames, getExternalNames, getFDFData, getFieldCount, getFieldDescriptor, getFieldDescriptorCollection, getFieldDescriptorCollection, getFieldDescriptors, getFieldDescriptorsWithUsage, getFieldDescriptorsWithUsageId, getFieldDescriptorWithUsageId, getFieldNames, getFieldNameSets, getFields, getFieldsToDisplay, getFieldsToDisplayStrict, getFieldsToDisplayStrict, getGraphableFieldNames, getJoinFieldNames, getLastUpdated, getLibraryName, getMetaDataSystemAlias, getNavigationKey, getNavigationListKey, getNextRowCollection, getNextRowCollection, getPreviousRowCollection, getPreviousRowCollection, getPropertyGroup, getPropertyGroups, getPropertyGroups, getResultSet, getRetrievedRowCount, getRow, getRowCount, getRows, getSortedColumnNames, getSortedColumnNamesAscending, getSQL, getSQLContext, getSum, getSystemAlias, getTable, getTableName, getTables, getTimestamp, getTitle, getValidationExceptions, getValueAsDouble, getValueAsDouble, getXMLData, getXMLData, getXMLHeaderData, getXMLHeaderData, handleDistributed, hasConnectedChildren, hasNextRowCollection, hasPreviousRowCollection, indexOf, indexOf, insert, insert, insert, insert, insertBatch, isARow, isARowCollection, isCloneNeeded, isCurrent, isEmpty, isFromCache, isFromGroupBy, isFromJoin, isGraphable, isHasColumnNames, isHasRowEventListners, isLocked, isOkToReturnMeFromCache, isRowCollectionContainEditableRow, isValidateRequired, iterator, lastIndexOf, listIterator, listIterator, newRow, newRow, prepareForDisplay, prepareForResults, prepareForReturnFromCache, prepareFromFieldNames, reconcile, reconcile, refresh, refreshIfNeeded, remove, remove, removeAll, removeAllRows, removeAttribute, removeNavigationKey, removeRow, removeRow, removeRow, removeRowBasedOnKeyValues, removeRowEventListener, removeTable, replaceRow, retainAll, rollbackChanges, rowAltered, set, setAttribute, setColumnValues, setContainedClass, setDistributed, setDistributedRequestorURL, setDistributedSourceURL, setDistributedTargetURL, setLastUpdated, setNavigationKey, setPropertyGroups, setResultSet, setRow, setSortedColumnNames, setSql, setSystemAlias, setTable, setTables, setTables, size, sort, sortInternal, subList, toArray, toArray, toCSV, toCSV, toDOC, toDOC, toFDF, toPDF, toString, toUpperCase, toXML, update, update, update, update, validate, validate, validate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

equals, hashCode

Constructor Detail

ReportBreakRowCollection

public ReportBreakRowCollection()

ReportRowCollection constructor comment.

Method Detail

addRows

public int addRows(int pFirstRow,
                   int pRowCount,
                   ResultSet pRS)
            throws CMException

Adds rows from the results set to this RowCollection.

Overrides:

addRows in class RowCollection

Parameters:

pFirstRow - The row from the result set which will become row 1 of this RowCollection. The first row in the result is row number 1. There are two special constants that can be used for this argument: FIRST_ROW, and LAST_ROW. To add the first ten rows in the result set to this RowCollection you could invoke this method like this:

addRows (RowCollection.FIRST_ROW, 10, resultSet);

To add the last ten rows in the result set to this RowCollection you could invoke this method like this:

addRows (RowCollection.LAST_ROW - 10, 10, resultSet);

Note that using the LAST_ROW constant in this manner is only supported if the ResultSet allows backward and forward scrolling. Attempting to use the LAST_ROW constant when only forward scrolling is allowed causes an exception to be thrown.

pRowCount - The number of row from the ResultSet to try and add to this RowCollection. If the special constant SQLContext.NO_MAXIMUM is passed as this argument, then all the rows in the ResultSet (that aren't before the row indicated by the pFirstRow parameter) will be added to this RowCollection.

pRS - The result set from which rows will be added.

Returns:

The number of rows that were actually added to this RowCollection.

CMException

getReportRowCount

public int getReportRowCount()

Gets the number of ReportBreakRows currently contained in this ReportBreakRowCollection.

getReportRowCount

public static int getReportRowCount(RowCollection rc)

Gets the number of ReportBreakRows currently contained in the RowCollection.