WebObjects 5.4.2

com.webobjects.directtoweb
Class D2WQueryToOneField

java.lang.Object
  extended by com.webobjects.appserver.WOElement
      extended by com.webobjects.appserver.WOComponent
          extended by com.webobjects.directtoweb.D2WComponent
              extended by com.webobjects.directtoweb.D2WStatelessComponent
                  extended by com.webobjects.directtoweb.QueryComponent
                      extended by com.webobjects.directtoweb.D2WQueryToOneField
All Implemented Interfaces:
WOActionResults, DTWGeneration, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, Cloneable

public class D2WQueryToOneField
extends QueryComponent

The D2WQueryToOneField class is a property-level component that builds a query based on the value for a particular key of a destination object of a to-one relationship. It does not traverse the relationship.

Property-level components are not accessed programmatically. Instead, you use the Web Assistant or Rule Editor to choose the property-level component that Direct to Web uses to display a property on a particular entity and task page.

If you want to create a property-level component to query based on a property, use D2WCustomQueryComponent.

See Also:
D2WQueryToOneRelationship, D2WCustomQueryComponent, Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent
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.NSValidation
NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException
 
Field Summary
 
Fields inherited from class com.webobjects.directtoweb.D2WComponent
currentObjectKey
 
Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions
KeyPathSeparator
 
Constructor Summary
D2WQueryToOneField(WOContext aContext)
          Creates an instance of D2WQueryToOneField with the specified context.
 
Method Summary
 WOAssociation replacementAssociationForAssociation(WOAssociation oldAssociation, String oldBinding, DTWTemplate aTemplate, WOContext aContext)
          Replaces the binding value.
 void reset()
          Clears the local value.
 void setValue(Object newValue)
          Sets the value to the specified new value.
 Object value()
          Gets the value.
 
Methods inherited from class com.webobjects.directtoweb.QueryComponent
displayGroup
 
Methods inherited from class com.webobjects.directtoweb.D2WStatelessComponent
d2wContext, isStateless, localContext, object
 
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, isEntityReadOnly, isLiveAssistantEnabled, isNotBoldAsBoolean, isNotItalicAsBoolean, isPropertyAnAttribute, isWebAssistantActive, isWebAssistantConnected, isWebAssistantEnabled, keyForGenerationReplacementForVariableNamed, keyWhenRelationship, lastUrl, length, logout, 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, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, invokeAction, isCachingEnabled, isEventLoggingEnabled, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, sleep, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForBooleanBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding, variableValueForName, variableWithName
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

D2WQueryToOneField

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

Parameters:
aContext - instance of WOContext
See Also:
QueryComponent.QueryComponent(WOContext)
Method Detail

value

public Object value()
Gets the value.

Provides the value for a WOTextField. The current implementation invokes the valueForKey method on the query match of the display group.

The implementation is subject to change in future releases.

Overrides:
value in class QueryComponent
Returns:
the value
See Also:
D2WQueryToOneField.setValue(Object)

setValue

public void setValue(Object newValue)
Sets the value to the specified new value.

Overrides:
setValue in class QueryComponent
Parameters:
newValue - the new value
See Also:
D2WQueryToOneField.value()

reset

public void reset()
Clears the local value.

Is needed because the current implementation uses lazy initialization to get the value in the value method.

The implementation is subject to change in future releases.

Overrides:
reset in class QueryComponent
See Also:
D2WQueryToOneField.value(), QueryComponent.reset()

replacementAssociationForAssociation

public WOAssociation replacementAssociationForAssociation(WOAssociation oldAssociation,
                                                          String oldBinding,
                                                          DTWTemplate aTemplate,
                                                          WOContext aContext)
Replaces the binding value.

The implementation is subject to change in future releases.

Specified by:
replacementAssociationForAssociation in interface DTWGeneration
Overrides:
replacementAssociationForAssociation in class QueryComponent
Parameters:
oldAssociation - instance of WOAssociation
oldBinding - instance of String
aTemplate - instance of DTWTemplate
aContext - instance of WOContext
Returns:
instance of WOAssociation
See Also:
D2WQueryToOneField.value(), QueryComponent.replacementAssociationForAssociation(WOAssociation, String, DTWTemplate, WOContext)

Last updated June 2008

Copyright © 2000-2008 Apple Inc.