er.directtoweb.assignments.defaults

Class ERDDefaultIDAssignment

java.lang.Object

com.webobjects.directtoweb.Assignment

er.directtoweb.assignments.ERDAssignment

er.directtoweb.assignments.defaults.ERDDefaultIDAssignment

All Implemented Interfaces:

EOKeyValueArchiving, ERDComputingAssignmentInterface, Serializable

public class ERDDefaultIDAssignment
extends ERDAssignment

An assignment to auto-compute a unique(ish), human-readable DOM ids from the d2wContext for Selenium, CSS, Ajax, Javascript, etc. For Ajax updates you may also use this assignment to compute an updateContainerID key (by setting it to idForSection, idForPageConfiguration, etc. as required). This assignment provids defaults for the following keys:

• idForProperty
• idForSection
• idForPageConfiguration
• idForEmbeddedPageConfiguration
• idForEmbeddedProperty
• idForForm

To use: Bind D2W component id binding to d2wContext.id (or d2wContext.idForProperty or d2wContext.idForSection, etc) You may also override these auto computed id by setting rules for the above keys, if necessary.

See Also:

Serialized Form

Author:

mendis

Nested Class Summary

Nested classes/interfaces inherited from interface com.webobjects.eocontrol.EOKeyValueArchiving

EOKeyValueArchiving._NullValueSupport, EOKeyValueArchiving._NumberSupport, EOKeyValueArchiving._TimestampSupport, EOKeyValueArchiving.Awaking, EOKeyValueArchiving.FinishInitialization, EOKeyValueArchiving.Support

Field Summary

Fields

Modifier and Type	Field and Description
protected static NSDictionary	keys holds the array of keys this assignment depends upon

Fields inherited from class er.directtoweb.assignments.ERDAssignment

D2WContextClassArray, log

Fields inherited from class com.webobjects.directtoweb.Assignment

KeyPathKey, ValueKey

Fields inherited from interface com.webobjects.eocontrol.EOKeyValueArchiving

_CLASS

Constructor Summary

Constructors

Constructor and Description
ERDDefaultIDAssignment(EOKeyValueUnarchiver u) Public constructor
ERDDefaultIDAssignment(String key, Object value) Public constructor

Method Summary

Modifier and Type	Method and Description
static Object	decodeWithKeyValueUnarchiver(EOKeyValueUnarchiver eokeyvalueunarchiver) Static constructor required by the EOKeyValueUnarchiver interface.
NSArray	dependentKeys(String keyPath) Implementation of the ERDComputingAssignmentInterface.
Object	idForEmbeddedPageConfiguration(com.webobjects.directtoweb.D2WContext c) A DOM id based on the pageConfig + primaryKey
Object	idForEmbeddedProperty(com.webobjects.directtoweb.D2WContext c) a DOM id based on the triple <task, entity, propertyKey, pk>
Object	idForForm(com.webobjects.directtoweb.D2WContext c) A DOM id based on the pageConfig
Object	idForPageConfiguration(com.webobjects.directtoweb.D2WContext c) A DOM id based on the pageConfig
Object	idForProperty(com.webobjects.directtoweb.D2WContext c) a DOM id based on the triple <task, entity, propertyKey>
Object	idForSection(com.webobjects.directtoweb.D2WContext c) A DOM id based on the pageConfig and sectionKey

Methods inherited from class er.directtoweb.assignments.ERDAssignment

booleanContextValueForKey, fire, keyForMethodLookup, localizedTemplateStringForKeyInContext, localizedValueForKeyInContext, localizedValueForKeyWithDefaultInContext, localizerForContext, logDeprecatedMessage

Methods inherited from class com.webobjects.directtoweb.Assignment

encodeWithKeyValueArchiver, keyPath, toString, value, value

Methods inherited from class java.lang.Object

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

Field Detail

keys

protected static final NSDictionary keys

holds the array of keys this assignment depends upon

Constructor Detail

ERDDefaultIDAssignment

public ERDDefaultIDAssignment(EOKeyValueUnarchiver u)

Public constructor

Parameters:

u - key-value unarchiver used when unarchiving from rule files.

ERDDefaultIDAssignment

public ERDDefaultIDAssignment(String key,
                              Object value)

Public constructor

Parameters:

key - context key

value - of the assignment

Method Detail

dependentKeys

public NSArray dependentKeys(String keyPath)

Implementation of the ERDComputingAssignmentInterface. This array of keys is used when constructing the significant keys for the passed in keyPath.

Parameters:

keyPath - to compute significant keys for.

Returns:

array of context keys this assignment depends upon.

decodeWithKeyValueUnarchiver

public static Object decodeWithKeyValueUnarchiver(EOKeyValueUnarchiver eokeyvalueunarchiver)

Static constructor required by the EOKeyValueUnarchiver interface. If this isn't implemented then the default behavior is to construct the first super class that does implement this method. Very lame.

Parameters:

eokeyvalueunarchiver - to be unarchived

Returns:

decoded assignment of this class

idForProperty

public Object idForProperty(com.webobjects.directtoweb.D2WContext c)

a DOM id based on the triple <task, entity, propertyKey>

Parameters:

c - d2w context

Returns:

an id representing the <task, entity, propertyKey> TODO Maybe change to pageConfig + propertyKey?

idForEmbeddedProperty

public Object idForEmbeddedProperty(com.webobjects.directtoweb.D2WContext c)

a DOM id based on the triple <task, entity, propertyKey, pk>

Parameters:

c - d2w context

Returns:

an id representing the <task, entity, propertyKey, pk> TODO Maybe change to pageConfig + propertyKey?

idForPageConfiguration

public Object idForPageConfiguration(com.webobjects.directtoweb.D2WContext c)

A DOM id based on the pageConfig

Parameters:

c - d2w context

Returns:

an id representing the <task, entity>

idForEmbeddedPageConfiguration

public Object idForEmbeddedPageConfiguration(com.webobjects.directtoweb.D2WContext c)

A DOM id based on the pageConfig + primaryKey

Parameters:

c - d2w context

Returns:

an id representing the <task, entity, pk>

idForSection

public Object idForSection(com.webobjects.directtoweb.D2WContext c)

A DOM id based on the pageConfig and sectionKey

Parameters:

c - d2w context

Returns:

an id representing the section in a tab page

idForForm

public Object idForForm(com.webobjects.directtoweb.D2WContext c)

A DOM id based on the pageConfig

Parameters:

c - d2w context

Returns:

an id representing the form for the d2w page