atg.droplet
Class DropletDescriptor

java.lang.Object
  atg.droplet.BaseDropletDescriptor
      atg.droplet.DropletDescriptor

All Implemented Interfaces:

DropletConstants

public class DropletDescriptor
extends BaseDropletDescriptor

Caches the information needed to make efficient reflection calls to Droplet handler methods. A handle corresponds either to a property or a method of the form:

handlePropertyName(ServletRequest, ServletResponse)

Each descriptor is associated with a particular java class. If the referenced component's class changes, a new descriptor has to be created.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from interface atg.droplet.DropletConstants

DROPLET_ANCHOR_QUALIFIER, DROPLET_ANCHOR_VALUE, DROPLET_ARGUMENTS, DROPLET_BEAN_PREFIX, DROPLET_BEFORE_GET_ATTRIBUTE, DROPLET_EVENT_ATTRIBUTE, DROPLET_EVENT_PREFIX, DROPLET_EXCEPTIONS_ATTRIBUTE, DROPLET_PARAM_PREFIX, DROPLET_PROPERTY_PREFIX, DROPLET_SESSION_CONF, DROPLET_SUBMIT_VALUE_PREFIX, OBJECT_BEFORE_GET_ATTRIBUTE, PRIORITY_DEFAULT, SUBMIT_PRIORITY_DEFAULT, UNCHECKED_DROPLET_EXCEPTIONS_ATTRIBUTE

Method Summary

static java.lang.Boolean	convertBoolean(java.lang.String pValue) These methods perform the valueOf function after trimming whitespace
static java.lang.Byte	convertByte(java.lang.String pValue)
static java.lang.Character	convertCharacter(java.lang.String pValue) This method fills in the role of the valueOf method for the Character class.
static java.lang.Class	convertClass(java.lang.String pValue)
static java.lang.Double	convertDouble(java.lang.String pValue)
static java.lang.Float	convertFloat(java.lang.String pValue)
static java.lang.Integer	convertInteger(java.lang.String pValue)
static java.lang.Long	convertLong(java.lang.String pValue)
static java.lang.Byte	convertNumberToByte(java.lang.Number pValue)
static java.lang.Double	convertNumberToDouble(java.lang.Number pValue)
static java.lang.Float	convertNumberToFloat(java.lang.Number pValue)
static java.lang.Integer	convertNumberToInteger(java.lang.Number pValue)
static java.lang.Long	convertNumberToLong(java.lang.Number pValue)
static java.lang.Short	convertNumberToShort(java.lang.Number pValue)
static java.awt.Point	convertPoint(java.lang.String pValue)
static java.lang.Short	convertShort(java.lang.String pValue)
static UploadedFile	convertUploadedFile(java.lang.String pValue)
static java.lang.String	evalDynamicDimensions(PropertyName pPropertyPath, DynamoHttpServletRequest pRequest) Goes through the dimensions string and replaces the param: and property: values with their current values.
static java.lang.String	evalDynamicDimensions(java.lang.String pPropertyPath, DynamoHttpServletRequest pRequest) Goes through the dimensions string and replaces the param: and property: values with their current values.
static DropletDescriptor	getDropletDescriptor(java.lang.Class pClass, java.lang.Class pHandleParamOne, java.lang.Class pHandleParamTwo, java.lang.String pPropertyName) Returns the property descriptor for the specified class and property name.
static DropletDescriptor	getDropletDescriptor(java.lang.Class pClass, java.lang.String pPropertyName) Returns the property descriptor for the specified class and property name.
java.lang.reflect.Method	getGetMethod()
java.lang.reflect.Method	getHandleMethod()
static java.lang.String	getPropertyHtmlStringValue(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, PropertyName pPropertyName, boolean pCallBeforeGet, TagConverter pConverter, java.util.Properties pConverterArgs) Returns the string property value for the specified component and the specified path.
static java.lang.String	getPropertyHtmlStringValue(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, java.lang.String pPropertyPath, boolean pCallBeforeGet, TagConverter pConverter, java.util.Properties pConverterArgs) Returns the string property value for the specified component and the specified path.
static java.lang.String	getPropertyHtmlStringValue(DynamoHttpServletRequest pRequest, java.lang.String pPropertyPath) Returns the string property value for the specified component and the specified path.
static java.lang.String	getPropertyStringValue(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, PropertyName pPropertyName, boolean pCallBeforeGet, TagConverter pConverter, java.util.Properties pConverterArgs) Returns the string property value for the specified component and the specified path.
static java.lang.String	getPropertyStringValue(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, java.lang.String pPropertyPath, boolean pCallBeforeGet, TagConverter pConverter, java.util.Properties pConverterArgs) Returns the string property value for the specified component and the specified path.
static java.lang.String	getPropertyStringValue(DynamoHttpServletRequest pRequest, PropertyName pPropertyPath) Returns the string property value for the specified component and the specified path.
static java.lang.String	getPropertyStringValue(DynamoHttpServletRequest pRequest, java.lang.String pPropertyPath) Returns the string property value for the specified component and the specified path.
static java.lang.Object	getPropertyValue(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, PropertyName pPropertyPath, boolean pCallBeforeGet, TagConverter pConverter, java.util.Properties pConverterArgs) Returns the object property value for the specified component and the specified path.
static java.lang.Object	getPropertyValue(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, java.lang.String pPropertyPath, boolean pCallBeforeGet, TagConverter pConverter, java.util.Properties pConverterArgs) Returns the object property value for the specified component and the specified path.
static java.lang.Object	getPropertyValue(DynamoHttpServletRequest pRequest, PropertyName pPropertyPath) Returns the object property value for the specified component and the specified path.
static java.lang.Object	getPropertyValue(DynamoHttpServletRequest pRequest, java.lang.String pPropertyPath) Returns the object property value for the specified component and the specified path.
java.lang.reflect.Method	getSetMethod()
static boolean	hasPropertyValue(DynamoHttpServletRequest pRequest, PropertyName pPropertyName) Returns true if the specified property path name has a value for the specified request.
static boolean	hasPropertyValue(DynamoHttpServletRequest pRequest, java.lang.String pPropertyName) Returns true if the specified property path name has a value for the specified request.
static boolean	matchesPropertyValue(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, PropertyName pPropertyName, java.lang.String pValue, boolean pCallBeforeGet, TagConverter pConverter, java.util.Properties pConverterArgs) Returns true if the specified value matches the value of the property specified in pPropertyName.
static boolean	matchesPropertyValue(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, java.lang.String pPropertyPath, java.lang.String pValue, boolean pCallBeforeGet, TagConverter pConverter, java.util.Properties pConverterArgs) Returns true if the specified value matches the value of the property specified in pPropertyPath.
static boolean	matchesPropertyValue(DynamoHttpServletRequest pRequest, java.lang.String pPropertyPath, java.lang.String pValue) Returns true if the specified value matches the value of the property specified in pPropertyPath.
protected void	setCvtType(java.lang.Class pPropertyType, java.lang.String pName) Sets the cvtMethod member variable that we use to convert a string value to an object of the right parameter type
static boolean	setPropertyValue(DynamoHttpServletRequest pReq, DynamoHttpServletResponse pRes, java.lang.String pPropertyPath, java.lang.Object pValue) This method sets the property value specified by the pPropertyPath parameter to the value specified by the pValue parameter.
static boolean	setPropertyValue(DynamoHttpServletRequest pReq, DynamoHttpServletResponse pRes, java.lang.String pPropertyPath, java.lang.Object pValue, TagConverter pConverter, java.util.Properties pConverterArgs) This method sets the property value specified by the pPropertyPath parameter to the value specified by the pValue parameter.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Method Detail

getPropertyHtmlStringValue

public static java.lang.String getPropertyHtmlStringValue(DynamoHttpServletRequest pRequest,
                                                          java.lang.String pPropertyPath)
                                                   throws javax.servlet.ServletException

Returns the string property value for the specified component and the specified path. This version performs escaping of HTML specific characters such as < and >.

Parameters:

pPropertyPath - the path name to the property in the form:

{component path}/{component path}.{property}.{property}

Returns:

the value of the property

Throws:

javax.servlet.ServletException - thrown if an error occurs trying to find the component, or trying to get one of the property values.

getPropertyHtmlStringValue

public static java.lang.String getPropertyHtmlStringValue(DynamoHttpServletRequest pRequest,
                                                          DynamoHttpServletResponse pResponse,
                                                          java.lang.String pPropertyPath,
                                                          boolean pCallBeforeGet,
                                                          TagConverter pConverter,
                                                          java.util.Properties pConverterArgs)
                                                   throws javax.servlet.ServletException

Returns the string property value for the specified component and the specified path. This version can also be used to call the beforeGet method of classes that implement the DropletFormHandler interface if this is the first time that a property has been accessed for this request. It also escapes HTML specific characters such as &lgt; and >.

Parameters:

pPropertyPath - the path name to the property in the form:

{component path}/{component path}.{property}.{property}

pCallBeforeGet - true if the beforeGet method of DropletFormHandler components should be called if this is the first time that a property of this component has been accessed for this request.

Returns:

the value of the property

Throws:

javax.servlet.ServletException - thrown if an error occurs trying to find the component, or trying to get one of the property values.

getPropertyHtmlStringValue

public static java.lang.String getPropertyHtmlStringValue(DynamoHttpServletRequest pRequest,
                                                          DynamoHttpServletResponse pResponse,
                                                          PropertyName pPropertyName,
                                                          boolean pCallBeforeGet,
                                                          TagConverter pConverter,
                                                          java.util.Properties pConverterArgs)
                                                   throws javax.servlet.ServletException

Returns the string property value for the specified component and the specified path. This version can also be used to call the beforeGet method of classes that implement the DropletFormHandler interface if this is the first time that a property has been accessed for this request. It also escapes HTML specific characters such as &lgt; and >. This version uses PropertyName instead of a string to refer to the property.

Parameters:

pPropertyName - the path name to the property in the form:

{component path}/{component path}.{property}.{property}

pCallBeforeGet - true if the beforeGet method of DropletFormHandler components should be called if this is the first time that a property of this component has been accessed for this request.

Returns:

the value of the property

Throws:

javax.servlet.ServletException - thrown if an error occurs trying to find the component, or trying to get one of the property values.

getPropertyStringValue

public static java.lang.String getPropertyStringValue(DynamoHttpServletRequest pRequest,
                                                      java.lang.String pPropertyPath)
                                               throws javax.servlet.ServletException

Returns the string property value for the specified component and the specified path.

Parameters:

pPropertyPath - the path name to the property in the form:

{component path}/{component path}.{property}.{property}

Returns:

the value of the property

Throws:

javax.servlet.ServletException - thrown if an error occurs trying to find the component, or trying to get one of the property values.

getPropertyStringValue

public static java.lang.String getPropertyStringValue(DynamoHttpServletRequest pRequest,
                                                      DynamoHttpServletResponse pResponse,
                                                      java.lang.String pPropertyPath,
                                                      boolean pCallBeforeGet,
                                                      TagConverter pConverter,
                                                      java.util.Properties pConverterArgs)
                                               throws javax.servlet.ServletException

Returns the string property value for the specified component and the specified path. This version can also be used to call the beforeGet method of classes that implement the DropletFormHandler interface if this is the first time that a property has been accessed for this request.

Parameters:

pPropertyPath - the path name to the property in the form:

{component path}/{component path}.{property}.{property}

pCallBeforeGet - true if the beforeGet method of DropletFormHandler components should be called if this is the first time that a property of this component has been accessed for this request.

Returns:

the value of the property

Throws:

javax.servlet.ServletException - thrown if an error occurs trying to find the component, or trying to get one of the property values.

getPropertyStringValue

public static java.lang.String getPropertyStringValue(DynamoHttpServletRequest pRequest,
                                                      DynamoHttpServletResponse pResponse,
                                                      PropertyName pPropertyName,
                                                      boolean pCallBeforeGet,
                                                      TagConverter pConverter,
                                                      java.util.Properties pConverterArgs)
                                               throws javax.servlet.ServletException

Returns the string property value for the specified component and the specified path. This version can also be used to call the beforeGet method of classes that implement the DropletFormHandler interface if this is the first time that a property has been accessed for this request.

Parameters:

pPropertyName - the PropertyName for the property in the form.

pCallBeforeGet - true if the beforeGet method of DropletFormHandler components should be called if this is the first time that a property of this component has been accessed for this request.

Returns:

the value of the property

Throws:

javax.servlet.ServletException - thrown if an error occurs trying to find the component, or trying to get one of the property values.

matchesPropertyValue

public static boolean matchesPropertyValue(DynamoHttpServletRequest pRequest,
                                           java.lang.String pPropertyPath,
                                           java.lang.String pValue)
                                    throws javax.servlet.ServletException

Returns true if the specified value matches the value of the property specified in pPropertyPath. A match occurs if the property is a scalar if the string value of the property equals the string provided. For arrays, a match occurs if any element of the array matches the string value provided.

Throws:

javax.servlet.ServletException

matchesPropertyValue

public static boolean matchesPropertyValue(DynamoHttpServletRequest pRequest,
                                           DynamoHttpServletResponse pResponse,
                                           java.lang.String pPropertyPath,
                                           java.lang.String pValue,
                                           boolean pCallBeforeGet,
                                           TagConverter pConverter,
                                           java.util.Properties pConverterArgs)
                                    throws javax.servlet.ServletException

Returns true if the specified value matches the value of the property specified in pPropertyPath. A match occurs if the property is a scalar if the string value of the property equals the string provided. For arrays, a match occurs if any element of the array matches the string value provided.

This version of this method can be used to call the beforeGet method of the component if this is the first time that the components value has been accessed in this request.

Parameters:

pCallBeforeGet - true if the beforeGet method of DropletFormHandler components should be called if this is the first time that a property of this component has been accessed for this request.

Throws:

javax.servlet.ServletException

matchesPropertyValue

public static boolean matchesPropertyValue(DynamoHttpServletRequest pRequest,
                                           DynamoHttpServletResponse pResponse,
                                           PropertyName pPropertyName,
                                           java.lang.String pValue,
                                           boolean pCallBeforeGet,
                                           TagConverter pConverter,
                                           java.util.Properties pConverterArgs)
                                    throws javax.servlet.ServletException

Returns true if the specified value matches the value of the property specified in pPropertyName. A match occurs if the property is a scalar if the string value of the property equals the string provided. For arrays, a match occurs if any element of the array matches the string value provided.

This version of this method can be used to call the beforeGet method of the component if this is the first time that the components value has been accessed in this request.

Parameters:

pPropertyName - the property name to match against.

pCallBeforeGet - true if the beforeGet method of DropletFormHandler components should be called if this is the first time that a property of this component has been accessed for this request.

Throws:

javax.servlet.ServletException

getPropertyValue

public static java.lang.Object getPropertyValue(DynamoHttpServletRequest pRequest,
                                                PropertyName pPropertyPath)
                                         throws javax.servlet.ServletException

Returns the object property value for the specified component and the specified path.

Parameters:

pPropertyPath - the path name to the property in the form:

{component path}.{property}.{property}

Returns:

the value of the property

Throws:

javax.servlet.ServletException - thrown if an error occurs trying to find the component, or trying to get one of the property values.

getPropertyValue

public static java.lang.Object getPropertyValue(DynamoHttpServletRequest pRequest,
                                                DynamoHttpServletResponse pResponse,
                                                PropertyName pPropertyPath,
                                                boolean pCallBeforeGet,
                                                TagConverter pConverter,
                                                java.util.Properties pConverterArgs)
                                         throws javax.servlet.ServletException

Returns the object property value for the specified component and the specified path. This version can be used to call the beforeGet method of a DropletFormHandler component.

Parameters:

pPropertyPath - the path name to the property in the form:

{component path}.{property}.{property}

pCallBeforeGet - true if the beforeGet method of DropletFormHandler components should be called if this is the first time that a property of this component has been accessed for this request.

Returns:

the value of the property

Throws:

javax.servlet.ServletException - thrown if an error occurs trying to find the component, or trying to get one of the property values.

getPropertyValue

public static java.lang.Object getPropertyValue(DynamoHttpServletRequest pRequest,
                                                java.lang.String pPropertyPath)
                                         throws javax.servlet.ServletException

Returns the object property value for the specified component and the specified path.

Parameters:

pPropertyPath - the path name to the property in the form:

{component path}.{property}.{property}

Returns:

the value of the property

Throws:

javax.servlet.ServletException - thrown if an error occurs trying to find the component, or trying to get one of the property values.

getPropertyStringValue

public static java.lang.String getPropertyStringValue(DynamoHttpServletRequest pRequest,
                                                      PropertyName pPropertyPath)
                                               throws javax.servlet.ServletException

Returns the string property value for the specified component and the specified path.

Parameters:

pPropertyPath - the path name to the property in the form:

{component path}/{component path}.{property}.{property}

Returns:

the value of the property

Throws:

javax.servlet.ServletException - thrown if an error occurs trying to find the component, or trying to get one of the property values.

getPropertyValue

public static java.lang.Object getPropertyValue(DynamoHttpServletRequest pRequest,
                                                DynamoHttpServletResponse pResponse,
                                                java.lang.String pPropertyPath,
                                                boolean pCallBeforeGet,
                                                TagConverter pConverter,
                                                java.util.Properties pConverterArgs)
                                         throws javax.servlet.ServletException

Returns the object property value for the specified component and the specified path. This version can be used to call the beforeGet method of a DropletFormHandler component.

Parameters:

pPropertyPath - the path name to the property in the form:

{component path}.{property}.{property}

pCallBeforeGet - true if the beforeGet method of DropletFormHandler components should be called if this is the first time that a property of this component has been accessed for this request.

Returns:

the value of the property

Throws:

javax.servlet.ServletException - thrown if an error occurs trying to find the component, or trying to get one of the property values.

setPropertyValue

public static boolean setPropertyValue(DynamoHttpServletRequest pReq,
                                       DynamoHttpServletResponse pRes,
                                       java.lang.String pPropertyPath,
                                       java.lang.Object pValue)
                                throws javax.servlet.ServletException,
                                       java.io.IOException

This method sets the property value specified by the pPropertyPath parameter to the value specified by the pValue parameter.

Parameters:

pReq - the request (which is passed to handleXXX methods)

pRes - the response (which is passed to handleXXX methods)

pPropertyPath - the path name to the property in the form:

{component path}.{property}.{property}

pValue - the value of the property

Throws:

javax.servlet.ServletException - thrown if an error occurs trying to find the component, or trying to get one of the intermediate property values, or trying to set the final property value. A ServletException can also be thrown by one of the handleXXX methods, in which case that exception is propagated up through this call.

java.io.IOException - thrown if the handleXXX methods throws an IOException

setPropertyValue

public static boolean setPropertyValue(DynamoHttpServletRequest pReq,
                                       DynamoHttpServletResponse pRes,
                                       java.lang.String pPropertyPath,
                                       java.lang.Object pValue,
                                       TagConverter pConverter,
                                       java.util.Properties pConverterArgs)
                                throws javax.servlet.ServletException,
                                       java.io.IOException

This method sets the property value specified by the pPropertyPath parameter to the value specified by the pValue parameter.

Parameters:

pReq - the request (which is passed to handleXXX methods)

pRes - the response (which is passed to handleXXX methods)

pPropertyPath - the path name to the property in the form:

{component path}.{property}.{property}

pValue - the value of the property

Throws:

javax.servlet.ServletException - thrown if an error occurs trying to find the component, or trying to get one of the intermediate property values, or trying to set the final property value. A ServletException can also be thrown by one of the handleXXX methods, in which case that exception is propagated up through this call.

java.io.IOException - thrown if the handleXXX methods throws an IOException

evalDynamicDimensions

public static java.lang.String evalDynamicDimensions(PropertyName pPropertyPath,
                                                     DynamoHttpServletRequest pRequest)
                                              throws javax.servlet.ServletException

Goes through the dimensions string and replaces the param: and property: values with their current values. The process of resolving dimension values is done in two steps so that we can use the evaluated propertyPath (i.e. the path with [param:xxx] changed to [0]) as a key into the Form's table of tags, even though it is slightly less efficient this way.

Throws:

javax.servlet.ServletException

evalDynamicDimensions

public static java.lang.String evalDynamicDimensions(java.lang.String pPropertyPath,
                                                     DynamoHttpServletRequest pRequest)
                                              throws javax.servlet.ServletException

Goes through the dimensions string and replaces the param: and property: values with their current values. The process of resolving dimension values is done in two steps so that we can use the evaluated propertyPath (i.e. the path with [param:xxx] changed to [0]) as a key into the Form's table of tags, even though it is slightly less efficient this way.

Throws:

javax.servlet.ServletException

hasPropertyValue

public static boolean hasPropertyValue(DynamoHttpServletRequest pRequest,
                                       java.lang.String pPropertyName)

Returns true if the specified property path name has a value for the specified request. Beans that don't have a get method for this property or if the get method returns null do not have a property.

hasPropertyValue

public static boolean hasPropertyValue(DynamoHttpServletRequest pRequest,
                                       PropertyName pPropertyName)

Returns true if the specified property path name has a value for the specified request. Beans that don't have a get method for this property or if the get method returns null do not have a property. This version takes a PropertyName to avoid the extra hashtable lookup.

getDropletDescriptor

public static DropletDescriptor getDropletDescriptor(java.lang.Class pClass,
                                                     java.lang.String pPropertyName)
                                              throws DropletException

Returns the property descriptor for the specified class and property name.

Throws:

DropletException

getDropletDescriptor

public static DropletDescriptor getDropletDescriptor(java.lang.Class pClass,
                                                     java.lang.Class pHandleParamOne,
                                                     java.lang.Class pHandleParamTwo,
                                                     java.lang.String pPropertyName)
                                              throws DropletException

Returns the property descriptor for the specified class and property name. The handle method returned from this DropletDescriptor must take two parameters of type pParamOne and pParam two.

Parameters:

pClass -

pHandleParamOne -

pHandleParamTwo -

pPropertyName -

Returns:

Throws:

DropletException

setCvtType

protected void setCvtType(java.lang.Class pPropertyType,
                          java.lang.String pName)
                   throws DropletException

Sets the cvtMethod member variable that we use to convert a string value to an object of the right parameter type

This must be a static member of the class that takes a single String parameter and returns an object of the appropriate type.

Throws:

DropletException

getGetMethod

public java.lang.reflect.Method getGetMethod()

getSetMethod

public java.lang.reflect.Method getSetMethod()

getHandleMethod

public java.lang.reflect.Method getHandleMethod()

convertCharacter

public static java.lang.Character convertCharacter(java.lang.String pValue)

This method fills in the role of the valueOf method for the Character class.

convertPoint

public static java.awt.Point convertPoint(java.lang.String pValue)

convertBoolean

public static java.lang.Boolean convertBoolean(java.lang.String pValue)

These methods perform the valueOf function after trimming whitespace

convertByte

public static java.lang.Byte convertByte(java.lang.String pValue)

convertDouble

public static java.lang.Double convertDouble(java.lang.String pValue)

convertFloat

public static java.lang.Float convertFloat(java.lang.String pValue)

convertInteger

public static java.lang.Integer convertInteger(java.lang.String pValue)

convertLong

public static java.lang.Long convertLong(java.lang.String pValue)

convertShort

public static java.lang.Short convertShort(java.lang.String pValue)

convertNumberToDouble

public static java.lang.Double convertNumberToDouble(java.lang.Number pValue)

convertNumberToFloat

public static java.lang.Float convertNumberToFloat(java.lang.Number pValue)

convertNumberToInteger

public static java.lang.Integer convertNumberToInteger(java.lang.Number pValue)

convertNumberToLong

public static java.lang.Long convertNumberToLong(java.lang.Number pValue)

convertNumberToShort

public static java.lang.Short convertNumberToShort(java.lang.Number pValue)

convertNumberToByte

public static java.lang.Byte convertNumberToByte(java.lang.Number pValue)

convertClass

public static java.lang.Class convertClass(java.lang.String pValue)

convertUploadedFile

public static UploadedFile convertUploadedFile(java.lang.String pValue)