er.extensions.validation

Class ERXValidationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.webobjects.foundation.NSValidation.ValidationException

er.extensions.validation.ERXValidationException

All Implemented Interfaces:

com.webobjects.foundation.NSKeyValueCoding, Serializable

Direct Known Subclasses:

ERAttachmentProcessor.ERXAttachmentExceedsLengthException

public class ERXValidationException
extends com.webobjects.foundation.NSValidation.ValidationException
implements com.webobjects.foundation.NSKeyValueCoding

ERXValidationExceptions extends the regular NSValidation.ValidationException to add template based resolution of the validation exception. See more information about resolving templates in the ERXValidationFactory.

See Also:

Serialized Form

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected com.webobjects.foundation.NSKeyValueCoding	_context holds a reference to the context of the exception
protected NSArray<com.webobjects.foundation.NSValidation.ValidationException>	additionalExceptions caches any set additionalExceptions
static String	CustomMethodException corresponds to a custom method exception
protected Object	delegate holds a reference to the exception delegate
static String	ExceedsMaximumLengthException corresponds to a model thrown 'maximum length of attribute exceeded' exception
static String	InvalidNumberException corresponds to a number formatter exception
static String	InvalidValueException corresponds to a generic 'invalid value' exception
static String	MandatoryToManyRelationshipException corresponds to a model thrown 'mandatory toMany relationship' exception
static String	MandatoryToOneRelationshipException corresponds to a model thrown 'mandatory toOne relationship' exception
protected String	message caches the validation message
protected String	method holds the method if one is provided
static String	NullPropertyException corresponds to a model thrown 'null property' exception
protected Object	object holds the object that failed validation
static String	ObjectRemovalException corresponds to a model thrown 'object removal' exception
static String	ObjectsRemovalException corresponds to a model thrown 'objects removal' exception
protected String	targetLanguage holds the target language if provided
protected String	type holds the type of the exception
protected Object	value holds the value that failed validation
static String	ValueConversionException corresponds to a model thrown 'Error converting value of class' exception

Fields inherited from class com.webobjects.foundation.NSValidation.ValidationException

_CLASS, AdditionalExceptionsKey, ValidatedKeyUserInfoKey, ValidatedObjectUserInfoKey

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

_CLASS, NullValue

Constructor Summary

Constructors

Constructor and Description
ERXValidationException(String type, Object object, String key) Default constructor that builds a validation exception without the failed value specified.
ERXValidationException(String type, Object object, String key, Object value) Default constructor that builds a validation exception based on the type, object, key and failed value.Usually for creating custom validation exceptions the ERXValidationFactory should be used.

Method Summary

Modifier and Type	Method and Description
protected String	_getMessage()
NSArray<com.webobjects.foundation.NSValidation.ValidationException>	additionalExceptions() Cover method to return any additional exceptions that occurred.
EOAttribute	attribute() Cover method for getting the attribute corresponding to the propertyKey and entity off of the object.
com.webobjects.foundation.NSKeyValueCoding	context() The current context of the validation exception.
Object	delegate() Gets the current delegate for this validation exception.
String	displayNameForEntity() Generates a displayable and localized version of the current object's entity name.
String	displayNameForProperty() Generates a displayable and localized version of the current propertyKey (also called key).
com.webobjects.eocontrol.EOEnterpriseObject	eoObject() Cover method that casts the object of the validation exception to an EOEnterpriseObject.
boolean	equals(Object anotherObject) Compares this exception to anything else.
String	escapedValue() Provides an escaped value to use in validation template string.
String	getMessage() Gets the message for this exception.
int	hashCode()
boolean	isCustomMethodException() Convenience method to determine if this exception was a custom thrown exception instead of a model thrown exception.
protected String	localizedDisplayNameForKey(String key) Creates a localized display name for a given key trying to localize it with the current "targetLanguage" or the current localizer.
String	method() Returns method name.
Object	object() Overrides super implementation to allow for settable object value.
String	propertyKey() Cover method for returning the key of the validation exception under the name propertyKey.
void	setAdditionalExceptions(NSArray<com.webobjects.foundation.NSValidation.ValidationException> exceptions) Sets the array of additional exceptions.
void	setContext(com.webobjects.foundation.NSKeyValueCoding context) Sets the context that can be used to resolve key bindings in validation templates.
void	setDelegate(Object obj) Sets the delegate for the current validation exception.
void	setMethod(String aMethod) Sets the custom method name that threw the validation exception.
void	setObject(Object aValue) Sets the object that failed validation.
void	setTargetLanguage(String aValue) Sets the target language to use when rendering the validation message.
void	setType(String aType) Sets the validation type of this exception.
void	setValue(Object aValue) Sets the value that failed validation.
void	takeValueForKey(Object obj, String key) Implementation of the key value coding.
String	targetLanguage() Returns the target language to display the validation message in.
String	toString() Returns the formatted description of the validation exception without calling getMessage.
String	type() Cover method to return the type of the validation exception.
Object	value() Returns the value that failed validation.
Object	valueForKey(String key) Implementation of key value coding.

Methods inherited from class com.webobjects.foundation.NSValidation.ValidationException

aggregateExceptionWithExceptions, exceptionAddingEntriesToUserInfo, exceptionWithObjectAndKey, key, userInfo

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NullPropertyException

public static final String NullPropertyException

corresponds to a model thrown 'null property' exception

See Also:

Constant Field Values

InvalidNumberException

public static final String InvalidNumberException

corresponds to a number formatter exception

See Also:

Constant Field Values

InvalidValueException

public static final String InvalidValueException

corresponds to a generic 'invalid value' exception

See Also:

Constant Field Values

MandatoryToOneRelationshipException

public static final String MandatoryToOneRelationshipException

corresponds to a model thrown 'mandatory toOne relationship' exception

See Also:

Constant Field Values

MandatoryToManyRelationshipException

public static final String MandatoryToManyRelationshipException

corresponds to a model thrown 'mandatory toMany relationship' exception

See Also:

Constant Field Values

ObjectRemovalException

public static final String ObjectRemovalException

corresponds to a model thrown 'object removal' exception

See Also:

Constant Field Values

ObjectsRemovalException

public static final String ObjectsRemovalException

corresponds to a model thrown 'objects removal' exception

See Also:

Constant Field Values

ExceedsMaximumLengthException

public static final String ExceedsMaximumLengthException

corresponds to a model thrown 'maximum length of attribute exceeded' exception

See Also:

Constant Field Values

ValueConversionException

public static final String ValueConversionException

corresponds to a model thrown 'Error converting value of class' exception

See Also:

Constant Field Values

CustomMethodException

public static final String CustomMethodException

corresponds to a custom method exception

See Also:

Constant Field Values

message

protected String message

caches the validation message

method

protected String method

holds the method if one is provided

type

protected String type

holds the type of the exception

value

protected Object value

holds the value that failed validation

object

protected Object object

holds the object that failed validation

targetLanguage

protected String targetLanguage

holds the target language if provided

additionalExceptions

protected NSArray<com.webobjects.foundation.NSValidation.ValidationException> additionalExceptions

caches any set additionalExceptions

_context

protected volatile com.webobjects.foundation.NSKeyValueCoding _context

holds a reference to the context of the exception

delegate

protected volatile Object delegate

holds a reference to the exception delegate

Constructor Detail

ERXValidationException

public ERXValidationException(String type,
                              Object object,
                              String key)

Default constructor that builds a validation exception without the failed value specified. If you want to have validation templates that refer to the value that didn't pass validation use the four argument constructor. Usually for creating custom validation exceptions the ERXValidationFactory should be used.

Parameters:

type - of the exception, should be one of the constraints defined in this class.

object - that is throwing the exception

key - property key that failed validation

ERXValidationException

public ERXValidationException(String type,
                              Object object,
                              String key,
                              Object value)

Default constructor that builds a validation exception based on the type, object, key and failed value.Usually for creating custom validation exceptions the ERXValidationFactory should be used.

Parameters:

type - of the exception, should be one of the constraints defined in this class.

object - that is throwing the exception

key - property key that failed validation

value - that failed validation

Method Detail

getMessage

public String getMessage()

Gets the message for this exception.

Overrides:

getMessage in class Throwable

Returns:

the correctly formatted validation exception.

_getMessage

protected String _getMessage()

valueForKey

public Object valueForKey(String key)

Implementation of key value coding. Uses the default implementation.

Specified by:

valueForKey in interface com.webobjects.foundation.NSKeyValueCoding

Parameters:

key - to look up

Returns:

result of the lookup on the object

takeValueForKey

public void takeValueForKey(Object obj,
                            String key)

Implementation of the key value coding. Uses the default implementation.

Specified by:

takeValueForKey in interface com.webobjects.foundation.NSKeyValueCoding

Parameters:

obj - value to be set on this exception

key - to be set

isCustomMethodException

public boolean isCustomMethodException()

Convenience method to determine if this exception was a custom thrown exception instead of a model thrown exception. A custom exception would be an exception that you throw in your validateFoo method if a particular constraint is not valid.

Returns:

if this exception is a custom thrown exception.

method

public String method()

Returns method name. The method name is only set if the validation exception is a custom validation exception.

Returns:

custom method name.

setMethod

public void setMethod(String aMethod)

Sets the custom method name that threw the validation exception.

Parameters:

aMethod - name to be set.

eoObject

public com.webobjects.eocontrol.EOEnterpriseObject eoObject()

Cover method that casts the object of the validation exception to an EOEnterpriseObject.

Returns:

object cast as an enterprise object.

object

public Object object()

Overrides super implementation to allow for settable object value.

Overrides:

object in class com.webobjects.foundation.NSValidation.ValidationException

Returns:

object for this exception.

propertyKey

public String propertyKey()

Cover method for returning the key of the validation exception under the name propertyKey.

Returns:

the key of the validation exception

attribute

public EOAttribute attribute()

Cover method for getting the attribute corresponding to the propertyKey and entity off of the object.

Returns:

EOAttribute corresponding to the propertyKey and entity.

type

public String type()

Cover method to return the type of the validation exception. The corresponds to one of the constant strings defined in this class.

Returns:

the type of this validation exception.

setType

public void setType(String aType)

Sets the validation type of this exception. Should correspond to one of the type constants defined in this class. All of the model thrown validation exceptions should have the correct type already set.

Parameters:

aType - name to set on this validation exception.

value

public Object value()

Returns the value that failed validation.

Returns:

failed validation value.

escapedValue

public String escapedValue()

Provides an escaped value to use in validation template string.

Returns:

escaped value

See Also:

value(), WOMessage.stringByEscapingHTMLString(String)

setValue

public void setValue(Object aValue)

Sets the value that failed validation.

Parameters:

aValue - that failed validation

setObject

public void setObject(Object aValue)

Sets the object that failed validation.

Parameters:

aValue - object that failed validation

targetLanguage

public String targetLanguage()

Returns the target language to display the validation message in. If a target language is not set then the current default language for the current thread is used.

Returns:

target language if one is set.

setTargetLanguage

public void setTargetLanguage(String aValue)

Sets the target language to use when rendering the validation message. Only set a target language if you want to override the current language of the thread.

Parameters:

aValue - name of the language to render the validation exception in.

delegate

public Object delegate()

Gets the current delegate for this validation exception. If one is not set then the default delegate for the ERXValidationFactory is returned.

Returns:

delegate for this validation exception.

setDelegate

public void setDelegate(Object obj)

Sets the delegate for the current validation exception. The delegate can intervene to provide a different template for the validation exception or resolve the template in a different manner.

Parameters:

obj - delegate to be used for this validation exception.

context

public com.webobjects.foundation.NSKeyValueCoding context()

The current context of the validation exception. Context objects are mainly used for resolving keys in validation templates. When validation exceptions are thrown in D2W pages the current D2WContext is set as the current context on the exceptions. If a context is not set then the contextForException is called off of the default ERXValidationFactory. When this also returns null, then the exception will be used as its context. This is needed because of some of the templates in ERDirectToWeb which use context.propertyKey and will display ? if none is given.

Returns:

current context for the validation exception.

setContext

public void setContext(com.webobjects.foundation.NSKeyValueCoding context)

Sets the context that can be used to resolve key bindings in validation templates.

Parameters:

context - of the current exception

setAdditionalExceptions

public void setAdditionalExceptions(NSArray<com.webobjects.foundation.NSValidation.ValidationException> exceptions)

Sets the array of additional exceptions.

Parameters:

exceptions - array of additional exceptions

additionalExceptions

public NSArray<com.webobjects.foundation.NSValidation.ValidationException> additionalExceptions()

Cover method to return any additional exceptions that occurred. The reason this method is needed is because we wanted to have the ability to set the additional exceptions.

Overrides:

additionalExceptions in class com.webobjects.foundation.NSValidation.ValidationException

Returns:

array of additional exceptions

displayNameForProperty

public String displayNameForProperty()

Generates a displayable and localized version of the current propertyKey (also called key).

Returns:

localized displayable version of the current propertyKey.

displayNameForEntity

public String displayNameForEntity()

Generates a displayable and localized version of the current object's entity name.

Returns:

localized displayable version of an object's entity name.

localizedDisplayNameForKey

protected String localizedDisplayNameForKey(String key)

Creates a localized display name for a given key trying to localize it with the current "targetLanguage" or the current localizer. If there is an eoObject first try to localize "entityName.key" then "key" if nothing found.

Parameters:

key - to be translated

Returns:

localized display version of the given key.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object anotherObject)

Compares this exception to anything else.

Overrides:

equals in class Object

Returns:

description of the validation exception

toString

public String toString()

Returns the formatted description of the validation exception without calling getMessage.

Overrides:

toString in class Throwable

Returns:

description of the validation exception