~ubuntu-branches/ubuntu/oneiric/libcommons-validator-java/oneiric

« back to all changes in this revision

Viewing changes to xdocs/index.xml

  • Committer: Bazaar Package Importer
  • Author(s): Arnaud Vandyck
  • Date: 2004-11-19 13:35:53 UTC
  • Revision ID: james.westby@ubuntu.com-20041119133553-qtl7whjkjv9q1rbd
Tags: upstream-1.3
ImportĀ upstreamĀ versionĀ 1.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0"?>
 
2
<!--
 
3
   Copyright 2003-2004 The Apache Software Foundation
 
4
 
 
5
   Licensed under the Apache License, Version 2.0 (the "License");
 
6
   you may not use this file except in compliance with the License.
 
7
   You may obtain a copy of the License at
 
8
 
 
9
       http://www.apache.org/licenses/LICENSE-2.0
 
10
 
 
11
   Unless required by applicable law or agreed to in writing, software
 
12
   distributed under the License is distributed on an "AS IS" BASIS,
 
13
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 
14
   See the License for the specific language governing permissions and
 
15
   limitations under the License.
 
16
-->
 
17
 
 
18
<document>
 
19
 
 
20
  <properties>
 
21
    <title>Commons</title>
 
22
  </properties>
 
23
 
 
24
  <body>
 
25
 
 
26
    <section name="Introduction">
 
27
 
 
28
      <p>
 
29
        A common issue when receiving data either electronically or from 
 
30
        user input is verifying the integrity of the data. This work is 
 
31
        repetitive and becomes even more complicated when different sets 
 
32
        of validation rules need to be applied to the same set of data based 
 
33
        on locale. Error messages may also vary by locale.  
 
34
        This package addresses some of these issues to
 
35
        speed development and maintenance of validation rules.
 
36
      </p>
 
37
 
 
38
      <p>
 
39
        In order to use the Validator, the following basic steps are required:
 
40
        <ul>
 
41
          <li>
 
42
            Create a new instance of the
 
43
            <code>org.apache.commons.validator.Validator</code> class. Currently
 
44
            Validator instances may be safely reused if the current
 
45
            ValidatorResources are the same, as long as you have completed any
 
46
            previous validation, and you do not try to utilize a particular
 
47
            Validator instance from more than one thread at a time.
 
48
          </li>
 
49
          <li>
 
50
            Add any resources needed to perform the validations, such as the
 
51
            JavaBean to validate.
 
52
          </li>
 
53
          <li>
 
54
            Call the validate method on
 
55
            <code>org.apache.commons.validator.Validator</code>.
 
56
          </li>
 
57
        </ul>
 
58
      </p>
 
59
 
 
60
      <p>
 
61
        For more information, see the <a href="apidocs/index.html">JavaDocs</a>.
 
62
      </p>
 
63
 
 
64
    </section>
 
65
    
 
66
    <section name="Features">
 
67
        <p>Validator provides two distinct sets of functionality:</p>
 
68
        <ol>
 
69
            <li>A configurable (typically XML) validation engine</li>
 
70
            <li>Reusable "primitive" validation methods</li>
 
71
        </ol>
 
72
        
 
73
        <p>
 
74
        Your validation methods are plugged into the engine and 
 
75
        executed against your data.  Often, these methods use
 
76
        resources specific to one application or framework so Commons 
 
77
        Validator doesn't directly provide pluggable validator actions.
 
78
        However, it does have a set of common validation methods 
 
79
        (email addresses, dates, URLs, etc.) that help in creating 
 
80
        pluggable actions.    
 
81
        </p>
 
82
    </section>
 
83
 
 
84
  </body>
 
85
 
 
86
</document>