| <?xml version="1.0"?> |
| <!-- |
| Copyright 2003-2004 The Apache Software Foundation |
| |
| Licensed under the Apache License, Version 2.0 (the "License"); |
| you may not use this file except in compliance with the License. |
| You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| |
| <document> |
| |
| <properties> |
| <title>Commons</title> |
| </properties> |
| |
| <body> |
| |
| <section name="Introduction"> |
| |
| <p> |
| A common issue when receiving data either electronically or from |
| user input is verifying the integrity of the data. This work is |
| repetitive and becomes even more complicated when different sets |
| of validation rules need to be applied to the same set of data based |
| on locale. Error messages may also vary by locale. |
| This package addresses some of these issues to |
| speed development and maintenance of validation rules. |
| </p> |
| |
| <p> |
| In order to use the Validator, the following basic steps are required: |
| <ul> |
| <li> |
| Create a new instance of the |
| <code>org.apache.commons.validator.Validator</code> class. Currently |
| Validator instances may be safely reused if the current |
| ValidatorResources are the same, as long as you have completed any |
| previous validation, and you do not try to utilize a particular |
| Validator instance from more than one thread at a time. |
| </li> |
| <li> |
| Add any resources needed to perform the validations, such as the |
| JavaBean to validate. |
| </li> |
| <li> |
| Call the validate method on |
| <code>org.apache.commons.validator.Validator</code>. |
| </li> |
| </ul> |
| </p> |
| |
| <p> |
| For more information, see the <a href="apidocs/index.html">JavaDocs</a>. |
| </p> |
| |
| </section> |
| |
| <section name="Features"> |
| <p>Validator provides two distinct sets of functionality:</p> |
| <ol> |
| <li>A configurable (typically XML) validation engine</li> |
| <li>Reusable "primitive" validation methods</li> |
| </ol> |
| |
| <p> |
| Your validation methods are plugged into the engine and |
| executed against your data. Often, these methods use |
| resources specific to one application or framework so Commons |
| Validator doesn't directly provide pluggable validator actions. |
| However, it does have a set of common validation methods |
| (email addresses, dates, URLs, etc.) that help in creating |
| pluggable actions. |
| </p> |
| </section> |
| |
| </body> |
| |
| </document> |
