com.goldencode.p2j.persist

Class AdaptiveComponent

java.lang.Object

com.goldencode.p2j.persist.QueryComponent

com.goldencode.p2j.persist.AdaptiveComponent

All Implemented Interfaces:

QueryConstants

public class AdaptiveComponent
extends QueryComponent

A query component implementation which extends QueryComponent to store additional information needed when reverting an adaptive query from preselect to dynamic query mode.

Nested Class Summary

Nested classes/interfaces inherited from class com.goldencode.p2j.persist.QueryComponent

QueryComponent.ServerJoinData

Field Summary

Fields

Modifier and Type	Field and Description
private DMOSorter	dmoSorter DMO sorter associated with this component's sort clause
private java.lang.Object[]	dynamicArgs Substitution arguments for this component when in dynamic mode
private FQLPreprocessor	dynamicFQLPreprocessor HQL preprocessor used for dynamic mode
private boolean	dynamicSortMode Flag denoting whether this component is already in dynamic sort mode or not.
private CompoundComponent	fallback Compound query component fallback for multi-table, dynamic operation
private java.lang.Long	globalEventID Event registration ID used to gather index modification events
private DataModelObject	inverse DMO to which this component should join via a foreign relation.
private long	lastGlobalEventID ID of last index modification event retrieved from clearinghouse
private static CentralLogger	LOG Logger
private java.lang.String	originalSort HQL sort clause associated with this query component, original.
private java.lang.String	originalStaticSort Copy of the original HQL sort clause associated with this query component.
private java.util.List<SortCriterion>	sortCriteria Sort criteria associated with this query component.
private java.util.List<SortCriterion>	staticSortCriteria Copy of the original sort criteria associated with this query component.

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
AdaptiveComponent(AdaptiveQuery query, BufferReference proxy, AbstractJoin join, java.lang.String where, java.util.function.Supplier<java.lang.String> translateWhere, java.lang.String sort, java.lang.String indexInfo, LockType lockType, java.lang.Object[] args, int iteration, boolean outer, BufferReference inverse) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addDynamicSortCriterion(FieldReference fr, boolean asc) Adds a new sorting criterion as the strongest criterion for sorting the result of this query.
(package private) void	cleanup() Clean up when this component is no longer in use.
void	clearDynamicSortCriteria() Clears all dynamically added criteria.
protected java.lang.Object[]	getArgs() Get substitution arguments for this component, resolving them first if necessary.
(package private) DMOSorter	getDMOSorter() Get the DMO sorter associated with this the index used to sort for this query component.
(package private) CompoundComponent	getFallback() Get the fallback compound component, which is used in the event an optimized, compound, adaptive query if forced from preselect mode to dynamic mode.
protected FQLPreprocessor	getHQLPreprocessor() Get the HQL preprocessor associated with this component.
(package private) DataModelObject	getInverse() Get DMO (proxy) to which this component should join via a foreign relation.
protected java.lang.String	getOriginalSort() Get sort criteria in HQL order by clause format for this component.
(package private) java.util.List<SortCriterion>	getSortCriteria() Get the list of sort criteria associated with this query component.
(package private) void	initialize() Initialize instance variables which could not be set at construction, because they required a scope to first be opened on the backing buffer.
(package private) boolean	isDirty(boolean localOnly) Collect and process global events which describe changes made to DMO objects in other sessions.
protected FQLPreprocessor	prepareHQLPreprocessor(java.lang.Object[] queryArgs) Create the HQLPreprocessor which backs this component.
(package private) void	processGlobalEvents() Collect and process global events which describe changes made to DMO objects in other sessions.
private void	registerForGlobalEvents() Register to receive global DMO change events, which may cause the current result set of the containing query to be invalidated.
protected void	resetHQLPreprocessor() Reset both the preselect and dynamic HQL preprocessors, so that they need to be recreated the next time one is requested.
(package private) void	setFallback(CompoundComponent fallback) Set the fallback compound component, which is used in the event an optimized, compound, adaptive query if forced from preselect mode to dynamic mode.

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

addDynamicFilter, clearDynamicFilters, compositeJoins, enableTranslateWhere, filterArgs, getBuffer, getDefinitionBuffer, getEnclosingQuery, getIndexInfo, getIteration, getJoin, getLockType, getOriginalWhere, getRawArgs, getReferencedBuffers, getRestrictionProperties, getSortIndex, getWhere, isIdOnly, isOuter, prepareServerJoinData, processDynamicFilters, resetArgs, setBuffer, setIteration, setNotTop, setReferenceSubs, setRelatedBuffers, setSortIndex, translateWhere

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final CentralLogger LOG

Logger

originalSort

private java.lang.String originalSort

HQL sort clause associated with this query component, original. This is parsed at runtime and used to create the sortCriteria list.

originalStaticSort

private java.lang.String originalStaticSort

Copy of the original HQL sort clause associated with this query component. This temporary copy of original static sort criteria (originalSort) is only valid while dynamic sorting criteria are in effect. It is not directly accessed otherwise except when the dynamic sorting is reverted, the original originalSort is restored.

inverse

private final DataModelObject inverse

DMO to which this component should join via a foreign relation.

sortCriteria

private java.util.List<SortCriterion> sortCriteria

Sort criteria associated with this query component.

staticSortCriteria

private java.util.List<SortCriterion> staticSortCriteria

Copy of the original sort criteria associated with this query component. This temporary copy of original static sort criteria (sortCriteria) is only valid while dynamic sorting criteria are in effect. It is not directly accessed otherwise except when the dynamic sorting is reverted, the original sortCriteria is restored.

dmoSorter

private DMOSorter dmoSorter

DMO sorter associated with this component's sort clause

dynamicFQLPreprocessor

private FQLPreprocessor dynamicFQLPreprocessor

HQL preprocessor used for dynamic mode

dynamicArgs

private java.lang.Object[] dynamicArgs

Substitution arguments for this component when in dynamic mode

fallback

private CompoundComponent fallback

Compound query component fallback for multi-table, dynamic operation

globalEventID

private java.lang.Long globalEventID

Event registration ID used to gather index modification events

lastGlobalEventID

private long lastGlobalEventID

ID of last index modification event retrieved from clearinghouse

dynamicSortMode

private boolean dynamicSortMode

Flag denoting whether this component is already in dynamic sort mode or not.

Constructor Detail

AdaptiveComponent

AdaptiveComponent(AdaptiveQuery query,
                  BufferReference proxy,
                  AbstractJoin join,
                  java.lang.String where,
                  java.util.function.Supplier<java.lang.String> translateWhere,
                  java.lang.String sort,
                  java.lang.String indexInfo,
                  LockType lockType,
                  java.lang.Object[] args,
                  int iteration,
                  boolean outer,
                  BufferReference inverse)

Constructor.

Parameters:

query - Enclosing adaptive query.

proxy - Reference to record buffer updated by this component of the query.

join - Helper object for a join via a foreign key relation. May be null.

where - Restriction criteria in HQL where clause format.

translateWhere - A function to translate the where clause, just before it gets executed.

sort - Sort criteria in HQL order by clause format.

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.

lockType - Requested record lock type.

args - Default (unresolved) query substitution arguments.

iteration - Type of iteration: FIRST, LAST, NEXT, PREVIOUS, or UNIQUE.

outer - true if this component is joined with the previous component via an outer join; false if there is no previous component, or if this component is joined with the previous component via an inner join.

inverse - DMO to which this query should join via a foreign relation. May be null.

Method Detail

getHQLPreprocessor

protected FQLPreprocessor getHQLPreprocessor()
                                      throws PersistenceException

Get the HQL preprocessor associated with this component. This may return different preprocessors, depending upon whether the query is currently in preselect vs. dynamic mode.

Overrides:

getHQLPreprocessor in class QueryComponent

Returns:

HQL preprocessor.

Throws:

PersistenceException - if the preprocessor must first be created, and there is an error during its creation.

prepareHQLPreprocessor

protected FQLPreprocessor prepareHQLPreprocessor(java.lang.Object[] queryArgs)
                                          throws PersistenceException

Create the HQLPreprocessor which backs this component.

This method overrides the parent's implementation to also create a secondary HQL preprocessor for use in dynamic fetch mode. This secondary version does not inline any substitution parameters. If the primary version did not inline any such parameters, then both the primary and secondary preprocessors will be the same object.

Overrides:

prepareHQLPreprocessor in class QueryComponent

Parameters:

queryArgs - Query substitution parameters used in the preprocessor's creation.

Returns:

Primary HQL preprocessor (i.e., the version appropriate for use with the enclosing query's preselect mode).

Throws:

PersistenceException - if there is an error creating the preprocessor.

getArgs

protected java.lang.Object[] getArgs()
                              throws PersistenceException

Get substitution arguments for this component, resolving them first if necessary. This may return different arguments, depending upon whether the query is in preselect or dynamic mode.

Overrides:

getArgs in class QueryComponent

Returns:

Substitution arguments.

Throws:

PersistenceException - if there is any error creating the FQL preprocessor, which is necessary to properly filter/order the arguments.

resetHQLPreprocessor

protected void resetHQLPreprocessor()

Reset both the preselect and dynamic HQL preprocessors, so that they need to be recreated the next time one is requested.

Overrides:

resetHQLPreprocessor in class QueryComponent

initialize

void initialize()
         throws PersistenceException

Initialize instance variables which could not be set at construction, because they required a scope to first be opened on the backing buffer.

Throws:

PersistenceException - if there is a database or parsing error.

getFallback

CompoundComponent getFallback()

Get the fallback compound component, which is used in the event an optimized, compound, adaptive query if forced from preselect mode to dynamic mode.

Returns:

Compound query fallback component.

setFallback

void setFallback(CompoundComponent fallback)

Set the fallback compound component, which is used in the event an optimized, compound, adaptive query if forced from preselect mode to dynamic mode.

Parameters:

fallback - Compound query fallback component.

processGlobalEvents

void processGlobalEvents()

Collect and process global events which describe changes made to DMO objects in other sessions. The processing of such events may cause the containing query's current results to be invalidated.

isDirty

boolean isDirty(boolean localOnly)

Collect and process global events which describe changes made to DMO objects in other sessions. The processing of such events may cause the containing query's current results to be invalidated.

Parameters:

localOnly - Check if the component is dirty only in the current dirty context.

Returns:

true if this component operated over a table with dirty changes.

getSortCriteria

java.util.List<SortCriterion> getSortCriteria()

Get the list of sort criteria associated with this query component.

Returns:

An unmodifiable list of sort components.

getOriginalSort

protected java.lang.String getOriginalSort()

Get sort criteria in HQL order by clause format for this component.

Returns:

HQL order by clause, before being rewritten by the SortCriterion class.

getInverse

DataModelObject getInverse()

Get DMO (proxy) to which this component should join via a foreign relation.

Returns:

Inverse DMO proxy or null if no such join is defined for this query.

getDMOSorter

DMOSorter getDMOSorter()

Get the DMO sorter associated with this the index used to sort for this query component.

Returns:

DMO sorter associated with this component's index.

cleanup

void cleanup()

Clean up when this component is no longer in use. This involves deregistering for global events, if the component was registered for the same.

registerForGlobalEvents

private void registerForGlobalEvents()

Register to receive global DMO change events, which may cause the current result set of the containing query to be invalidated.

addDynamicSortCriterion

public void addDynamicSortCriterion(FieldReference fr,
                                    boolean asc)

Adds a new sorting criterion as the strongest criterion for sorting the result of this query. The other criteria remain queued, but with lower priority.

Use clearDynamicSortCriteria() to clean all dynamically added criteria and restore the sorting order of the query to its original form.

Parameters:

fr - A reference to field used as new strongest criterion. The current criteria will be kept, but with lower priority.

asc - The direction of sorting for this criterion. Use true for ascending sort and false for descending sorting.

clearDynamicSortCriteria

public void clearDynamicSortCriteria()

Clears all dynamically added criteria.