com.webobjects.directtoweb
Class D2WQueryPage

java.lang.Object
  com.webobjects.appserver.WOElement
      com.webobjects.appserver.WOComponent
          com.webobjects.directtoweb.D2WComponent
              com.webobjects.directtoweb.D2WPage
                  com.webobjects.directtoweb.D2WQueryPage

All Implemented Interfaces:

Cloneable, com.webobjects.directtoweb.generation.DTWGeneration, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, QueryPageInterface, Serializable, WOActionResults

Direct Known Subclasses:

BASQueryPage, NEUQueryPage, WOLQueryPage

public class D2WQueryPage

extends D2WPage

implements QueryPageInterface, com.webobjects.directtoweb.generation.DTWGeneration

The D2WQueryPage class provides the behavior for the query page Direct to Web templates: BASQueryPage, NEUQueryPage, and WOLQueryPage. The classes for these components inherit directly from D2WQueryPage and define no additional methods or variables.

Most of the methods in this class are accessed, via the EOKeyValueCoding interface defined in the EOControl framework, from the bindings (.wod) file of the Direct to Web template. If you create a Direct to Web template from a query page, you can invoke the methods in this class in the same way.

See Also:

Serialized Form

Nested Class Summary

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

WOComponent.Event

Nested classes inherited from class com.webobjects.foundation.NSKeyValueCoding

NSKeyValueCoding.DefaultImplementation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.Null, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.Utility, NSKeyValueCoding.ValueAccessor

Nested classes inherited from class com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Nested classes inherited from class com.webobjects.foundation.NSValidation

NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException

Field Summary

WODisplayGroup

displayGroup The WODisplayGroup object that performs the query.

Fields inherited from class com.webobjects.directtoweb.D2WComponent

currentObjectKey

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

KeyPathSeparator

Constructor Summary

D2WQueryPage(WOContext aContext)
Creates an instance of D2WQueryPage with the specified context.

Method Summary

int	fetchLimit() Gets the maximum number of objects matching the query that the display group fetches.
String	fetchSpecOptions() Gets a String containing the state of the fetch specification options: isDeep, usesDistinct, refreshesRefetchedObjects, and fetchLimit.
boolean	isDeep() Indicates whether fetches should include sub-entities of the entity of the query fetch specification.
EOQualifier	qualifier() Gets the qualifier from query values of the display group.
WOComponent	queryAction() Is invoked when the user clicks Search in the query page.
EODataSource	queryDataSource() Returns the receiver's EODataSource (defined in the EOControl Framework).
boolean	refreshRefetchedObjects() Indicates whether existing objects are overwritten with fetched values when they have been updated or changed.
WOAssociation	replacementAssociationForAssociation(WOAssociation oldAssociation, String oldBinding, com.webobjects.directtoweb.generation.DTWTemplate aTemplate, WOContext aContext) Replace the binding queryAction.
void	setQueryDataSource(EODataSource newValue) Sets the query data source to the specified data source.
boolean	usesDistinct() Indicates whether duplicate objects or records are removed after fetching.

Methods inherited from class com.webobjects.directtoweb.D2WPage

alternateRowColor, dataSource, descriptionForResponse, extraBindings, finalize, nextPage, nextPageDelegate, pageWrapperName, setDataSource, setExtraBindings, setNextPage, setNextPageDelegate, showCancel

Methods inherited from class com.webobjects.directtoweb.D2WComponent

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

Methods inherited from class com.webobjects.appserver.WOComponent

appendToResponse, application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, invokeAction, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, reset, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, sleep, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, template, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForKey, valueForKeyPath

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

public WODisplayGroup displayGroup

The WODisplayGroup object that performs the query.

Constructor Detail

D2WQueryPage

public D2WQueryPage(WOContext aContext)

Creates an instance of D2WQueryPage with the specified context.

Parameters:

aContext - instance of WOContext

See Also:

D2WPage.D2WPage(WOContext)

Method Detail

fetchLimit

public int fetchLimit()

Gets the maximum number of objects matching the query that the display group fetches. The fetch limit is used by the fetch specification.

Returns:

the maximum number of objects fetched by the display group

fetchSpecOptions

public String fetchSpecOptions()

Gets a String containing the state of the fetch specification options: isDeep, usesDistinct, refreshesRefetchedObjects, and fetchLimit.

Returns:

a String containing the fetch specification options

See Also:

isDeep(), usesDistinct(), refreshRefetchedObjects(), fetchLimit()

isDeep

public boolean isDeep()

Indicates whether fetches should include sub-entities of the entity of the query fetch specification. Defaults to false. Is used by the fetch specification.

Returns:

true if fetches should include sub-entities; false otherwise

qualifier

public EOQualifier qualifier()

Gets the qualifier from query values of the display group.

See Also:

displayGroup, queryDataSource()

queryAction

public WOComponent queryAction()

Is invoked when the user clicks Search in the query page. Override nextPageDelegate to specify the search behavior.

Returns:

a list page

See Also:

D2WPage.nextPageDelegate()

queryDataSource

public EODataSource queryDataSource()

Description copied from interface: QueryPageInterface

Returns the receiver's EODataSource (defined in the EOControl Framework).

Specified by:

queryDataSource in interface QueryPageInterface

Returns:

a datasource initialized with a qualifier that matches the search criteria the user specified in the query page. This datasource, for example, could be passed on to a List page to display the results.

refreshRefetchedObjects

public boolean refreshRefetchedObjects()

Indicates whether existing objects are overwritten with fetched values when they have been updated or changed. Defaults to false. Is used by the fetch specification.

Returns:

true if existing objects are overwritten with fetched values when the values have been updated or changed; false otherwise

replacementAssociationForAssociation

public WOAssociation replacementAssociationForAssociation(WOAssociation oldAssociation,
                                                          String oldBinding,
                                                          com.webobjects.directtoweb.generation.DTWTemplate aTemplate,
                                                          WOContext aContext)

Replace the binding queryAction.

The implementation is subject to change in future releases.

Specified by:

replacementAssociationForAssociation in interface com.webobjects.directtoweb.generation.DTWGeneration

Overrides:

replacementAssociationForAssociation in class D2WPage

Parameters:

oldAssociation - instance of WOAssociation

oldBinding - instance of String

aTemplate - instance of DTWTemplate

aContext - instance of WOContext

Returns:

instance of WOAssociation

See Also:

queryAction(), D2WPage.replacementAssociationForAssociation(WOAssociation, String, DTWTemplate, WOContext)

setQueryDataSource

public void setQueryDataSource(EODataSource newValue)

Sets the query data source to the specified data source.

Parameters:

newValue - instance of EODataSource

See Also:

queryDataSource(), D2WPage.setDataSource(EODataSource)

usesDistinct

public boolean usesDistinct()

Indicates whether duplicate objects or records are removed after fetching. Defaults to false. Is used by the fetch specification.

Returns:

true if duplicates are removed after fetching; false otherwise