KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > impl > dv > xs > TypeValidator


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2001, 2002 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) 2001, 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 com.sun.org.apache.xerces.internal.impl.dv.xs;
59
60 import com.sun.org.apache.xerces.internal.impl.dv.InvalidDatatypeValueException;
61 import com.sun.org.apache.xerces.internal.impl.dv.ValidationContext;
62
63 /**
64  * All primitive types plus ID/IDREF/ENTITY/INTEGER are derived from this abstract
65  * class. It provides extra information XSSimpleTypeDecl requires from each
66  * type: allowed facets, converting String to actual value, check equality,
67  * comparison, etc.
68  *
69  * @author Neeraj Bajaj, Sun Microsystems, inc.
70  * @author Sandy Gao, IBM
71  *
72  * @version $Id: TypeValidator.java,v 1.5 2002/11/18 23:10:10 sandygao Exp $
73  */
74 public abstract class TypeValidator {
75
76     // which facets are allowed for this type
77 public abstract short getAllowedFacets();
78
79     // convert a string to an actual value. for example,
80 // for number types (decimal, double, float, and types derived from them),
81 // get the BigDecimal, Double, Flout object.
82 // for some types (string and derived), they just return the string itself
83 public abstract Object JavaDoc getActualValue(String JavaDoc content, ValidationContext context)
84         throws InvalidDatatypeValueException;
85
86     // for ID/IDREF/ENTITY types, do some extra checking after the value is
87 // checked to be valid with respect to both lexical representation and
88 // facets
89 public void checkExtraRules(Object JavaDoc value, ValidationContext context) throws InvalidDatatypeValueException {
90     }
91
92     // the following methods might not be supported by every DV.
93 // but XSSimpleTypeDecl should know which type supports which methods,
94 // and it's an *internal* error if a method is called on a DV that
95 // doesn't support it.
96
97     //order constants
98 public static final short LESS_THAN = -1;
99     public static final short EQUAL = 0;
100     public static final short GREATER_THAN = 1;
101     public static final short INDETERMINATE = 2;
102
103     // check the order relation between the two values
104 // the parameters are in compiled form (from getActualValue)
105 public int compare(Object JavaDoc value1, Object JavaDoc value2) {
106         return -1;
107     }
108
109     // get the length of the value
110 // the parameters are in compiled form (from getActualValue)
111 public int getDataLength(Object JavaDoc value) {
112         return (value instanceof String JavaDoc) ? ((String JavaDoc)value).length() : -1;
113     }
114
115     // get the number of digits of the value
116 // the parameters are in compiled form (from getActualValue)
117 public int getTotalDigits(Object JavaDoc value) {
118         return -1;
119     }
120
121     // get the number of fraction digits of the value
122 // the parameters are in compiled form (from getActualValue)
123 public int getFractionDigits(Object JavaDoc value) {
124         return -1;
125     }
126
127     // check whether the character is in the range 0x30 ~ 0x39
128 public static final boolean isDigit(char ch) {
129         return ch >= '0' && ch <= '9';
130     }
131     
132     // if the character is in the range 0x30 ~ 0x39, return its int value (0~9),
133 // otherwise, return -1
134 public static final int getDigit(char ch) {
135         return isDigit(ch) ? ch - '0' : -1;
136     }
137     
138 } // interface TypeValidator
139
Popular Tags