er.directtoweb.pages
Class ERD2WQueryPage

java.lang.Object
  com.webobjects.appserver.WOElement
      com.webobjects.appserver.WOComponent
          com.webobjects.directtoweb.D2WComponent
              com.webobjects.directtoweb.D2WPage
                  er.directtoweb.pages.ERD2WPage
                      er.directtoweb.pages.ERD2WQueryPage

All Implemented Interfaces:

WOActionResults, com.webobjects.directtoweb.generation.DTWGeneration, com.webobjects.directtoweb.QueryPageInterface, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, ERDBranchInterface, ERDQueryPageInterface, ERDUserInfoInterface, ERXComponentActionRedirector.Restorable, ERXExceptionHolder, Serializable, Cloneable

Direct Known Subclasses:

ERD2WQueryPageTemplate, ERD2WQueryPageWithFetchSpecification, ERD2WQueryPageWithFetchSpecificationTemplate, ERDIVQueryPage, ERLITQueryPage, ERNEUQueryPage

public class ERD2WQueryPage
extends ERD2WPage
implements ERDQueryPageInterface

Superclass for all query pages.
In addition to the rest of the goodies of ERD2WPage, it lets you save and restore the initial query bindings by supplying a NS(Mutable)Dictionary which contains the keys "queryMin", "queryMax" etc from the respective fields of the WODisplayGroup.

See Also:

Serialized Form

D2W Keys

fetchSpecificationName	fetchSpecificationName
enableQueryForNullValues	enableQueryForNullValues
isDeep	isDeep
usesDistinct	usesDistinct
refrehRefetchedObjects	refrehRefetchedObjects
fetchLimit	fetchLimit
prefetchingRelationshipKeyPaths	prefetchingRelationshipKeyPaths
showListInSamePage	showListInSamePage
listConfigurationName	listConfigurationName
queryDataSourceDelegate	queryDataSourceDelegate
queryValidationDelegate	queryValidationDelegate
enableQueryForNullValues	enableQueryForNullValues
canQueryPropertyForNullValues	canQueryPropertyForNullValues

Nested Class Summary

Nested classes/interfaces inherited from class er.directtoweb.pages.ERD2WPage

ERD2WPage.Keys

Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent

WOComponent._EventLoggingEnabler, WOComponent.Event

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

NSKeyValueCoding._BooleanFieldBinding, NSKeyValueCoding._BooleanMethodBinding, NSKeyValueCoding._FieldBinding, NSKeyValueCoding._ForwardingBinding, NSKeyValueCoding._KeyBinding, NSKeyValueCoding._KeyBindingCreation, NSKeyValueCoding._MethodBinding, NSKeyValueCoding._NumberFieldBinding, NSKeyValueCoding._NumberMethodBinding, NSKeyValueCoding._ReflectionKeyBindingCreation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.MapImplementation, NSKeyValueCoding.Null<T>, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.ValueAccessor

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSValidation

NSValidation._MethodBinding, NSValidation._ValidationBinding, NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException

Field Summary

protected NSArray	_nullablePropertyKeys
protected boolean	didLoadQueryBindings
protected WODisplayGroup	displayGroup
protected EOFetchSpecification	fetchSpecification
protected NSMutableDictionary	keysToQueryForNull
protected NSDictionary	queryBindings
protected ERDQueryDataSourceDelegateInterface	queryDataSourceDelegate
protected ERDQueryValidationDelegate	queryValidationDelegate
WOComponent	returnPage
protected Boolean	showResults

Fields inherited from class er.directtoweb.pages.ERD2WPage

_allConfigurations, _branch, _context, _nextPage, _nextPageDelegate, _pageController, _userInfo, errorKeyOrder, errorMessage, errorMessages, keyPathsWithValidationExceptions, log, validationLog

Fields inherited from class com.webobjects.directtoweb.D2WComponent

_eo, _localContext, currentObjectKey

Fields inherited from class com.webobjects.appserver.WOComponent

_Extension, _IsEventLoggingEnabled, _keyAssociations

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_CLASS, _KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSValidation

_CLASS

Constructor Summary

ERD2WQueryPage(WOContext context)

Method Summary

void	appendToResponse(WOResponse response, WOContext context) Overridden from the parent for better logging.
void	awake() Overridden to lock the page's editingContext, if there is any present.
WOComponent	cancelAction()
boolean	canQueryCurrentPropertyForNullValue() Determines if the null query checkbox can be shown for the current D2W property key should be checked.
WOComponent	clearAction()
protected void	createDisplayGroup()
EODataSource	defaultQueryDataSource() Default implementation of which assembles the data source for the search results page, configured for the current query.
WODisplayGroup	displayGroup() Gets the display group.
int	fetchLimit()
EOFetchSpecification	fetchSpecification()
String	fetchSpecificationName()
String	headerTemplate()
boolean	isDeep()
boolean	isNullQueryCheckedForCurrentProperty() Determines if the null query checkbox for the current D2W property key should be checked.
protected void	loadQueryBindings()
NSArray	nullablePropertyKeys() Discovers the property keys that can be queried for a NULL value.
NSArray	prefetchingRelationshipKeyPaths()
protected void	pullQueryBindingsForName(String name)
protected void	pushQueryBindingsForName(String name)
EOQualifier	qualifier()
WOComponent	queryAction()
NSDictionary	queryBindings()
EODataSource	queryDataSource() Assembles the data source for the search results page, configured for the current query.
ERDQueryDataSourceDelegateInterface	queryDataSourceDelegate() Gets the query data source delegate.
EOFetchSpecification	queryFetchSpecification()
ERDQueryValidationDelegate	queryValidationDelegate() Gets the query validation delegate.
boolean	refreshRefetchedObjects()
WOComponent	returnAction()
protected void	saveQueryBindings()
void	setCancelDelegate(com.webobjects.directtoweb.NextPageDelegate cancelDelegate)
void	setFetchSpecification(EOFetchSpecification value)
void	setFetchSpecificationName(String value)
void	setIsNullQueryCheckedForCurrentProperty(boolean value) Sets the flag denoting a property key is being queried for a null value.
void	setQueryBindings(NSDictionary dictionary)
void	setQueryDataSource(EODataSource datasource) Sets the query data source.
void	setQueryDataSourceDelegate(ERDQueryDataSourceDelegateInterface delegate) Sets the query data source delegate.
void	setQueryMatchForKey(Object value, String operator, String key) Set a search value for the display group query match.
void	setQueryValidationDelegate(ERDQueryValidationDelegate delegate) Sets the query validation delegate.
void	setShowResults(boolean value)
boolean	showCancel()
boolean	showResults()
protected void	substituteValueForNullableQueryKeys() When querying for properties with a null value, and the null value checkbox for a property key is checked, this method substitutes NSKeyValueCoding.NullValue into the display group's query dictionaries for that property key.
void	takeValuesFromRequest(WORequest request, WOContext context) Overridden from the parent for better logging.
boolean	usesDistinct()

Methods inherited from class er.directtoweb.pages.ERD2WPage

aggregateEventDurationForCurrentPropertyKey, allConfigurationNames, branch, branchChoices, branchName, clearTabSectionsContents, clearValidationFailed, clickToOpenEnabled, cssClassForPageContainerElement, cssClassForPropertyKey, cssClassForPropertyName, currentSection, currentSectionKeys, currentTab, d2wComponentNameDebuggingEnabled, d2wContext, d2wCurrentComponentName, d2wDebuggingEnabled, descriptionForResponse, displayVariant, editingContext, errorKeyOrder, errorMessage, errorMessages, hasActualChanges, hasBranchChoices, hasErrors, hasValidationExceptionForPropertyKey, inlineStyleDeclarationForPropertyKey, inlineStyleDeclarationForPropertyName, invokeAction, isEmbedded, isEntityEditable, isEntityReadOnly, isKeyOmitted, isObjectDeleteable, isObjectEditable, isObjectInspectable, isTopLevelPage, latestEntryForCurrentPropertyKey, makeStatsKey, nextPage, nextPageDelegate, nextPageFromDelegate, now, object, pageController, pageWithName, pageWrapperName, sectionsContents, sectionsForCurrentTab, self, setBranch, setCurrentSection, setCurrentTab, setD2wContext, setDataSource, setEditingContext, setErrorMessage, setErrorMessages, setLocalContext, setNextPage, setNextPageDelegate, setObject, setPageController, settings, shouldCollectValidationExceptions, shouldDisplayDetailedPageMetrics, shouldDisplayPageMetricsSummary, shouldPropagateExceptions, shouldSetFailedValidationValue, sleep, statsForPage, statsKeyForCurrentPropertyKey, statsKeyPrefix, tabSectionsContents, tabSectionsContentsFromRuleResult, urlForCurrentState, userInfo, userPreferencesValueForKey, userPreferencesValueForPageConfigurationKey, validationFailedWithException

Methods inherited from class com.webobjects.directtoweb.D2WPage

alternateRowColor, dataSource, extraBindings, finalize, replacementAssociationForAssociation, setExtraBindings

Methods inherited from class com.webobjects.directtoweb.D2WComponent

allEntities, allowCollapsing, applicationPort, assistantPort, attribute, backgroundColorForHeaderRow, backgroundColorForPage, backgroundColorForTable, backgroundColorForTableDark, backgroundColorForTableLight, color, currentSettings, currentUrl, d2wContextVisibleEntityNamesCountPlus1, defaultRowspan, displayNameForKeyWhenRelationship, displayNameForProperty, displayPropertyKeys, dynamicPages, entity, entityName, formatter, generationReplacementFor, generationReplacementForCurrentObject, hasCustomKey, hasEntity, hasNoColor, homeClicked, homeHref, isEditing, isEntityReadOnly, isLiveAssistantEnabled, isNotBoldAsBoolean, isNotItalicAsBoolean, isPropertyAnAttribute, isWebAssistantActive, isWebAssistantConnected, isWebAssistantEnabled, keyForGenerationReplacementForVariableNamed, keyWhenRelationship, lastUrl, length, localContext, logout, objectPropertyValue, objectPropertyValueIsNonNull, pageTitle, property, propertyKey, propertyValueClassName, relationship, resourcePathURL, sessionID, setCurrentSettings, setDynamicPages, setEntities, setEntity, setEntityName, setPropertyKey, setResourcePathURL, setTask, setTasks, showBanner, showWebAssistant, submitActionName, target, task, tasks, visibleEntityNames

Methods inherited from class com.webobjects.appserver.WOComponent

__valueForBinding, _associationWithName, _awakeInContext, _childTemplate, _cleanUpStatelessComponent, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, application, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, reset, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, valueForBinding, valueForBooleanBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding, variableValueForName, variableWithName

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.webobjects.directtoweb.QueryPageInterface

setNextPageDelegate

Field Detail

displayGroup

protected WODisplayGroup displayGroup

didLoadQueryBindings

protected boolean didLoadQueryBindings

queryBindings

protected NSDictionary queryBindings

fetchSpecification

protected EOFetchSpecification fetchSpecification

queryDataSourceDelegate

protected ERDQueryDataSourceDelegateInterface queryDataSourceDelegate

queryValidationDelegate

protected ERDQueryValidationDelegate queryValidationDelegate

_nullablePropertyKeys

protected NSArray _nullablePropertyKeys

keysToQueryForNull

protected NSMutableDictionary keysToQueryForNull

showResults

protected Boolean showResults

returnPage

public WOComponent returnPage

Constructor Detail

ERD2WQueryPage

public ERD2WQueryPage(WOContext context)

Method Detail

createDisplayGroup

protected void createDisplayGroup()

pullQueryBindingsForName

protected void pullQueryBindingsForName(String name)

clearAction

public WOComponent clearAction()

fetchSpecification

public EOFetchSpecification fetchSpecification()

setFetchSpecification

public void setFetchSpecification(EOFetchSpecification value)

setFetchSpecificationName

public void setFetchSpecificationName(String value)

fetchSpecificationName

public String fetchSpecificationName()

queryFetchSpecification

public EOFetchSpecification queryFetchSpecification()

pushQueryBindingsForName

protected void pushQueryBindingsForName(String name)

takeValuesFromRequest

public void takeValuesFromRequest(WORequest request,
                                  WOContext context)

Description copied from class: ERD2WPage

Overridden from the parent for better logging. Also clears validation errors

Overrides:

takeValuesFromRequest in class ERD2WPage

appendToResponse

public void appendToResponse(WOResponse response,
                             WOContext context)

Description copied from class: ERD2WPage

Overridden from the parent for better logging. Reports exceptions in the console for easier debugging.

Overrides:

appendToResponse in class ERD2WPage

saveQueryBindings

protected void saveQueryBindings()

loadQueryBindings

protected void loadQueryBindings()

awake

public void awake()

Description copied from class: ERD2WPage

Overridden to lock the page's editingContext, if there is any present.

Overrides:

awake in class ERD2WPage

isDeep

public boolean isDeep()

queryBindings

public NSDictionary queryBindings()

setQueryBindings

public void setQueryBindings(NSDictionary dictionary)

usesDistinct

public boolean usesDistinct()

refreshRefetchedObjects

public boolean refreshRefetchedObjects()

fetchLimit

public int fetchLimit()

prefetchingRelationshipKeyPaths

public NSArray prefetchingRelationshipKeyPaths()

qualifier

public EOQualifier qualifier()

showResults

public boolean showResults()

setShowResults

public void setShowResults(boolean value)

queryAction

public WOComponent queryAction()

cancelAction

public WOComponent cancelAction()

returnAction

public WOComponent returnAction()

showCancel

public boolean showCancel()

Overrides:

showCancel in class ERD2WPage

queryDataSource

public EODataSource queryDataSource()

Assembles the data source for the search results page, configured for the current query. If a queryDataSourceDelegate() is defined, the delegate's implementation is invoked. Otherwise, the defaultQueryDataSource() is returned.

Specified by:

queryDataSource in interface com.webobjects.directtoweb.QueryPageInterface

Specified by:

queryDataSource in interface ERDQueryPageInterface

Returns:

the prepared data source

setQueryDataSource

public void setQueryDataSource(EODataSource datasource)

Sets the query data source.

Parameters:

datasource - to be used as the query data source

defaultQueryDataSource

public EODataSource defaultQueryDataSource()

Default implementation of which assembles the data source for the search results page, configured for the current query.

Returns:

the prepared data source

queryDataSourceDelegate

public ERDQueryDataSourceDelegateInterface queryDataSourceDelegate()

Gets the query data source delegate.

Returns:

the query data source delegate

setQueryDataSourceDelegate

public void setQueryDataSourceDelegate(ERDQueryDataSourceDelegateInterface delegate)

Sets the query data source delegate.

Parameters:

delegate - to use as the query data source delegate

queryValidationDelegate

public ERDQueryValidationDelegate queryValidationDelegate()

Gets the query validation delegate.

Returns:

the query validation delegate

setQueryValidationDelegate

public void setQueryValidationDelegate(ERDQueryValidationDelegate delegate)

Sets the query validation delegate.

Parameters:

delegate - to use as the query validation delegate

displayGroup

public WODisplayGroup displayGroup()

Gets the display group.

Returns:

the display group

headerTemplate

public String headerTemplate()

setQueryMatchForKey

public void setQueryMatchForKey(Object value,
                                String operator,
                                String key)

Set a search value for the display group query match. When the value is null is gets removed from the dict, when the operator is null and the value isn't, "=" is chosen. When operator is "<" is uses queryMatch(), if it is ">" is uses queryMin(), so you can use it with the various date range components.

Specified by:

setQueryMatchForKey in interface ERDQueryPageInterface

Parameters:

value - to assign to the queryMatch dictionary for the given key

operator - used for comparing the value

key - to use

setCancelDelegate

public void setCancelDelegate(com.webobjects.directtoweb.NextPageDelegate cancelDelegate)

Specified by:

setCancelDelegate in interface ERDQueryPageInterface

nullablePropertyKeys

public NSArray nullablePropertyKeys()

Discovers the property keys that can be queried for a NULL value.

Returns:

the array of nullable and/or non-mandatory property keys

isNullQueryCheckedForCurrentProperty

public boolean isNullQueryCheckedForCurrentProperty()

Determines if the null query checkbox for the current D2W property key should be checked.

Returns:

true if the checkbox should be checked

setIsNullQueryCheckedForCurrentProperty

public void setIsNullQueryCheckedForCurrentProperty(boolean value)

Sets the flag denoting a property key is being queried for a null value.

Parameters:

value - of the checkbox' checked attribute

canQueryCurrentPropertyForNullValue

public boolean canQueryCurrentPropertyForNullValue()

Determines if the null query checkbox can be shown for the current D2W property key should be checked.

Returns:

true if the checkbox should be checked

substituteValueForNullableQueryKeys

protected void substituteValueForNullableQueryKeys()

When querying for properties with a null value, and the null value checkbox for a property key is checked, this method substitutes NSKeyValueCoding.NullValue into the display group's query dictionaries for that property key.