PresortQuery (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.persist.AbstractQuery
- - com.goldencode.p2j.persist.PreselectQuery
  - - com.goldencode.p2j.persist.PresortQuery

All Implemented Interfaces:

BufferCollection, RecordChangeListener, SessionListener, IndexInformation, Joinable, P2JQuery, Presortable, PresortDelegate, QueryConstants, Scrollable, Finalizable, Openable
```
public final class PresortQuery
extends PreselectQuery
implements Presortable, PresortDelegate
```
A specialized preselect query which uses one or more instances of Resolvable provided by business application code to sort the result set returned by the database. This class supports the Progress semantics of "client-side" results sorting and break groups. Multiple levels of nested break groups are supported.
Sorting criteria is specified using the addSortCriterion method. The order in which criteria are added is significant; the first criterion added dictates the coarsest level of sorting. Each criterion added subsequently only sorts rows within that criterion added immediately previous to it.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.goldencode.p2j.persist.P2JQuery
  P2JQuery.Parameter, P2JQuery.ParamResolver, P2JQuery.QueryEventListener, P2JQuery.QueryOpenedListener
- Nested classes/interfaces inherited from interface com.goldencode.p2j.persist.event.SessionListener
  SessionListener.Event, SessionListener.Scope

Field Summary

Fields
Modifier and Type Field and Description

private Presorter sorter
Helper which sorts preselected, unsorted results
- Fields inherited from class com.goldencode.p2j.persist.PreselectQuery
  betweenRows, components, currentRowDeleted, offEnd, sort, sortTranslated, unregisterOnCleanup
- Fields inherited from class com.goldencode.p2j.persist.AbstractQuery
  closed, dynamicPredicate, errorHelper, excluded, included, indexedReposition, inverseSorting, lenientOffEnd, outer, parameterFilter
- Fields inherited from interface com.goldencode.p2j.persist.QueryConstants
  CURRENT, FIRST, ITERATE, LAST, NEXT, NONE, PREVIOUS, RETRIEVE_MODES, UNIQUE

Fields
Modifier and Type	Field and Description
`private Presorter`	`sorter` Helper which sorts preselected, unsorted results

Constructor Summary

Constructors
Constructor and Description

PresortQuery()
Default constructor.

Constructors
Constructor and Description
`PresortQuery()` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addComponent(QueryComponent comp)` Add a component to the query.
`void`	`addDynamicSortCriterion(Resolvable sort, boolean ascending)` Add a single dynamic sort criterion, in the form of a `Resolvable` object which is resolved at runtime.
`void`	`addSortCriterion(Resolvable sort)` Add a single sort criterion, in the form of a `Resolvable` object which is resolved at sort time.
`void`	`addSortCriterion(Resolvable sort, boolean descending)` Add a single sort criterion, in the form of a `Resolvable` object which is resolved at runtime.
`protected java.util.ArrayList<SortCriterion>`	`assembleOrderByClause()` Assemble the `order by` clause for an HQL query.
`protected void`	`assembleSelectClause(java.lang.StringBuilder buf)` Assemble the select clause for an HQL query.
`void`	`clearDynamicSortCriteria()` Clears all sort criteria added dynamically.
`protected Results`	`createResults(Results results)` Given the scrollable results set for the query, create an object which implements the `Results` interface.
`void`	`enableBreakGroups()` Enable all sort criteria set for this query to act as break group categories.
`protected Results`	`executeQuery(Persistence persistence, java.lang.String fql, java.lang.Object[] args)` Execute the query to create a first level result set.
`protected <T> ScrollableResults<T>`	`executeScroll(Persistence persistence, java.lang.String hql, java.lang.Object[] args)` Execute the query to create a `ScrollableResults` result set.
`Results`	`getSortedResults()` Access the current, sorted results for this query.
`PresortQuery`	`initialize()` Initialization logic which is typically used for a multi-table query.
`PresortQuery`	`initialize(boolean lenientOffEnd)` Initialization logic which is typically used for a multi-table query.
`PresortQuery`	`initialize(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr)` Initialization logic designed for a single-table preselect query.
`PresortQuery`	`initialize(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, DataModelObject inverse)` Initialization logic designed for a single-table preselect query.
`PresortQuery`	`initialize(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, DataModelObject inverse, LockType lockType)` Initialization logic designed for a single-table preselect query.
`PresortQuery`	`initialize(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, DataModelObject inverse, java.lang.Object[] args)` Initialization logic designed for a single-table preselect query.
`PresortQuery`	`initialize(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, DataModelObject inverse, java.lang.Object[] args, LockType lockType)` Initialization logic designed for a single-table preselect query.
`PresortQuery`	`initialize(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, LockType lockType)` Initialization logic designed for a single-table preselect query.
`PresortQuery`	`initialize(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, java.lang.Object[] args)` Initialization logic designed for a single-table preselect query.
`PresortQuery`	`initialize(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, java.lang.Object[] args, LockType lockType)` Initialization logic designed for a single-table preselect query.
`PresortQuery`	`initialize(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, java.lang.String sort, java.lang.String indexInfo, DataModelObject inverse, java.lang.Object[] args, LockType lockType)` Initialization logic designed for a single-table preselect query.
`logical`	`isFirst()` Determine whether the query result row currently being visited is the first row in the presorted results list.
`logical`	`isFirstOfGroup(int level)` Determine whether the query result row currently being visited is the first row of the query's result set or the first row within a break group whose category is identified by the specified BREAK-BY level.
`logical`	`isFirstOfGroup(integer level)` Determine whether the query result row currently being visited is the first row of the query's result set or the first row within a break group whose category is identified by the specified BREAK-BY level.
`logical`	`isFirstOfGroup(Resolvable key)` Determine whether the query result row currently being visited is the first row within a break group whose category is identified by the specified resolvable object.
`logical`	`isLast()` Determine whether the query result row currently being visited is the last row in the presorted results list.
`protected boolean`	`isLastOfBreakGroup(Resolvable key)` Determine whether the query result row currently being visited is the last row within a break group whose category is identified by the specified resolvable object.
`logical`	`isLastOfGroup(int level)` Determine whether the query result row currently being visited is the last row of the query's result set or the last row within a break group whose category is identified by the specified BREAK-BY level.
`logical`	`isLastOfGroup(integer level)` Determine whether the query result row currently being visited is the last row of the query's result set or the last row within a break group whose category is identified by the specified BREAK-BY level.
`logical`	`isLastOfGroup(Resolvable key)` Determine whether the query result row currently being visited is the last row within a break group whose category is identified by the specified resolvable object.
`protected boolean`	`isNativelyScrolling()` Indicate whether this query type is scrolling by its nature.
`protected boolean`	`isNewBreakGroup(Resolvable key)` Determine whether the query result row currently being visited is the first row within a break group whose category is identified by the specified resolvable object.
`boolean`	`isPresort()` Indicate whether the query is of presort type.
`protected boolean`	`preserveBuffersOnEmptyResults(Results results)` Indicate whether the record buffer(s) current record(s) should be preserved, in the event the query does not find any results.
`boolean`	`shouldRegisterRecordChangeListeners()` Check if this type of query should register record change listeners.
`protected boolean`	`supportsArbitraryIteration()` Does this query support non-NEXT iteration components?

Methods inherited from class com.goldencode.p2j.persist.PreselectQuery
_isOffEnd, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addDynamicFilter, addDynamicSortCriterion, addExternalBuffers, addWhereExpression, anyBoundBufferInComponent, assembleFromAndWhereClauses, assembleOrderByClause, assembleOrderByClause, assembleWhereClause, backward, backward, buildSortCriteria, cacheResults, cleanup, clearDynamicFilters, clearRepoCache, close, close, components, coreFetch, createResultListEntry, current, current, currentRow, currentRowImpl, deleted, deleteResultListEntry, deregisteredSessionListener, execute, fetch, finished, first, first, forceDynamicOperation, forward, forward, getArgs, getEntities, getExternalBuffers, getHQL, getJoin, getOffEnd, getOffEndListeners, getOriginalWhere, getPersistence, getRecordBuffers, getResults, getRow, getSortPhrase, getTableCount, getTemplateQueryRowid, getWhereExpressions, handleMissingJoinRecord, hasWhereExpression, indexInformation, initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, isClientWhere, isFullRecords, isLenientOffEnd, isNativelyPreselect, isPreselect, isScrolling, isTopLevelCleanup, iterate, last, last, load, makeAdaptiveServerJoinComponent, makePreselectServerJoinComponent, next, next, open, peekFirst, peekLast, peekNext, peekPrevious, prepareParameters, prepareReposition, previous, previous, processJoin, recordBuffers, registerCleaner, registerRecordChangeListeners, releaseBuffers, reposition, reposition, repositionByID, repositionByID, repositionByID, repositionByID, reset, resetResults, retry, sessionEvent, setEmptyBuffersUnknown, setFullRecords, setIterationType, setIterationType, setLenientOffEnd, setNonScrolling, setResults, setScrolling, setUnknownRecord, shouldUpdateAnyLock, size, stateChanged, toString, translateWhere, treatPreviousAsLast, unique, unique, verifyJoins, whereExpressions

Methods inherited from class com.goldencode.p2j.persist.AbstractQuery
_getNext, _isSkipDeletedRecord, accumulate, addAccumulator, addAccumulator, addBuffer, addBuffer, addQueryEventListener, addRepositionListener, afterReposition, afterReposition, afterReposition, bufferHandle, bufferHandle, bufferHandle, bufferHandle, bufferHandle, buffersMatch, changeForwardOnly, changeForwardOnly, deleteResultListEntry, exclude, forwardOnly, getCache, getCurrent, getCurrent, getCurrent, getCurrent, getCurrent, getCurrent, getCurrent, getCurrent, getDataRelation, getDefaultLock, getErrorHelper, getExternalBuffersDefs, getFirst, getFirst, getFirst, getFirst, getFirst, getFirst, getFirst, getFirst, getLast, getLast, getLast, getLast, getLast, getLast, getLast, getLast, getNext, getNext, getNext, getNext, getNext, getNext, getNext, getNumResults, getPrevious, getPrevious, getPrevious, getPrevious, getPrevious, getPrevious, getPrevious, getPrevious, getReferencedBuffers, hasAccumulators, hasAny, hasAny, hasAny, hasAny, hasOne, hasOne, hasOne, hasOne, include, indexInformation, indexInformation, isBrowsed, isDynamicPredicate, isErrorIfNull, isFatalError, isFetchOnReposition, isFillingBrowseRows, isIndexedReposition, isIterating, isOffEnd, isOmitAlias, isOpen, isRepositionNotificationActive, isSkipDeletedRecord, isStandalone, loadRowAtCursor, notifyQueryCloseListeners, notifyQueryOpenListeners, notifyRepositionListeners, numBuffers, numResults, numResults, prepare, prepare, prepareFetch, prepareString, preprocessSubstitutionArguments, queryBackward, queryBackward, queryClose, queryForward, queryForward, queryOpen, queryReposition, queryReposition, queryRepositionByID, removeRepositionListener, setBrowsed, setBuffers, setBuffers, setCache, setCache, setDataRelation, setDynamicPredicate, setErrorIfNull, setFatalError, setFetchOnReposition, setFillingBrowseRows, setIndexedReposition, setIterating, setOmitAlias, setOuter, setParameterFilter, setPresort, setSkipDeletedRecord, setStandalone, silentCurrent, silentCurrent, silentFirst, silentFirst, silentLast, silentLast, silentNext, silentNext, silentPrevious, silentPrevious, silentUnique, silentUnique, translateSort, translateSort, translateWhere

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

Methods inherited from interface com.goldencode.p2j.persist.Presortable
getRecordBuffers

Methods inherited from interface com.goldencode.p2j.persist.Joinable
clearResults, getReferencedBuffers, setErrorIfNull, setOuter

Methods inherited from interface com.goldencode.p2j.persist.P2JQuery
_getNext, addAccumulator, addAccumulator, addQueryEventListener, addRepositionListener, changeForwardOnly, changeForwardOnly, deleteResultListEntry, exclude, forwardOnly, getBasicLogging, getCache, getCurrent, getCurrent, getCurrent, getCurrent, getCurrent, getCurrent, getCurrent, getCurrent, getDataRelation, getFirst, getFirst, getFirst, getFirst, getFirst, getFirst, getFirst, getFirst, getLast, getLast, getLast, getLast, getLast, getLast, getLast, getLast, getNext, getNext, getNext, getNext, getNext, getNext, getNext, getNext, getNumResults, getPrevious, getPrevious, getPrevious, getPrevious, getPrevious, getPrevious, getPrevious, getPrevious, hasAny, hasAny, hasAny, hasAny, hasOne, hasOne, hasOne, hasOne, hintFullResults, include, indexInformation, indexInformation, isBrowsed, isDynamicPredicate, isFetchOnReposition, isFillingBrowseRows, isFindByRowid, isIndexedReposition, isIterating, isOffEnd, isSkipDeletedRecord, isStandalone, notifyQueryCloseListeners, notifyQueryOpenListeners, notifyRepositionListeners, prepare, prepare, prepareString, queryBackward, queryBackward, queryClose, queryForward, queryForward, queryOpen, queryReposition, queryReposition, queryRepositionByID, queryRepositionByID, removeRepositionListener, resetQuery, setBasicLogging, setBasicLogging, setBrowsed, setCache, setCache, setDataRelation, setDynamicPredicate, setFetchOnReposition, setFillingBrowseRows, setIndexedReposition, setIterating, setParameterFilter, setPresort, setSkipDeletedRecord, setStandalone

Methods inherited from interface com.goldencode.p2j.persist.BufferCollection
addBuffer, addBuffer, addBuffer, addBuffer, bufferHandle, bufferHandle, bufferHandle, bufferHandle, bufferHandle, numBuffers, setBuffers, setBuffers, setBuffers

Methods inherited from interface com.goldencode.p2j.util.Openable
isOpen

Methods inherited from interface com.goldencode.p2j.util.Finalizable
entry, initFailure, weight

- Field Detail
  - sorter
```
private Presorter sorter
```
    Helper which sorts preselected, unsorted results
- Constructor Detail
  - PresortQuery
```
public PresortQuery()
```
    Default constructor. Initialization is deferred until initialize() is called.
- Method Detail
  - initialize
```
public PresortQuery initialize()
```
    Initialization logic which is typically used for a multi-table query. Details specific to each table component of the query are added via one of the addComponent method variants.
    This code is intentionally separated from the constructor. The purpose of this separation is to allow construction to occur in the prior scope while initialization can still occur within a method or lambda that is inside the next block's scope.
    
    Returns:
    
    This query instance.
  - initialize
```
public PresortQuery initialize(boolean lenientOffEnd)
```
    Initialization logic which is typically used for a multi-table query. Details specific to each table component of the query are added via one of the addComponent method variants.
    This variant is used by code which is converted from an OPEN QUERY statement, which permits advancing off the end of a result set without raising a QueryOffEndException.
    This code is intentionally separated from the constructor. The purpose of this separation is to allow construction to occur in the prior scope while initialization can still occur within a method or lambda that is inside the next block's scope.
    
    Parameters:
    
    lenientOffEnd - true if advancing past either end of the result set should NOT raise a QueryOffEndException; false if doing so should raise the exception.
    
    Returns:
    
    This query instance.
  - initialize
```
public PresortQuery initialize(DataModelObject dmo,
                               java.lang.String where,
                               java.util.function.Supplier<logical> whereExpr)
```
    Initialization logic designed for a single-table preselect query. The where clause must expect no substitution parameters. A share lock will be applied to retrieved records.
    This code is intentionally separated from the constructor. The purpose of this separation is to allow construction to occur in the prior scope while initialization can still occur within a method or lambda that is inside the next block's scope.
    
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    whereExpr - Client-side where clause expression. May be null.
    
    Returns:
    
    This query instance.
  - initialize
```
public PresortQuery initialize(DataModelObject dmo,
                               java.lang.String where,
                               java.util.function.Supplier<logical> whereExpr,
                               DataModelObject inverse)
```
    Initialization logic designed for a single-table preselect query. The where clause must expect no substitution parameters. A share lock will be applied to retrieved records.
    This code is intentionally separated from the constructor. The purpose of this separation is to allow construction to occur in the prior scope while initialization can still occur within a method or lambda that is inside the next block's scope.
    
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    whereExpr - Client-side where clause expression. May be null.
    
    inverse - DMO to which this query should join via a foreign relation. May be null.
    
    Returns:
    
    This query instance.
  - initialize
```
public PresortQuery initialize(DataModelObject dmo,
                               java.lang.String where,
                               java.util.function.Supplier<logical> whereExpr,
                               java.lang.Object[] args)
```
    Initialization logic designed for a single-table preselect query. A share lock will be applied to retrieved records.
    This code is intentionally separated from the constructor. The purpose of this separation is to allow construction to occur in the prior scope while initialization can still occur within a method or lambda that is inside the next block's scope.
    
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    whereExpr - Client-side where clause expression. May be null.
    
    args - Substitution parameters to be inserted into placeholders within the where clause.
    
    Returns:
    
    This query instance.
  - initialize
```
public PresortQuery initialize(DataModelObject dmo,
                               java.lang.String where,
                               java.util.function.Supplier<logical> whereExpr,
                               DataModelObject inverse,
                               java.lang.Object[] args)
```
    Initialization logic designed for a single-table preselect query. A share lock will be applied to retrieved records.
    This code is intentionally separated from the constructor. The purpose of this separation is to allow construction to occur in the prior scope while initialization can still occur within a method or lambda that is inside the next block's scope.
    
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    whereExpr - Client-side where clause expression. May be null.
    
    inverse - DMO to which this query should join via a foreign relation. May be null.
    
    args - Substitution parameters to be inserted into placeholders within the where clause.
    
    Returns:
    
    This query instance.
  - initialize
```
public PresortQuery initialize(DataModelObject dmo,
                               java.lang.String where,
                               java.util.function.Supplier<logical> whereExpr,
                               LockType lockType)
```
    Initialization logic designed for a single-table preselect query. The where clause must expect no substitution parameters.
    This code is intentionally separated from the constructor. The purpose of this separation is to allow construction to occur in the prior scope while initialization can still occur within a method or lambda that is inside the next block's scope.
    
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    whereExpr - Client-side where clause expression. May be null.
    
    lockType - Lock type to apply to records retrieved by this query.
    
    Returns:
    
    This query instance.
  - initialize
```
public PresortQuery initialize(DataModelObject dmo,
                               java.lang.String where,
                               java.util.function.Supplier<logical> whereExpr,
                               DataModelObject inverse,
                               LockType lockType)
```
    Initialization logic designed for a single-table preselect query. The where clause must expect no substitution parameters.
    This code is intentionally separated from the constructor. The purpose of this separation is to allow construction to occur in the prior scope while initialization can still occur within a method or lambda that is inside the next block's scope.
    
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    whereExpr - Client-side where clause expression. May be null.
    
    inverse - DMO to which this query should join via a foreign relation. May be null.
    
    lockType - Lock type to apply to records retrieved by this query.
    
    Returns:
    
    This query instance.
  - initialize
```
public PresortQuery initialize(DataModelObject dmo,
                               java.lang.String where,
                               java.util.function.Supplier<logical> whereExpr,
                               java.lang.Object[] args,
                               LockType lockType)
```
    Initialization logic designed for a single-table preselect query.
    This code is intentionally separated from the constructor. The purpose of this separation is to allow construction to occur in the prior scope while initialization can still occur within a method or lambda that is inside the next block's scope.
    
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    whereExpr - Client-side where clause expression. May be null.
    
    args - Substitution parameters to be inserted into placeholders within the where clause.
    
    lockType - Lock type to apply to records retrieved by this query.
    
    Returns:
    
    This query instance.
  - initialize
```
public PresortQuery initialize(DataModelObject dmo,
                               java.lang.String where,
                               java.util.function.Supplier<logical> whereExpr,
                               DataModelObject inverse,
                               java.lang.Object[] args,
                               LockType lockType)
```
    Initialization logic designed for a single-table preselect query.
    This code is intentionally separated from the constructor. The purpose of this separation is to allow construction to occur in the prior scope while initialization can still occur within a method or lambda that is inside the next block's scope.
    
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    whereExpr - Client-side where clause expression. May be null.
    
    inverse - DMO to which this query should join via a foreign relation. May be null.
    
    args - Substitution parameters to be inserted into placeholders within the where clause.
    
    lockType - Lock type to apply to records retrieved by this query.
    
    Returns:
    
    This query instance.
  - initialize
```
public PresortQuery initialize(DataModelObject dmo,
                               java.lang.String where,
                               java.util.function.Supplier<logical> whereExpr,
                               java.lang.String sort,
                               java.lang.String indexInfo,
                               DataModelObject inverse,
                               java.lang.Object[] args,
                               LockType lockType)
```
    Initialization logic designed for a single-table preselect query.
    This code is intentionally separated from the constructor. The purpose of this separation is to allow construction to occur in the prior scope while initialization can still occur within a method or lambda that is inside the next block's scope.
    
    Overrides:
    
    initialize in class PreselectQuery
    
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    whereExpr - Client-side where clause expression. May be null.
    
    sort - Sort clause that corresponds the index which defines the sort order for this query. May be null.
    
    indexInfo - Index information string as it is returned by INDEX-INFORMATION. May be null if it is not an OPEN QUERY case or if you don't need debug information about selected indexes.
    
    inverse - DMO to which this query should join via a foreign relation. May be null.
    
    args - Substitution parameters to be inserted into placeholders within the where clause.
    
    lockType - Lock type to apply to records retrieved by this query. If null, the default lock level is assumed.
    
    Returns:
    
    This query instance.
  - addSortCriterion
```
public void addSortCriterion(Resolvable sort)
```
    Add a single sort criterion, in the form of a Resolvable object which is resolved at sort time. It is the value of the resolved result which is used for the sort.
    The sort is ascending, from lowest resolved value to highest.
    
    Specified by:
    
    addSortCriterion in interface PresortDelegate
    
    Parameters:
    
    sort - A resolvable object whose resolved result is used for sorting.
  - addSortCriterion
```
public void addSortCriterion(Resolvable sort,
                             boolean descending)
```
    Add a single sort criterion, in the form of a Resolvable object which is resolved at runtime. It is the value of the resolved result which is used for the sort.
    
    Specified by:
    
    addSortCriterion in interface PresortDelegate
    
    Parameters:
    
    descending - if true, the sort is descending, from highest resolved value to lowest; otherwise, the sort is ascending.
    
    sort - A resolvable object whose resolved result is used for sorting.
  - addDynamicSortCriterion
```
public void addDynamicSortCriterion(Resolvable sort,
                                    boolean ascending)
```
    Add a single dynamic sort criterion, in the form of a Resolvable object which is resolved at runtime. It is the value of the resolved result which is used for the sort.
    Unlike addSortCriterion(com.goldencode.p2j.util.Resolvable) methods, the criterion is added with higher priority.
    
    Specified by:
    
    addDynamicSortCriterion in interface PresortDelegate
    
    Parameters:
    
    sort - A resolvable object whose resolved result is used for sorting.
    
    ascending - if true, the sort is ascending, from lowest resolved value to highest; otherwise, the sort is descending.
  - clearDynamicSortCriteria
```
public void clearDynamicSortCriteria()
```
    Clears all sort criteria added dynamically.
    
    Specified by:
    
    clearDynamicSortCriteria in interface PresortDelegate
    
    Overrides:
    
    clearDynamicSortCriteria in class PreselectQuery
  - enableBreakGroups
```
public void enableBreakGroups()
```
    Enable all sort criteria set for this query to act as break group categories. When the query's results are presorted, the contents of each break group are determined.
    
    Specified by:
    
    enableBreakGroups in interface PresortDelegate
  - shouldRegisterRecordChangeListeners
```
public boolean shouldRegisterRecordChangeListeners()
```
    Check if this type of query should register record change listeners. Use this to avoid computing any scope for registration and end up with a no registration behavior.
    
    Specified by:
    
    shouldRegisterRecordChangeListeners in interface Joinable
    
    Overrides:
    
    shouldRegisterRecordChangeListeners in class PreselectQuery
    
    Returns:
    
    true if we should invest time into computing the scope in order to call PreselectQuery.registerRecordChangeListeners(java.lang.Integer) or false if we can skip doing any work to honor PreselectQuery.registerRecordChangeListeners(java.lang.Integer).
  - isFirst
```
public logical isFirst()
```
    Determine whether the query result row currently being visited is the first row in the presorted results list.
    
    Specified by:
    
    isFirst in interface PresortDelegate
    
    Returns:
    
    true if the current result row is the first row, else false.
  - isPresort
```
public boolean isPresort()
```
    Indicate whether the query is of presort type.
    
    Specified by:
    
    isPresort in interface P2JQuery
    
    Overrides:
    
    isPresort in class AbstractQuery
    
    Parameters:
    
    iterating - true indicating that a query of presort type.
    
    Returns:
    
    true if the query is of presort type..
  - isFirstOfGroup
```
public logical isFirstOfGroup(Resolvable key)
```
    Determine whether the query result row currently being visited is the first row within a break group whose category is identified by the specified resolvable object.
    
    Specified by:
    
    isFirstOfGroup in interface PresortDelegate
    
    Parameters:
    
    key - Break group category key. Must be the same object reference as was specified previously when invoking one of the addSortCriterion method variants.
    
    Returns:
    
    true if break groups are enabled and current row is first in the specified break group; false if break groups have not been enabled or current row is not first in the specified break group.
  - isFirstOfGroup
```
public logical isFirstOfGroup(integer level)
```
    Determine whether the query result row currently being visited is the first row of the query's result set or the first row within a break group whose category is identified by the specified BREAK-BY level.
    
    Specified by:
    
    isFirstOfGroup in interface P2JQuery
    
    Specified by:
    
    isFirstOfGroup in interface PresortDelegate
    
    Parameters:
    
    level - Break group level, where 0 is the whole query, 1 is the first BREAK-BY sort criterion, etc. Must not be negative or greater than the number of sort criteria.
    
    Returns:
    
    true if the current row is first in the result set or within the specified break group; else false.
  - isFirstOfGroup
```
public logical isFirstOfGroup(int level)
```
    Determine whether the query result row currently being visited is the first row of the query's result set or the first row within a break group whose category is identified by the specified BREAK-BY level.
    
    Specified by:
    
    isFirstOfGroup in interface P2JQuery
    
    Parameters:
    
    level - Break group level, where 0 is the whole query, 1 is the first BREAK-BY sort criterion, etc. Must not be negative or greater than the number of sort criteria.
    
    Returns:
    
    true if the current row is first in the result set or within the specified break group; else false.
  - isLast
```
public logical isLast()
```
    Determine whether the query result row currently being visited is the last row in the presorted results list.
    
    Specified by:
    
    isLast in interface PresortDelegate
    
    Returns:
    
    true if the current result row is the last row, else false.
  - isLastOfGroup
```
public logical isLastOfGroup(Resolvable key)
```
    Determine whether the query result row currently being visited is the last row within a break group whose category is identified by the specified resolvable object.
    
    Specified by:
    
    isLastOfGroup in interface PresortDelegate
    
    Parameters:
    
    key - Break group category key. Must be the same object reference as was specified previously when invoking one of the addSortCriterion method variants.
    
    Returns:
    
    true if break groups are enabled and current row is last in the specified break group; false if break groups have not been enabled or current row is not last in the specified break group.
  - isLastOfGroup
```
public logical isLastOfGroup(integer level)
```
    Determine whether the query result row currently being visited is the last row of the query's result set or the last row within a break group whose category is identified by the specified BREAK-BY level.
    
    Specified by:
    
    isLastOfGroup in interface P2JQuery
    
    Specified by:
    
    isLastOfGroup in interface PresortDelegate
    
    Parameters:
    
    level - Break group level, where 0 is the whole query, 1 is the first BREAK-BY sort criterion, etc. Must not be negative or greater than the number of sort criteria. Must not be unknown value.
    
    Returns:
    
    true if the current row is last in the result set or within the specified break group; else false.
  - isLastOfGroup
```
public logical isLastOfGroup(int level)
```
    Determine whether the query result row currently being visited is the last row of the query's result set or the last row within a break group whose category is identified by the specified BREAK-BY level.
    
    Specified by:
    
    isLastOfGroup in interface P2JQuery
    
    Parameters:
    
    level - Break group level, where 0 is the whole query, 1 is the first BREAK-BY sort criterion, etc. Must not be negative or greater than the number of sort criteria.
    
    Returns:
    
    true if the current row is last in the result set or within the specified break group; else false.
  - getSortedResults
```
public Results getSortedResults()
```
    Access the current, sorted results for this query.
    
    Specified by:
    
    getSortedResults in interface Presortable
    
    Returns:
    
    Results object used to retrieve sorted results.
  - addComponent
```
protected void addComponent(QueryComponent comp)
```
    Add a component to the query.
    
    Overrides:
    
    addComponent in class PreselectQuery
    
    Parameters:
    
    comp - Query component to be added.
    
    Throws:
    
    java.lang.UnsupportedOperationException - if attempting an outer join (temporary); if iteration type is not NEXT (temporary); if the component's DMO's associated database is different than that of a previously added component's database (cross-database preselect joins are not possible).
  - supportsArbitraryIteration
```
protected boolean supportsArbitraryIteration()
```
    Does this query support non-NEXT iteration components?
    
    Overrides:
    
    supportsArbitraryIteration in class PreselectQuery
    
    Returns:
    
    true
  - preserveBuffersOnEmptyResults
```
protected boolean preserveBuffersOnEmptyResults(Results results)
```
    Indicate whether the record buffer(s) current record(s) should be preserved, in the event the query does not find any results.
    This implementation returns true only if break groups are enabled. Also, this checks if the results are truly empty. For a presort query, the results are always "full".
    
    Overrides:
    
    preserveBuffersOnEmptyResults in class PreselectQuery
    
    Parameters:
    
    results - The results instance to decide if they are truly empty. The results are not visible in some sub-classes, so let them be passed by parameter.
    
    Returns:
    
    true if break groups are enabled, else false.
  - isLastOfBreakGroup
```
protected boolean isLastOfBreakGroup(Resolvable key)
```
    Determine whether the query result row currently being visited is the last row within a break group whose category is identified by the specified resolvable object.
    
    Overrides:
    
    isLastOfBreakGroup in class AbstractQuery
    
    Parameters:
    
    key - Break group category key. Must be the same object reference as was specified previously when invoking one of the addSortCriterion method variants.
    
    Returns:
    
    true if break groups are enabled and current row is last in the specified break group; false if break groups have not been enabled or current row is not last in the specified break group.
  - isNewBreakGroup
```
protected boolean isNewBreakGroup(Resolvable key)
```
    Determine whether the query result row currently being visited is the first row within a break group whose category is identified by the specified resolvable object.
    This is the backing worker method for isFirstOfGroup(com.goldencode.p2j.util.Resolvable) and is used internally by the query to manage accumulators.
    
    Overrides:
    
    isNewBreakGroup in class AbstractQuery
    
    Parameters:
    
    key - Break group category key. Must be the same object reference as was specified previously when invoking one of the addSortCriterion method variants.
    
    Returns:
    
    true if current row is first in a break group; false if it is not; unknown value if break groups have not been enabled.
  - executeQuery
```
protected Results executeQuery(Persistence persistence,
                               java.lang.String fql,
                               java.lang.Object[] args)
                        throws PersistenceException
```
    Execute the query to create a first level result set.
    This default implementation returns an object which is a thin wrapper around ScrollableResults. This overrides the parent method as it needs a specific Results implementation: ForwardResults.
    In case when the fql represents a valid template record query (a test on recid / rowid of the record against the unique _file._template for current record of the single QueryComponent), a special Results object is returned with a single element that is the template record for the buffer of the component.
    
    Overrides:
    
    executeQuery in class PreselectQuery
    
    Parameters:
    
    persistence - Object which is used to execute the query.
    
    fql - FQL query string.
    
    args - Substitution parameters to be inserted into placeholders within the FQL query string.
    
    Returns:
    
    An instance of ForwardResults which wrappers the ScrollableResults object returned by the execution of the query.
    
    Throws:
    
    PersistenceException - if there is an error executing the query.
  - executeScroll
```
protected <T> ScrollableResults<T> executeScroll(Persistence persistence,
                                                 java.lang.String hql,
                                                 java.lang.Object[] args)
                                          throws PersistenceException
```
    Execute the query to create a ScrollableResults result set.
    Override the parent's implementation to use a ScrollMode of FORWARD_ONLY, which may permit the use of a server-side cursor by the JDBC driver.
    
    Overrides:
    
    executeScroll in class PreselectQuery
    
    Parameters:
    
    persistence - Object which is used to execute the query.
    
    hql - HQL query string.
    
    args - Substitution parameters to be inserted into placeholders within the HQL query string.
    
    Returns:
    
    The ScrollableResults object returned by the execution of the query.
    
    Throws:
    
    PersistenceException - if there is an error executing the query.
  - createResults
```
protected Results createResults(Results results)
                         throws PersistenceException
```
    Given the scrollable results set for the query, create an object which implements the Results interface. It is this object which will actually be used to retrieve the primary key values of records to be loaded from the database.
    This implementation returns a specialized Results object, which sorts the results obtained from the caller, according to one or more sort criterion provided by client code.
    
    Overrides:
    
    createResults in class PreselectQuery
    
    Parameters:
    
    results - An object used to access the records which meet this query's criteria.
    
    Returns:
    
    Results object which presorts the results.
    
    Throws:
    
    PersistenceException - if there is any error creating results
  - isNativelyScrolling
```
protected boolean isNativelyScrolling()
```
    Indicate whether this query type is scrolling by its nature.
    Subclasses which are not natively scrolling should override this method.
    
    Overrides:
    
    isNativelyScrolling in class PreselectQuery
    
    Returns:
    
    false.
  - assembleSelectClause
```
protected void assembleSelectClause(java.lang.StringBuilder buf)
```
    Assemble the select clause for an HQL query. Form of the clause is:
```
    select {buffer0} [, {buffer1} [...]]
 
```
    This method overrides the parent's implementation to make it a full query, rather than projection query which returns only the record's primary key. This is necessary to presort the results without issuing a separate select to the database to retrieve each record during the presort process.
    Overrides:
    
    assembleSelectClause in class PreselectQuery
    
    Parameters:
    
    buf - String buffer into which clause is assembled.
  - assembleOrderByClause
```
protected java.util.ArrayList<SortCriterion> assembleOrderByClause()
                                                            throws PersistenceException
```
    Assemble the order by clause for an HQL query.
    
    Overrides:
    
    assembleOrderByClause in class PreselectQuery
    
    Returns:
    
    List of SortCriterion objects which describe the sort behavior for this query.
    
    Throws:
    
    PersistenceException - never.

Class PresortQuery

Nested Class Summary

Nested classes/interfaces inherited from interface com.goldencode.p2j.persist.P2JQuery

Nested classes/interfaces inherited from interface com.goldencode.p2j.persist.event.SessionListener

Field Summary

Fields inherited from class com.goldencode.p2j.persist.PreselectQuery

Fields inherited from class com.goldencode.p2j.persist.AbstractQuery

Fields inherited from interface com.goldencode.p2j.persist.QueryConstants

Constructor Summary

Method Summary

Methods inherited from class com.goldencode.p2j.persist.PreselectQuery

Methods inherited from class com.goldencode.p2j.persist.AbstractQuery

Methods inherited from class java.lang.Object

Methods inherited from interface com.goldencode.p2j.persist.Presortable

Methods inherited from interface com.goldencode.p2j.persist.Joinable

Methods inherited from interface com.goldencode.p2j.persist.P2JQuery

Methods inherited from interface com.goldencode.p2j.persist.BufferCollection

Methods inherited from interface com.goldencode.p2j.util.Openable

Methods inherited from interface com.goldencode.p2j.util.Finalizable

Field Detail

sorter

Constructor Detail

PresortQuery

Method Detail

initialize

initialize

initialize

initialize

initialize

initialize

initialize

initialize

initialize

initialize

initialize

addSortCriterion

addSortCriterion

addDynamicSortCriterion

clearDynamicSortCriteria

enableBreakGroups

shouldRegisterRecordChangeListeners

isFirst

isPresort

isFirstOfGroup

isFirstOfGroup

isFirstOfGroup

isLast

isLastOfGroup

isLastOfGroup

isLastOfGroup

getSortedResults

addComponent

supportsArbitraryIteration

preserveBuffersOnEmptyResults

isLastOfBreakGroup

isNewBreakGroup

executeQuery

executeScroll

createResults

isNativelyScrolling

assembleSelectClause

assembleOrderByClause