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

java.lang.Object
- com.goldencode.p2j.persist.AbstractQuery
- - com.goldencode.p2j.persist.DynamicQuery
  - - com.goldencode.p2j.persist.RandomAccessQuery
    - - com.goldencode.p2j.persist.FindQuery

All Implemented Interfaces:

BufferCollection, RecordChangeListener, IndexInformation, Joinable, P2JQuery, QueryConstants, Scrollable, Openable
```
public final class FindQuery
extends RandomAccessQuery
```
A convenience adapter for a RandomAccessQuery. Calls to previous and next will throw a QueryOffEndException when no data record is found, which is consistent with the Progress FIND NEXT/PREV statement behavior.
On query off-end, the FIND NEXT/PREV statement will execute the action defined for the END-KEY condition (which defaults to UNDO, LEAVE, but can be overridden by an user-defined action). This behavior is only valid to following blocks:
- REPEAT
- PROCEDURE
- FOR
This class also handles converted CAN-FIND statements.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class FindQuery.CanFind
Types of can-find lookups
- Nested classes/interfaces inherited from interface com.goldencode.p2j.persist.P2JQuery
  P2JQuery.Parameter, P2JQuery.ParamResolver, P2JQuery.QueryEventListener, P2JQuery.QueryOpenedListener

Nested Classes
Modifier and Type	Class and Description
`private static class`	`FindQuery.CanFind` Types of can-find lookups

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.Object[]`	`args` Substitution parameters for HQL queries.
`private FindQuery.CanFind`	`canFindMode` Mode of this query if used for CAN-FIND.
`private DataModelObject`	`dmo` Data Model Object of the buffer in which the records will be retrived.
`private boolean`	`initialized` If the query was already initialized.
`private DataModelObject`	`inverse` DMO to which this query should join via a foreign relation, can be `null`.
`private LockType`	`lockType` Lock type to apply to records retrieved.
`private boolean`	`readOnly` Flag indicating whether buffer is updated by query.
`private java.lang.String`	`sort` Order by clause, using HQL syntax, can be `null.`
`private java.lang.String`	`where` Where clause, using HQL syntax, can be `null`.
`private java.util.function.Supplier<logical>`	`whereExpr` Client-side where clause expression, can be `null`.

Fields inherited from class com.goldencode.p2j.persist.DynamicQuery
cursor

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

Constructor Summary

Constructors
Constructor and Description
`FindQuery(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, java.lang.String sort)` Basic constructor which defaults record lock type to `LockType.SHARE`.
`FindQuery(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, java.lang.String sort, DataModelObject inverse)` Constructor which is used when joining to another table using a foreign key.
`FindQuery(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, java.lang.String sort, DataModelObject inverse, LockType lockType)` Constructor which is used when joining to another table using a foreign key.
`FindQuery(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, java.lang.String sort, DataModelObject inverse, java.lang.Object[] args)` Constructor which is used when joining to another table using a foreign key.
`FindQuery(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, java.lang.String sort, DataModelObject inverse, java.lang.Object[] args, LockType lockType)` Constructor which is used when joining to another table using a foreign key.
`FindQuery(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, java.lang.String sort, LockType lockType)` Constructor which sets an explicit, default, record lock type.
`FindQuery(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, java.lang.String sort, java.lang.Object[] args)` Constructor which defaults record lock type to `LockType.SHARE` and accepts default substitution parameters.
`FindQuery(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, java.lang.String sort, java.lang.Object[] args, LockType lockType)` Constructor which sets an explicit, default, record lock type and accepts default substitution parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FindQuery`	`addExternalBuffers(DataModelObject... dmos)` Add one or more buffers to the list of those which this query references externally.
`private boolean`	`canFindImpl(java.lang.Object[] values, LockType lockType)` Indicate whether a record can be found with meets this query's criteria.
`boolean`	`current()` Reload the record most recently loaded into the backing record buffer, if any.
`boolean`	`current(LockType lockType)` Reload the record most recently loaded into the backing record buffer, if any.
`boolean`	`first()` Navigate to the first record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`first(LockType lockType)` Navigate to the first record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`first(java.lang.Object[] values)` Navigate to the first record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`first(java.lang.Object[] values, LockType lockType)` Navigate to the first record which meets the query criteria and retrieve it into its record buffer.
`protected void`	`handleExecuteException(LockUnavailableException exc)` Override the superclass' implementation to throw an exception unconditionally when in read-only mode.
`protected void`	`handleExecuteException(PersistenceException exc)` Override the superclass' implementation to throw an exception unconditionally when in read-only mode.
`protected void`	`handleExecuteException(ValidationException exc)` Override the superclass' implementation to throw an exception unconditionally when in read-only mode.
`logical`	`hasAny()` Indicate whether a request to find the first result of this query would succeed or fail.
`logical`	`hasAny(LockType lockType)` Indicate whether a request to find the first result of this query would succeed or fail.
`logical`	`hasAny(java.lang.Object[] values)` Indicate whether a request to find the first result of this query would succeed or fail.
`logical`	`hasAny(java.lang.Object[] values, LockType lockType)` Indicate whether a request to find the first result of this query would succeed or fail.
`logical`	`hasOne()` Indicate whether this query would produce a unique result.
`logical`	`hasOne(LockType lockType)` Indicate whether this query would produce a unique result.
`logical`	`hasOne(java.lang.Object[] values)` Indicate whether this query would produce a unique result.
`logical`	`hasOne(java.lang.Object[] values, LockType lockType)` Indicate whether this query would produce a unique result.
`void`	`initializeQuery()` Initializes the query at the latest moment possible (right before executing a find operation).
`boolean`	`isFindByRowid()` Indicate whether this query is a simple RECID/ROWID lookup FIND query.
`protected boolean`	`isIdOnly()` Override the parent's method to return `true` if this is a CAN-FIND, else delegate to the parent's implementation.
`boolean`	`last()` Navigate to the last record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`last(LockType lockType)` Navigate to the last record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`last(java.lang.Object[] values)` Navigate to the last record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`last(java.lang.Object[] values, LockType lockType)` Navigate to the last record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`next()` Navigate to the next record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`next(LockType lockType)` Navigate to the next record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`next(java.lang.Object[] values)` Navigate to the next record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`next(java.lang.Object[] values, LockType lockType)` Navigate to the next record which meets the query criteria and retrieve it into its record buffer.
`protected void`	`prepareBuffer()` Prepare buffer associated with this query for the query's execution.
`boolean`	`previous()` Navigate to the previous record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`previous(LockType lockType)` Navigate to the previous record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`previous(java.lang.Object[] values)` Navigate to the previous record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`previous(java.lang.Object[] values, LockType lockType)` Navigate to the previous record which meets the query criteria and retrieve it into its record buffer.
`protected void`	`registerChangeListener()` This class doesn't need to register a change listener, so this method does nothing.
`FindQuery`	`setHasAny()` Set this query's can-find mode to 'any', meaning can it find any record which meets the query's criteria, regardless of duplicates.
`FindQuery`	`setHasOne()` Set this query's can-find mode to 'one', meaning can it find one and only one record which meets the query's criteria.
`protected boolean`	`suppressNestedQueryError()` Indicate whether a nested query error should be suppressed (i.e., reported only as a warning, but not interrupt control flow), when detected while preprocessing this query's substitution parameters.
`private boolean`	`testLock(Record dmo, LockType lockType)` Test whether the specified lock type could be acquired for the given DMO, but do not actually acquire the lock.
`protected boolean`	`throwExceptionOnFatalError()` Test whether the `first` / `last` navigation will throw `QueryOffEndException` if the initialization failed.
`boolean`	`unique()` Navigate to a particular record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`unique(LockType lockType)` Navigate to a particular record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`unique(java.lang.Object[] values)` Navigate to a particular record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`unique(java.lang.Object[] values, LockType lockType)` Navigate to a particular record which meets the query criteria and retrieve it into its record buffer.
`protected void`	`updateBuffer(Record dmo, LockType lockType, boolean errorIfNull, OffEnd offEnd)` Update the record buffer with the given DMO, applying the specified lock type and error-if-null setting.

Methods inherited from class com.goldencode.p2j.persist.RandomAccessQuery
activateFirst, activateUnique, addDynamicFilter, cleanup, clearDynamicFilters, clearResults, close, close, execute, forceDynamicOperation, getArgs, getBreakValue, getBuffer, getBundleFql, getCurrentArgs, getExternalBuffers, getHelper, getJoin, getLockType, getOffEnd, getOffEndListeners, getOriginalWhere, getRecordBuffers, getRow, getSortPhrase, getTableCount, hasConstraints, hasWhereExpression, honorRecordNursery, indexInformation, initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, initialize, load, makeAdaptiveServerJoinComponent, makePreselectServerJoinComponent, peekFirst, peekLast, peekNext, peekPrevious, prepareFetch, recordBuffers, registerRecordChangeListeners, releaseBuffers, reset, setFullRecords, setRecordAlreadyFound, setReferenceRecord, setResults, setUnknownRecord, silentFirst, silentFirst, silentLast, silentLast, silentNext, silentNext, silentPrevious, silentPrevious, silentUnique, silentUnique, stateChanged, translateWhere

Methods inherited from class com.goldencode.p2j.persist.DynamicQuery
_isOffEnd, backward, backward, currentRow, currentRowImpl, forward, forward, incrementMoves, isNativelyPreselect, isPreselect, isScrolling, open, reposition, reposition, repositionByID, repositionByID, repositionByID, reset, resetScrolling, setScrolling, size, verifyScrolling

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, createResultListEntry, deleteResultListEntry, 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, include, indexInformation, indexInformation, isBrowsed, isDynamicPredicate, isErrorIfNull, isFatalError, isFetchOnReposition, isFillingBrowseRows, isIndexedReposition, isIterating, isLastOfBreakGroup, isLenientOffEnd, isNewBreakGroup, isOffEnd, isOmitAlias, isOpen, isPresort, isRepositionNotificationActive, isSkipDeletedRecord, isStandalone, loadRowAtCursor, notifyQueryCloseListeners, notifyQueryOpenListeners, notifyRepositionListeners, numBuffers, numResults, numResults, prepare, prepare, 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, setLenientOffEnd, 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, toString, wait, wait, wait

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

Methods inherited from interface com.goldencode.p2j.persist.P2JQuery
_getNext, _isOffEnd, addAccumulator, addAccumulator, addQueryEventListener, addRepositionListener, backward, backward, changeForwardOnly, changeForwardOnly, createResultListEntry, currentRow, currentRowImpl, deleteResultListEntry, deleteResultListEntry, exclude, forward, forward, 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, hintFullResults, include, indexInformation, indexInformation, isBrowsed, isDynamicPredicate, isFetchOnReposition, isFillingBrowseRows, isFirstOfGroup, isFirstOfGroup, isIndexedReposition, isIterating, isLastOfGroup, isLastOfGroup, isNativelyPreselect, isOffEnd, isPreselect, isPresort, isScrolling, isSkipDeletedRecord, isStandalone, notifyQueryCloseListeners, notifyQueryOpenListeners, notifyRepositionListeners, open, prepare, prepare, prepareString, queryBackward, queryBackward, queryClose, queryForward, queryForward, queryOpen, queryReposition, queryReposition, queryRepositionByID, queryRepositionByID, removeRepositionListener, reposition, reposition, repositionByID, repositionByID, repositionByID, resetQuery, setBasicLogging, setBasicLogging, setBrowsed, setCache, setCache, setDataRelation, setDynamicPredicate, setFetchOnReposition, setFillingBrowseRows, setIndexedReposition, setIterating, setLenientOffEnd, setParameterFilter, setPresort, setScrolling, setSkipDeletedRecord, setStandalone, size

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

- Field Detail
  - canFindMode
```
private FindQuery.CanFind canFindMode
```
    Mode of this query if used for CAN-FIND.
  - readOnly
```
private boolean readOnly
```
    Flag indicating whether buffer is updated by query.
  - dmo
```
private DataModelObject dmo
```
    Data Model Object of the buffer in which the records will be retrived.
  - where
```
private java.lang.String where
```
    Where clause, using HQL syntax, can be null.
  - whereExpr
```
private java.util.function.Supplier<logical> whereExpr
```
    Client-side where clause expression, can be null.
  - sort
```
private java.lang.String sort
```
    Order by clause, using HQL syntax, can be null.
  inverse private DataModelObject inverse DMO to which this query should join via a foreign relation, can be null. args private java.lang.Object[] args Substitution parameters for HQL queries. lockType private LockType lockType Lock type to apply to records retrieved. initialized private boolean initialized If the query was already initialized.
Constructor Detail FindQuery public FindQuery(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, java.lang.String sort) Basic constructor which defaults record lock type to LockType.SHARE. Parameters: dmo - Data model object which determines the record buffer into which records are retrieved. where - Where clause, using HQL syntax. May be null. whereExpr - Client-side where clause expression. May be null. sort - Order by clause, using HQL syntax. May be null only if query is to be navigated only using one of the unique method variants. FindQuery public FindQuery(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, java.lang.String sort, DataModelObject inverse) Constructor which is used when joining to another table using a foreign key. Defaults record lock type to LockType.SHARE. Parameters: dmo - Data model object which determines the record buffer into which records are retrieved. where - Where clause, using HQL syntax. May be null. whereExpr - Client-side where clause expression. May be null. sort - Order by clause, using HQL syntax. May be null only if query is to be navigated only using one of the unique method variants. inverse - DMO to which this query should join via a foreign relation. May be null. FindQuery public FindQuery(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, java.lang.String sort, java.lang.Object[] args) Constructor which defaults record lock type to LockType.SHARE and accepts default substitution parameters. Parameters: dmo - Data model object which determines the record buffer into which records are retrieved. where - Where clause, using HQL syntax. May be null. whereExpr - Client-side where clause expression. May be null. sort - Order by clause, using HQL syntax. May be null only if query is to be navigated only using one of the unique method variants. args - Substitution parameters for HQL queries. These will be used if not overridden by a record retrieval method. Throws: java.lang.IllegalArgumentException - if any substitution argument provided is not of a supported type. FindQuery public FindQuery(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, java.lang.String sort, DataModelObject inverse, java.lang.Object[] args) Constructor which is used when joining to another table using a foreign key. Defaults record lock type to LockType.SHARE and accepts default substitution parameters. Parameters: dmo - Data model object which determines the record buffer into which records are retrieved. where - Where clause, using HQL syntax. May be null. whereExpr - Client-side where clause expression. May be null. sort - Order by clause, using HQL syntax. May be null only if query is to be navigated only using one of the unique method variants. inverse - DMO to which this query should join via a foreign relation. May be null. args - Substitution parameters for HQL queries. These will be used if not overridden by a record retrieval method. Throws: java.lang.IllegalArgumentException - if any substitution argument provided is not of a supported type. FindQuery public FindQuery(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, java.lang.String sort, LockType lockType) Constructor which sets an explicit, default, record lock type. Parameters: dmo - Data model object which determines the record buffer into which records are retrieved. where - Where clause, using HQL syntax. May be null. whereExpr - Client-side where clause expression. May be null. sort - Order by clause, using HQL syntax. May be null only if query is to be navigated only using one of the unique method variants. lockType - Lock type to apply to records retrieved, if not overridden by a record retrieval method. FindQuery public FindQuery(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, java.lang.String sort, DataModelObject inverse, LockType lockType) Constructor which is used when joining to another table using a foreign key. Sets an explicit, default, record lock type. Parameters: dmo - Data model object which determines the record buffer into which records are retrieved. where - Where clause, using HQL syntax. May be null. whereExpr - Client-side where clause expression. May be null. sort - Order by clause, using HQL syntax. May be null only if query is to be navigated only using one of the unique method variants. inverse - DMO to which this query should join via a foreign relation. May be null. lockType - Lock type to apply to records retrieved, if not overridden by a record retrieval method. FindQuery public FindQuery(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, java.lang.String sort, java.lang.Object[] args, LockType lockType) Constructor which sets an explicit, default, record lock type and accepts default substitution parameters. Parameters: dmo - Data model object which determines the record buffer into which records are retrieved. where - Where clause, using HQL syntax. May be null. whereExpr - Client-side where clause expression. May be null. sort - Order by clause, using HQL syntax. May be null only if query is to be navigated only using one of the unique method variants. args - Substitution parameters for HQL queries. These will be used if not overridden by a record retrieval method. lockType - Lock type to apply to records retrieved, if not overridden by a record retrieval method. Throws: java.lang.IllegalArgumentException - if any substitution argument provided is not of a supported type. FindQuery public FindQuery(DataModelObject dmo, java.lang.String where, java.util.function.Supplier<logical> whereExpr, java.lang.String sort, DataModelObject inverse, java.lang.Object[] args, LockType lockType) Constructor which is used when joining to another table using a foreign key. Sets an explicit, default, record lock type and accepts default substitution parameters. Parameters: dmo - Data model object which determines the record buffer into which records are retrieved. where - Where clause, using HQL syntax. May be null. whereExpr - Client-side where clause expression. May be null. sort - Order by clause, using HQL syntax. May be null only if query is to be navigated only using one of the unique method variants. inverse - DMO to which this query should join via a foreign relation. May be null. args - Substitution parameters for HQL queries. These will be used if not overridden by a record retrieval method. lockType - Lock type to apply to records retrieved, if not overridden by a record retrieval method. Throws: java.lang.IllegalArgumentException - if any substitution argument provided is not of a supported type. Method Detail setHasAny public FindQuery setHasAny() Set this query's can-find mode to 'any', meaning can it find any record which meets the query's criteria, regardless of duplicates. Returns: This instance, so that this method can be chained to the constructor and return this instance to the caller. setHasOne public FindQuery setHasOne() Set this query's can-find mode to 'one', meaning can it find one and only one record which meets the query's criteria. Returns: This instance, so that this method can be chained to the constructor and return this instance to the caller. hasAny public logical hasAny() Indicate whether a request to find the first result of this query would succeed or fail. Default substitution arguments and a lock type of NONE are used for this test. Specified by: hasAny in interface P2JQuery Overrides: hasAny in class AbstractQuery Returns: true if any record matching the query's criteria exists, else false. hasAny public logical hasAny(java.lang.Object[] values) Indicate whether a request to find the first result of this query would succeed or fail. The specified substitution arguments and a lock type of NONE are used for this test. Specified by: hasAny in interface P2JQuery Overrides: hasAny in class AbstractQuery Parameters: values - Query substitution parameters. Returns: true if any record matching the query's criteria exists, else false. hasAny public logical hasAny(LockType lockType) Indicate whether a request to find the first result of this query would succeed or fail. Default substitution arguments and the specified lock type are used for this test. Specified by: hasAny in interface P2JQuery Overrides: hasAny in class AbstractQuery Parameters: lockType - Lock type for the query. This lock is not actually acquired, only tested for availability. Returns: true if any record matching the query's criteria exists, else false. hasAny public logical hasAny(java.lang.Object[] values, LockType lockType) Indicate whether a request to find the first result of this query would succeed or fail. The specified substitution arguments and lock type are used for this test. Specified by: hasAny in interface P2JQuery Overrides: hasAny in class AbstractQuery Parameters: values - Query substitution parameters. lockType - Lock type for the query. This lock is not actually acquired, only tested for availability. Returns: true if any record matching the query's criteria exists, else false. hasOne public logical hasOne() Indicate whether this query would produce a unique result. Default substitution arguments and a lock type of NONE are used for this test. Specified by: hasOne in interface P2JQuery Overrides: hasOne in class AbstractQuery Returns: true if one and only one record matching the query's criteria exists, else false. hasOne public logical hasOne(java.lang.Object[] values) Indicate whether this query would produce a unique result. The specified substitution arguments and a lock type of NONE are used for this test. Specified by: hasOne in interface P2JQuery Overrides: hasOne in class AbstractQuery Parameters: values - Query substitution parameters. Returns: true if one and only one record matching the query's criteria exists, else false. hasOne public logical hasOne(LockType lockType) Indicate whether this query would produce a unique result. Default substitution arguments and the specified lock type are used for this test. Specified by: hasOne in interface P2JQuery Overrides: hasOne in class AbstractQuery Parameters: lockType - Lock type for the query. This lock is not actually acquired, only tested for availability. Returns: true if one and only one record matching the query's criteria exists, else false. hasOne public logical hasOne(java.lang.Object[] values, LockType lockType) Indicate whether this query would produce a unique result. The specified substitution arguments and lock type are used for this test. Specified by: hasOne in interface P2JQuery Overrides: hasOne in class AbstractQuery Parameters: values - Query substitution parameters. lockType - Lock type for the query. This lock is not actually acquired, only tested for availability. Returns: true if one and only one record matching the query's criteria exists, else false. first public boolean first() Navigate to the first record which meets the query criteria and retrieve it into its record buffer. Use the default substitution parameters and lock type. Specified by: first in interface P2JQuery Overrides: first in class RandomAccessQuery Returns: true if query could retrieve the first record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval or if no record could be found when operating in standalone mode. QueryOffEndException - if no record could be found when operating in compound query mode. first public boolean first(java.lang.Object[] values) Navigate to the first record which meets the query criteria and retrieve it into its record buffer. Use the default lock type, but override the default substitution parameters with those provided. Overrides: first in class RandomAccessQuery Parameters: values - Substitution values to use when issuing FQL queries. Returns: true if query could retrieve the last record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval or if no record could be found when operating in standalone mode. QueryOffEndException - if no record could be found when operating in compound query mode. first public boolean first(LockType lockType) Navigate to the first record which meets the query criteria and retrieve it into its record buffer. Use the default substitution parameters, but override the default lock type with that provided. Specified by: first in interface P2JQuery Overrides: first in class RandomAccessQuery Parameters: lockType - Lock type to acquire for the retrieved record. Returns: true if query could retrieve the last record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval or if no record could be found when operating in standalone mode. QueryOffEndException - if no record could be found when operating in compound query mode. first public boolean first(java.lang.Object[] values, LockType lockType) Navigate to the first record which meets the query criteria and retrieve it into its record buffer. Override both the default substitution parameters, and the default lock type with those provided. Overrides: first in class RandomAccessQuery Parameters: values - Substitution values to use when issuing FQL queries. lockType - Lock type to acquire for the retrieved record. Returns: true if query could retrieve the last record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval or if no record could be found when operating in standalone mode. QueryOffEndException - if no record could be found when operating in compound query mode. last public boolean last() Navigate to the last record which meets the query criteria and retrieve it into its record buffer. Use the default substitution parameters and lock type. Specified by: last in interface P2JQuery Overrides: last in class RandomAccessQuery Returns: true if query could retrieve the last record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval or if no record could be found when operating in standalone mode. QueryOffEndException - if no record could be found when operating in compound query mode. last public boolean last(java.lang.Object[] values) Navigate to the last record which meets the query criteria and retrieve it into its record buffer. Use the default lock type, but override the default substitution parameters with those provided. Overrides: last in class RandomAccessQuery Parameters: values - Substitution values to use when issuing FQL queries. Returns: true if query could retrieve the last record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval or if no record could be found when operating in standalone mode. QueryOffEndException - if no record could be found when operating in compound query mode. last public boolean last(LockType lockType) Navigate to the last record which meets the query criteria and retrieve it into its record buffer. Use the default substitution parameters, but override the default lock type with that provided. Specified by: last in interface P2JQuery Overrides: last in class RandomAccessQuery Parameters: lockType - Lock type to acquire for the retrieved record. Returns: true if query could retrieve the last record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval or if no record could be found when operating in standalone mode. QueryOffEndException - if no record could be found when operating in compound query mode. last public boolean last(java.lang.Object[] values, LockType lockType) Navigate to the last record which meets the query criteria and retrieve it into its record buffer. Override both the default substitution parameters, and the default lock type with those provided. Overrides: last in class RandomAccessQuery Parameters: values - Substitution values to use when issuing FQL queries. lockType - Lock type to acquire for the retrieved record. Returns: true if query could retrieve the last record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval or if no record could be found when operating in standalone mode. QueryOffEndException - if no record could be found when operating in compound query mode. next public boolean next() Navigate to the next record which meets the query criteria and retrieve it into its record buffer. Use the default substitution parameters and lock type. Use the record most recently loaded into the backing buffer as the reference point when determining the next record to visit. If no record has yet been loaded into the buffer, retrieve the first record which meets the query criteria. Specified by: next in interface P2JQuery Overrides: next in class RandomAccessQuery Returns: true if query could retrieve the next record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval. QueryOffEndException - if no record could be found. next public boolean next(java.lang.Object[] values) Navigate to the next record which meets the query criteria and retrieve it into its record buffer. Use the default lock type, but override the default substitution parameters with those provided. Use the record most recently loaded into the backing buffer as the reference point when determining the next record to visit. If no record has yet been loaded into the buffer, retrieve the first record which meets the query criteria. Overrides: next in class RandomAccessQuery Parameters: values - Substitution values to use when issuing FQL queries. Returns: true if query could retrieve the next record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval. QueryOffEndException - if no record could be found. next public boolean next(LockType lockType) Navigate to the next record which meets the query criteria and retrieve it into its record buffer. Use the default substitution parameters, but override the default lock type with that provided. Use the record most recently loaded into the backing buffer as the reference point when determining the next record to visit. If no record has yet been loaded into the buffer, retrieve the first record which meets the query criteria. Specified by: next in interface P2JQuery Overrides: next in class RandomAccessQuery Parameters: lockType - Lock type to acquire for the retrieved record. Returns: true if query could retrieve the next record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval. QueryOffEndException - if no record could be found. next public boolean next(java.lang.Object[] values, LockType lockType) Navigate to the next record which meets the query criteria and retrieve it into its record buffer. Override both the default substitution parameters, and the default lock type with those provided. Use the record most recently loaded into the backing buffer as the reference point when determining the next record to visit. If no record has yet been loaded into the buffer, retrieve the first record which meets the query criteria. Overrides: next in class RandomAccessQuery Parameters: values - Substitution values to use when issuing FQL queries. lockType - Lock type to acquire for the retrieved record. Returns: true if query could retrieve the next record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval. QueryOffEndException - if no record could be found and lenientOffEnd is false. previous public boolean previous() Navigate to the previous record which meets the query criteria and retrieve it into its record buffer. Use the default substitution parameters and lock type. Use the record most recently loaded into the backing buffer as the reference point when determining the previous record to visit. If no record has yet been loaded into the buffer, retrieve the last record which meets the query criteria. Specified by: previous in interface P2JQuery Overrides: previous in class RandomAccessQuery Returns: true if query could retrieve the previous record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval. QueryOffEndException - if no record could be found. previous public boolean previous(java.lang.Object[] values) Navigate to the previous record which meets the query criteria and retrieve it into its record buffer. Use the default lock type, but override the default substitution parameters with those provided. Use the record most recently loaded into the backing buffer as the reference point when determining the previous record to visit. If no record has yet been loaded into the buffer, retrieve the last record which meets the query criteria. Overrides: previous in class RandomAccessQuery Parameters: values - Substitution values to use when issuing FQL queries. Returns: true if query could retrieve the previous record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval. QueryOffEndException - if no record could be found. previous public boolean previous(LockType lockType) Navigate to the previous record which meets the query criteria and retrieve it into its record buffer. Use the default substitution parameters, but override the default lock type with that provided. Use the record most recently loaded into the backing buffer as the reference point when determining the previous record to visit. If no record has yet been loaded into the buffer, retrieve the last record which meets the query criteria. Specified by: previous in interface P2JQuery Overrides: previous in class RandomAccessQuery Parameters: lockType - Lock type to acquire for the retrieved record. Returns: true if query could retrieve the previous record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval. QueryOffEndException - if no record could be found. previous public boolean previous(java.lang.Object[] values, LockType lockType) Navigate to the previous record which meets the query criteria and retrieve it into its record buffer. Override both the default substitution parameters, and the default lock type with those provided. Use the record most recently loaded into the backing buffer as the reference point when determining the previous record to visit. If no record has yet been loaded into the buffer, retrieve the last record which meets the query criteria. Overrides: previous in class RandomAccessQuery Parameters: values - Substitution values to use when issuing FQL queries. lockType - Lock type to acquire for the retrieved record. Returns: true if query could retrieve the previous record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval. QueryOffEndException - if no record could be found and lenientOffEnd is false. current public boolean current() Reload the record most recently loaded into the backing record buffer, if any. Use the default lock type. Specified by: current in interface P2JQuery Overrides: current in class RandomAccessQuery Returns: true if query could retrieve the current record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record reload. current public boolean current(LockType lockType) Reload the record most recently loaded into the backing record buffer, if any. Override the default lock type. Specified by: current in interface P2JQuery Overrides: current in class RandomAccessQuery Parameters: lockType - New lock type to apply to the record. Returns: true if query could retrieve the current record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record reload, or the lock could not be transitioned to the requested type. unique public boolean unique() Navigate to a particular record which meets the query criteria and retrieve it into its record buffer. No more than one record may match the criteria. Use the default substitution parameters and lock type. Specified by: unique in interface P2JQuery Overrides: unique in class RandomAccessQuery Returns: true if query could retrieve the unique record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval or if more than one record is found which match the criteria. QueryOffEndException - if no record could be found when operating in compound query mode. unique public boolean unique(java.lang.Object[] values) Navigate to a particular record which meets the query criteria and retrieve it into its record buffer. No more than one record may match the criteria. Use the default lock type, but override the default substitution parameters with those provided. Overrides: unique in class RandomAccessQuery Parameters: values - Substitution values to use when issuing FQL queries. Returns: true if query could retrieve the unique record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval or if more than one record is found which match the criteria. QueryOffEndException - if no record could be found when operating in compound query mode. unique public boolean unique(LockType lockType) Navigate to a particular record which meets the query criteria and retrieve it into its record buffer. No more than one record may match the criteria. Use the default substitution parameters, but override the default lock type with that provided. Specified by: unique in interface P2JQuery Overrides: unique in class RandomAccessQuery Parameters: lockType - Lock type to acquire for the retrieved record. Returns: true if query could retrieve the unique record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval or if more than one record is found which match the criteria. QueryOffEndException - if no record could be found when operating in compound query mode. unique public boolean unique(java.lang.Object[] values, LockType lockType) Navigate to a particular record which meets the query criteria and retrieve it into its record buffer. No more than one record may match the criteria. Override both the default substitution parameters, and the default lock type with those provided. Overrides: unique in class RandomAccessQuery Parameters: values - Substitution values to use when issuing FQL queries. lockType - Lock type to acquire for the retrieved record. Returns: true if query could retrieve the unique record successfully; false if unsuccessful and lenientOffEnd is set on true. Throws: ErrorConditionException - if an error occurred during record retrieval or if more than one record is found which match the criteria. QueryOffEndException - if no record could be found when operating in compound query mode. isFindByRowid public boolean isFindByRowid() Indicate whether this query is a simple RECID/ROWID lookup FIND query. This has implications as to whether a 7254 error will be raised in the event this FIND is nested within a function called within another query's WHERE clause. Returns: true if this is a RECID/ROWID lookup FIND query, else false. addExternalBuffers public FindQuery addExternalBuffers(DataModelObject... dmos) Add one or more buffers to the list of those which this query references externally. These typically will be buffers referenced by converted CAN-FIND expressions embedded in the query's FQL expression, which are not the primary buffers associated with the query. Specified by: addExternalBuffers in interface P2JQuery Overrides: addExternalBuffers in class RandomAccessQuery Parameters: dmos - One or more external buffers. Returns: This query instance. initializeQuery public void initializeQuery() Initializes the query at the latest moment possible (right before executing a find operation). This method is compatible with silent mode operations, meaning that the exceptions LegacyErrorException and ErrorConditionException that are thrown when the query is initialized are caught and handled. Ensures the query is only initialized once. suppressNestedQueryError protected boolean suppressNestedQueryError() Indicate whether a nested query error should be suppressed (i.e., reported only as a warning, but not interrupt control flow), when detected while preprocessing this query's substitution parameters. Overrides: suppressNestedQueryError in class RandomAccessQuery Returns: false. registerChangeListener protected void registerChangeListener() This class doesn't need to register a change listener, so this method does nothing. Overrides: registerChangeListener in class RandomAccessQuery isIdOnly protected boolean isIdOnly() Override the parent's method to return true if this is a CAN-FIND, else delegate to the parent's implementation. Overrides: isIdOnly in class RandomAccessQuery Returns: true to produce a projection query, else false. prepareBuffer protected void prepareBuffer() throws ValidationException Prepare buffer associated with this query for the query's execution. If this query is in read-only mode, do nothing. Otherwise, invoke the superclass' implementation. Overrides: prepareBuffer in class RandomAccessQuery Throws: ValidationException - if the parent's implementation is invoked and a buffer flush triggers a validation error for the record currently stored in the buffer. updateBuffer protected void updateBuffer(Record dmo, LockType lockType, boolean errorIfNull, OffEnd offEnd) Update the record buffer with the given DMO, applying the specified lock type and error-if-null setting. This implementation causes the record buffer's internal placeholder snapshot to be reset if dmo is null. Overrides: updateBuffer in class RandomAccessQuery Parameters: dmo - Record to be stored in buffer. lockType - Lock type associated with the record, which will be remembered by the buffer. errorIfNull - If true, setting a null value as the current record in an underlying buffer will raise an error condition (if not in silent error mode); if false, this action will raise an end condition instead. offEnd - Enum indicating whether query is off-end, and if so, in which direction. handleExecuteException protected void handleExecuteException(LockUnavailableException exc) Override the superclass' implementation to throw an exception unconditionally when in read-only mode. This ensures that any locking error which occurs during a converted CAN-FIND is not reported to the user, but does affect the outcome of the CAN-FIND test. When the query is not in read-only mode, handling is delegated to the superclass' implementation. Overrides: handleExecuteException in class RandomAccessQuery Parameters: exc - Cause exception. handleExecuteException protected void handleExecuteException(ValidationException exc) Override the superclass' implementation to throw an exception unconditionally when in read-only mode. This ensures that any validation error which occurs during a converted CAN-FIND is not reported to the user, but does affect the outcome of the CAN-FIND test. When the query is not in read-only mode, handling is delegated to the superclass' implementation. Overrides: handleExecuteException in class RandomAccessQuery Parameters: exc - Cause exception. handleExecuteException protected void handleExecuteException(PersistenceException exc) Override the superclass' implementation to throw an exception unconditionally when in read-only mode. This ensures that any validation error which occurs during a converted CAN-FIND is not reported to the user, but does affect the outcome of the CAN-FIND test. When the query is not in read-only mode, handling is delegated to the superclass' implementation. Overrides: handleExecuteException in class RandomAccessQuery Parameters: exc - Cause exception. throwExceptionOnFatalError protected boolean throwExceptionOnFatalError() Test whether the first / last navigation will throw QueryOffEndException if the initialization failed. The super class must throw the exception if it fails the initialization in order to prematurely exit the loop on basic navigation. Now we are processing a simple FIND statement which does not require such thing because there is no loop to break. Overrides: throwExceptionOnFatalError in class RandomAccessQuery Returns: always false. canFindImpl private boolean canFindImpl(java.lang.Object[] values, LockType lockType) Indicate whether a record can be found with meets this query's criteria. The success of this search is governed by the can-find mode of this query: ANY: return true if any record can be found which meets the query's criteria, regardless of duplicates. If no such record is found, return false. ONE: return true if one and only one record can be found which meets the query's criteria. If no such record is found, or if more than one such record is found, return false. Parameters: values - Query substitution parameters lockType - Lock type to use when performing test. Lock is not actually acquired, only tested. Returns: See above. testLock private boolean testLock(Record dmo, LockType lockType) Test whether the specified lock type could be acquired for the given DMO, but do not actually acquire the lock. Note: because this method does not actually acquire the lock, it is not a reliable test, since another context could easily acquire the target lock after this method returns true, but before any further action is taken on that information in the current context. Parameters: dmo - DMO for which the lock test should occur. lockType - Lock type to test. Returns: true if the lock could be acquired at the moment of the test, else false.

Class FindQuery

Nested Class Summary

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

Field Summary

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

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.RandomAccessQuery

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

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

Methods inherited from class java.lang.Object

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

Field Detail

canFindMode

readOnly

dmo

where

whereExpr

sort

inverse

args

lockType

initialized

Constructor Detail

FindQuery

FindQuery

FindQuery

FindQuery

FindQuery

FindQuery

FindQuery

FindQuery

Method Detail

setHasAny

setHasOne

hasAny

hasAny

hasAny

hasAny

hasOne

hasOne

hasOne

hasOne

first

first

first

first

last

last

last

last

next

next

next

next

previous

previous

previous

previous

current

current

unique

unique

unique

unique

isFindByRowid

addExternalBuffers

initializeQuery

suppressNestedQueryError

registerChangeListener

isIdOnly

prepareBuffer

updateBuffer

handleExecuteException

handleExecuteException