KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > enhydra > apache > xerces > validators > datatype > DatatypeValidator


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 1999, 2000 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Xerces" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation and was
52  * originally based on software copyright (c) 1999, International
53  * Business Machines, Inc., http://www.apache.org. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  */
57
58 package org.enhydra.apache.xerces.validators.datatype;
59
60
61 /**
62  * DataTypeValidator defines the interface that data type validators must obey.
63  * These validators can be supplied by the application writer and may be useful as
64  * standalone code as well as plugins to the validator architecture.
65  * Note: there is no support for facets in this API, since we are trying to convince
66  * W3C to remove facets from the data type spec.
67  *
68  * @author Jeffrey Rodriguez-
69  * @version $Id: DatatypeValidator.java,v 1.2 2005/01/26 08:28:44 jkjome Exp $
70  */
71 public interface DatatypeValidator {
72     public static final short FACET_LENGTH = 0x1<<0;
73     public static final short FACET_MINLENGTH = 0x1<<1;
74     public static final short FACET_MAXLENGTH = 0x1<<2;
75     public static final short FACET_PATTERN = 0x1<<3;
76     public static final short FACET_ENUMERATION = 0x1<<4;
77     public static final short FACET_MAXINCLUSIVE = 0x1<<5;
78     public static final short FACET_MAXEXCLUSIVE = 0x1<<6;
79     public static final short FACET_MININCLUSIVE = 0x1<<7;
80     public static final short FACET_MINEXCLUSIVE = 0x1<<8;
81     public static final short FACET_TOTALDIGITS = 0x1<<9;
82     public static final short FACET_FRACTIONDIGITS = 0x1<<10;
83     public static final short FACET_ENCODING = 0x1<<11;
84     public static final short FACET_DURATION = 0x1<<12;
85     public static final short FACET_PERIOD = 0x1<<13;
86     public static final short FACET_WHITESPACE = 0x1<<14;
87
88     // _dummy_ facet that is passed with all other facets for a datatype
89 // its value flags the fixed facets
90 public static final String JavaDoc FACET_FIXED = "fixed";
91     
92     //2.4.2.6 whiteSpace - Datatypes
93 public static final short PRESERVE = 0;
94     public static final short REPLACE = 1;
95     public static final short COLLAPSE = 2;
96
97
98
99     /**
100      * Checks that "content" string is valid
101      * datatype.
102      * If invalid a Datatype validation exception is thrown.
103      *
104      * @param content A string containing the content to be validated
105      *
106      * @exception throws InvalidDatatypeException if the content is
107      * invalid according to the rules for the validators
108      * @exception InvalidDatatypeValueException
109      * @see org.enhydra.apache.xerces.validators.datatype.InvalidDatatypeValueException
110      */
111     public Object JavaDoc validate(String JavaDoc content, Object JavaDoc state ) throws InvalidDatatypeValueException;
112
113     public short getWSFacet ();
114     
115     // returns the base datatypeValidator of the current validator.
116 public DatatypeValidator getBaseValidator();
117
118     /**
119      * Compares content in the Domain value vs. lexical
120      * value.
121      * e.g. If type is a float then 1.0 may be equivalent
122      * to 1 even tough both are lexically different.
123      *
124      * @param value1
125      * @param valu2
126      * @return
127      */
128     public int compare( String JavaDoc value1, String JavaDoc value2);
129
130 }
131
Popular Tags