Package org.faktorips.runtime.validation

Class DefaultGenericAttributeValidationConfiguration

java.lang.Object

org.faktorips.runtime.validation.DefaultGenericAttributeValidationConfiguration

All Implemented Interfaces:

IGenericAttributeValidationConfiguration

public class DefaultGenericAttributeValidationConfiguration
extends java.lang.Object
implements IGenericAttributeValidationConfiguration

Default implementation of IGenericAttributeValidationConfiguration that uses a Locale specific ResourceBundle to load messages.

Messages are created with one replacement parameter that is set to the attribute's localized label and with a message code created from an error specific prefix("InvalidAttribute.Mandatory"/"InvalidAttribute.Irrelevant"/"InvalidAttribute.Invalid"), the name of the policy type and the attribute name.

To add markers or other information to messages, you can override this class' methods and use Message.Builder to modify the messages returned from them.

An IMarker for missing required information, that will be used in the default implementation of createMessageForMissingMandatoryValue(PolicyAttribute, IModelObject, Class) can be provided in the constructor.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ERROR_INVALID_MSG_CODE_PREFIX	Message code prefix indicating a missing value outside of an attribute's allowed value set.
static java.lang.String	ERROR_IRRELEVANT_MSG_CODE_PREFIX	Message code prefix indicating a value is set for an irrelevant attribute.
static java.lang.String	ERROR_MANDATORY_MSG_CODE_PREFIX	Message code prefix indicating a missing value for a mandatory attribute.

Constructor Summary

Constructors

Constructor	Description
DefaultGenericAttributeValidationConfiguration(java.util.Locale locale)
DefaultGenericAttributeValidationConfiguration(java.util.Locale locale, IMarker requiredInformationMissingMarker)
DefaultGenericAttributeValidationConfiguration(java.util.ResourceBundle messages, java.util.Locale locale)
DefaultGenericAttributeValidationConfiguration(java.util.ResourceBundle messages, java.util.Locale locale, IMarker requiredInformationMissingMarker)

Method Summary

Modifier and Type	Method	Description
protected Message.Builder	builderForErrorMessage(PolicyAttribute policyAttribute, IModelObject modelObject, GenericRelevanceValidation.Error error, java.lang.Class<? extends IModelObject> definingModelObjectClass, java.lang.String message)	Creates an error message builder with a message code created from the given prefix via createMsgCode(GenericRelevanceValidation.Error, PolicyAttribute, Class) and an invalid object property for the given attribute.
protected Message	createErrorMessage(PolicyAttribute policyAttribute, IModelObject modelObject, GenericRelevanceValidation.Error error, java.lang.Class<? extends IModelObject> definingModelObjectClass, java.lang.String message)	Creates an error message with a message code created from the given prefix via createMsgCode(GenericRelevanceValidation.Error, PolicyAttribute, Class) and an invalid object property for the given attribute.
Message	createMessageForMissingMandatoryValue(PolicyAttribute policyAttribute, IModelObject modelObject, java.lang.Class<? extends IModelObject> definingModelObjectClass)	Creates a message to indicate that the given attribute's value on the given model object is missing but the value set does not allow a null value.
Message	createMessageForValueNotInAllowedValueSet(PolicyAttribute policyAttribute, IModelObject modelObject, java.lang.Class<? extends IModelObject> definingModelObjectClass)	Creates a message to indicate that the given attribute's value on the given model object is not allowed by the value set.
Message	createMessageForValuePresentForIrrelevantAttribute(PolicyAttribute policyAttribute, IModelObject modelObject, java.lang.Class<? extends IModelObject> definingModelObjectClass)	Creates a message to indicate that the given attribute's value on the given model object is set but the value set does not allow a value.
protected java.lang.String	createMsgCode(GenericRelevanceValidation.Error error, PolicyAttribute policyAttribute, java.lang.Class<? extends IModelObject> definingModelObjectClass)	Creates a message code from the pattern <errorCode>.<definingModelObjectClassName>.<policyAttributeName>.
protected java.lang.String	format(java.lang.String msgKey, java.lang.Object... replacementParameters)	Formats the String obtained from this configuration's ResourceBundle with the given key using the replacement parameters.
protected java.lang.String	getLabelFor(PolicyAttribute policyAttribute, IModelObject modelObject)	Returns the label for the given attribute to be used in an error message.
java.util.Locale	getLocale()	Returns the Locale this configuration was created for.
java.util.ResourceBundle	getMessages()	Returns the ResourceBundle for this configuration.
IMarker	getMissingMandatoryValueMarker()	Returns the IMarker used to create a message for a missing mandatory value.
boolean	shouldValidate(PolicyAttribute policyAttribute, IModelObject modelObject)	Decides whether the given PolicyAttribute should be validated for the given IModelObject.

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_MANDATORY_MSG_CODE_PREFIX

public static final java.lang.String ERROR_MANDATORY_MSG_CODE_PREFIX

Message code prefix indicating a missing value for a mandatory attribute.

See Also:

Constant Field Values

ERROR_IRRELEVANT_MSG_CODE_PREFIX

public static final java.lang.String ERROR_IRRELEVANT_MSG_CODE_PREFIX

Message code prefix indicating a value is set for an irrelevant attribute.

See Also:

Constant Field Values

ERROR_INVALID_MSG_CODE_PREFIX

public static final java.lang.String ERROR_INVALID_MSG_CODE_PREFIX

Message code prefix indicating a missing value outside of an attribute's allowed value set.

See Also:

Constant Field Values

Constructor Detail

DefaultGenericAttributeValidationConfiguration

public DefaultGenericAttributeValidationConfiguration(java.util.Locale locale)

DefaultGenericAttributeValidationConfiguration

public DefaultGenericAttributeValidationConfiguration(java.util.Locale locale,
                                                      @CheckForNull
                                                      IMarker requiredInformationMissingMarker)

DefaultGenericAttributeValidationConfiguration

public DefaultGenericAttributeValidationConfiguration(java.util.ResourceBundle messages,
                                                      java.util.Locale locale)

DefaultGenericAttributeValidationConfiguration

public DefaultGenericAttributeValidationConfiguration(java.util.ResourceBundle messages,
                                                      java.util.Locale locale,
                                                      @CheckForNull
                                                      IMarker requiredInformationMissingMarker)

Method Detail

getLocale

public java.util.Locale getLocale()

Returns the Locale this configuration was created for.

getMessages

public java.util.ResourceBundle getMessages()

Returns the ResourceBundle for this configuration.

getMissingMandatoryValueMarker

public IMarker getMissingMandatoryValueMarker()

Returns the IMarker used to create a message for a missing mandatory value.

shouldValidate

public boolean shouldValidate(PolicyAttribute policyAttribute,
                              IModelObject modelObject)

Description copied from interface: IGenericAttributeValidationConfiguration

Decides whether the given PolicyAttribute should be validated for the given IModelObject.

Specified by:

shouldValidate in interface IGenericAttributeValidationConfiguration

Parameters:

policyAttribute - the model type reference for the validated attribute

modelObject - the model object instance on which the attribute may be validated

Returns:

whether validation for the given combination of PolicyAttribute and IModelObject should run

createErrorMessage

protected Message createErrorMessage(PolicyAttribute policyAttribute,
                                     IModelObject modelObject,
                                     GenericRelevanceValidation.Error error,
                                     java.lang.Class<? extends IModelObject> definingModelObjectClass,
                                     java.lang.String message)

Creates an error message with a message code created from the given prefix via createMsgCode(GenericRelevanceValidation.Error, PolicyAttribute, Class) and an invalid object property for the given attribute.

Implementation Requirements:

calling builderForErrorMessage(PolicyAttribute, IModelObject, org.faktorips.runtime.validation.GenericRelevanceValidation.Error, Class, String) is preferred if you want to adapt the message.

builderForErrorMessage

protected Message.Builder builderForErrorMessage(PolicyAttribute policyAttribute,
                                                 IModelObject modelObject,
                                                 GenericRelevanceValidation.Error error,
                                                 java.lang.Class<? extends IModelObject> definingModelObjectClass,
                                                 java.lang.String message)

Creates an error message builder with a message code created from the given prefix via createMsgCode(GenericRelevanceValidation.Error, PolicyAttribute, Class) and an invalid object property for the given attribute.

createMsgCode

protected java.lang.String createMsgCode(GenericRelevanceValidation.Error error,
                                         PolicyAttribute policyAttribute,
                                         java.lang.Class<? extends IModelObject> definingModelObjectClass)

Creates a message code from the pattern <errorCode>.<definingModelObjectClassName>.<policyAttributeName>.

format

protected java.lang.String format(java.lang.String msgKey,
                                  java.lang.Object... replacementParameters)

Formats the String obtained from this configuration's ResourceBundle with the given key using the replacement parameters.

Parameters:

msgKey - the key to find the format String from the ResourceBundle.

replacementParameters - the parameters to be passed to String.format(String, Object...)

getLabelFor

protected java.lang.String getLabelFor(PolicyAttribute policyAttribute,
                                       IModelObject modelObject)

Returns the label for the given attribute to be used in an error message.

Parameters:

policyAttribute - the model type reference for the validated attribute

modelObject - the model object instance on which the attribute was validated

Implementation Requirements:

Implementers may use the given model object to further qualify the field.

Implementation Note:

The default implementation uses the attribute's label in the locale provided to this configuration's constructor and returns it in double quotes.

createMessageForMissingMandatoryValue

public Message createMessageForMissingMandatoryValue(PolicyAttribute policyAttribute,
                                                     IModelObject modelObject,
                                                     java.lang.Class<? extends IModelObject> definingModelObjectClass)

Description copied from interface: IGenericAttributeValidationConfiguration

Creates a message to indicate that the given attribute's value on the given model object is missing but the value set does not allow a null value.

Specified by:

createMessageForMissingMandatoryValue in interface IGenericAttributeValidationConfiguration

Parameters:

policyAttribute - the model type reference for the validated attribute

modelObject - the model object instance on which the attribute was validated

definingModelObjectClass - the model object class where the generic validation is defined

createMessageForValuePresentForIrrelevantAttribute

public Message createMessageForValuePresentForIrrelevantAttribute(PolicyAttribute policyAttribute,
                                                                  IModelObject modelObject,
                                                                  java.lang.Class<? extends IModelObject> definingModelObjectClass)

Description copied from interface: IGenericAttributeValidationConfiguration

Creates a message to indicate that the given attribute's value on the given model object is set but the value set does not allow a value.

Specified by:

createMessageForValuePresentForIrrelevantAttribute in interface IGenericAttributeValidationConfiguration

Parameters:

policyAttribute - the model type reference for the validated attribute

modelObject - the model object instance on which the attribute was validated

definingModelObjectClass - the model object class where the generic validation is defined

createMessageForValueNotInAllowedValueSet

public Message createMessageForValueNotInAllowedValueSet(PolicyAttribute policyAttribute,
                                                         IModelObject modelObject,
                                                         java.lang.Class<? extends IModelObject> definingModelObjectClass)

Description copied from interface: IGenericAttributeValidationConfiguration

Creates a message to indicate that the given attribute's value on the given model object is not allowed by the value set.

Specified by:

createMessageForValueNotInAllowedValueSet in interface IGenericAttributeValidationConfiguration

Parameters:

policyAttribute - the model type reference for the validated attribute

modelObject - the model object instance on which the attribute was validated

definingModelObjectClass - the model object class where the generic validation is defined