validator_1_1.dtd

validator_1_1.dtd

DTD for the Validator Rules Configuration File, Version 1.1

To allow for XML validation of your rules configuration file, include the following DOCTYPE element at the beginning (after the "xml" declaration):

<!DOCTYPE form-validation PUBLIC "-//Apache Software Foundation//DTD Commons Validator Rules Configuration 1.1//EN" "http://jakarta.apache.org/commons/dtds/validator_1_1.dtd">

The "form-validation" element is the root of the configuration file hierarchy, and contains nested elements for all of the other configuration settings.

<form-validation>'s children Name Cardinality formset Any number global Any number

(global*,formset*)

The elements defined here are all global and must be nested within a "global" element.

<global>'s children Name Cardinality constant Any number validator Any number

(validator*,constant*)

The "validator" element defines what validator objects can be used with the fields referenced by the formset elements.

<validator>'s children Name Cardinality javascript One or none

<validator>'s attributes Name Values Default classname depends jsFunction jsFunctionName method methodParams msg name

(javascript?)

Sorry, no documentation.

Required

Sorry, no documentation.

Required

Sorry, no documentation.

Required

Sorry, no documentation.

Required

Sorry, no documentation.

Required

Sorry, no documentation.

Sorry, no documentation.

Sorry, no documentation.

The "javascript" element defines a JavaScript that can be used to perform client-side validators.

The "constant" element defines a static value that can be used as replacement parameters within "field" elements. The "constant-name" and "constant-value" elements define the constant's reference id and replacement value.

<constant>'s children Name Cardinality constant-name Only one constant-value Only one

(constant-name,constant-value)

Sorry, no documentation.

Sorry, no documentation.

The "formset" element defines a set of forms for a locale. Formsets for specific locales can override only those fields that change. The localization is properly scoped, so that a formset can override just the language, or just the country, or both.

<formset>'s children Name Cardinality constant Any number form At least one

<formset>'s attributes Name Values Default country language variant

(constant*,form+)

Sorry, no documentation.

Sorry, no documentation.

Sorry, no documentation.

The "form" element defines a set of fields to be validated. The name corresponds to the identifer the application assigns to the form.

<form>'s children Name Cardinality field At least one

<form>'s attributes Name Values Default name

(field+)

Sorry, no documentation.

Required

The "field" element defines the properties to be validated. In a web application, a field would also correspond to a control on a HTML form. To validate the properties, the validator works through a JavaBean representation. The field element accepts these attributes:

<field>'s children Name Cardinality arg Any number arg0 Any number arg1 Any number arg2 Any number arg3 Any number msg Any number var Any number

<field>'s attributes Name Values Default depends indexedListProperty page property

(msg | arg | arg0 | arg1 | arg2 | arg3 | var)*

The property on the JavaBean corresponding to this field element.

Required

The comma-delimited list of validators to apply against this field. For the field to succeed, all the validators must succeed.

The JavaBean corresponding to this form may include a page property. Only fields with a "page" attribute value that is equal to or less than the page property on the form JavaBean are processed. This is useful when using a "wizard" approach to completing a large form, to ensure that a page is not skipped. [0]

The "indexedListProperty" is the method name that will return an array or a Collection used to retrieve the list and then loop through the list performing the validations for this field.

The "msg" element defines a custom message key to use when one of the validators for this field fails. Each validator has a default message property that is used when a corresonding field msg is not specified. Each validator applied to a field may have its own msg element. The msg element accepts these attributes.

<msg>'s attributes
Name	Values	Default
bundle
key
name
resource

This tag is always empty.

The key that will return the message template from a resource bundle.

Required

The name of the validator corresponding to this msg.

Required

The resource bundle name that the key should be resolved in.

If set to "false", the key is taken to be a literal value rather than a bundle key. [true]

The "arg" element defines a replacement value to use with the message template for this validator or this field. The arg element accepts these attributes.

<arg>'s attributes
Name	Values	Default
bundle
key
name
position
resource

This tag is always empty.

The key that will return the message template from a resource bundle.

Required

The resource bundle name that the key should be resolved in.

The name of the validator corresponding to this msg. If not supplied, this argument will be used in the given position for every validator.

If set to "false", the key is taken to be a literal value rather than a bundle key. [true]

The position of this replacement parameter in the message. For example, position="0" will set the first argument. [0]

DEPRECATED Use <arg position="0"/> instead.

The "arg0" element defines the first replacement value to use with the message template for this validator or this field. The arg0 element accepts these attributes.

<arg0>'s attributes
Name	Values	Default
key
name
resource

This tag is always empty.

The name of the validator corresponding to this msg.

The key that will return the message template from a resource bundle.

If set to "false", the key is taken to be a literal value rather than a bundle key. [true]

DEPRECATED Use <arg position="1"/> instead.

The "arg1" element defines the second replacement value to use with the message template for this validator or this field. The arg1 element accepts these attributes.

<arg1>'s attributes
Name	Values	Default
key
name
resource

This tag is always empty.

The name of the validator corresponding to this msg.

The key that will return the message template from a resource bundle.

If set to "false", the key is taken to be a literal value rather than a bundle key. [true]

DEPRECATED Use <arg position="2"/> instead.

The "arg2" element defines the third replacement value to use with the message template for this validator or this field. The arg2 element accepts these attributes.

<arg2>'s attributes
Name	Values	Default
key
name
resource

This tag is always empty.

The name of the validator corresponding to this msg.

The key that will return the message template from a resource bundle.

If set to "false", the key is taken to be a literal value rather than a bundle key. [true]

DEPRECATED Use <arg position="3"/> instead.

The "arg3" element defines the fourth replacement value to use with the message template for this validator or this field. The arg0 element accepts these attributes.

<arg3>'s attributes
Name	Values	Default
key
name
resource

This tag is always empty.

The name of the validator corresponding to this msg.

The key that will return the message template from a resource bundle.

If set to "false", the key is taken to be a literal value rather than a bundle key. [true]

The "var" element can set parameters that a field may need to pass to one of its validators, such as the minimum and maximum values in a range validation. These parameters may also be referenced by one of the arg? elements using a shell syntax: ${var:var-name}.

<var>'s children Name Cardinality var-name Only one var-value Only one

(var-name,var-value)

The name of the var parameter to provide to a field's validators.

The value of the var parameter to provide to a field's validators.