KickJava   Java API By Example, From Geeks To Geeks.

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


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 import java.util.Enumeration JavaDoc;
61 import java.util.Hashtable JavaDoc;
62
63 import org.enhydra.apache.xerces.utils.XMLMessages;
64
65 /**
66  * IDREFValidator defines the interface that data type validators must obey.
67  * These validators can be supplied by the application writer and may be useful as
68  * standalone code as well as plugins to the validator architecture.
69  *
70  * @author Jeffrey Rodriguez-
71  * @author Mark Swinkles - List Validation refactoring
72  * @version $Id: IDREFDatatypeValidator.java,v 1.2 2005/01/26 08:28:44 jkjome Exp $
73  */
74 public class IDREFDatatypeValidator extends StringDatatypeValidator {
75     private static Object JavaDoc fNullValue = new Object JavaDoc();
76
77     public static final int IDREF_VALIDATE = 0;
78     public static final int IDREF_CHECKID = 1;
79
80     public IDREFDatatypeValidator () throws InvalidDatatypeFacetException {
81         this( null, null, false ); // Native, No Facets defined, Restriction
82 }
83
84     public IDREFDatatypeValidator ( DatatypeValidator base, Hashtable JavaDoc facets,
85                                     boolean derivedByList ) throws InvalidDatatypeFacetException {
86
87         // all facets are handled in StringDatatypeValidator
88 super (base, facets, derivedByList);
89
90         // list types are handled by ListDatatypeValidator, we do nothing here.
91 if ( derivedByList )
92             return;
93
94         // the type is NAME by default
95 if (base != null)
96             setTokenType(((IDREFDatatypeValidator)base).fTokenType);
97         else
98             setTokenType(SPECIAL_TOKEN_IDREFNAME);
99     }
100
101     /**
102      * return value of whiteSpace facet
103      */
104     public short getWSFacet() {
105         return COLLAPSE;
106     }
107
108     /**
109      * Checks that "content" string is valid
110      * datatype.
111      * If invalid a Datatype validation exception is thrown.
112      *
113      * @param content A string containing the content to be validated
114      * @param derivedBylist
115      * Flag which is true when type
116      * is derived by list otherwise it
117      * it is derived by extension.
118      *
119      * @exception throws InvalidDatatypeException if the content is
120      * invalid according to the rules for the validators
121      * @exception InvalidDatatypeValueException
122      * @see org.enhydra.apache.xerces.validators.datatype.InvalidDatatypeValueException
123      */
124     public Object JavaDoc validate(String JavaDoc content, Object JavaDoc state ) throws InvalidDatatypeValueException{
125         StateMessageDatatype message = (StateMessageDatatype) state;
126         if (message != null && message.getDatatypeState() == IDREF_CHECKID) {
127             Object JavaDoc[] params = (Object JavaDoc[])message.getDatatypeObject();
128             checkIdRefs((Hashtable JavaDoc)params[0], (Hashtable JavaDoc)params[1]);
129         }
130         else {
131             // use StringDatatypeValidator to validate content against facets
132 super.validate(content, state);
133
134             if ( message != null && message.getDatatypeState() == IDREF_VALIDATE )
135                 addIdRef( content, (Hashtable JavaDoc)message.getDatatypeObject());
136         }
137
138         return null;
139     }
140
141
142     /**
143        * Returns a copy of this object.
144        */
145     public Object JavaDoc clone() throws CloneNotSupportedException JavaDoc {
146         throw new CloneNotSupportedException JavaDoc("clone() is not supported in "+this.getClass().getName());
147     }
148
149     /** addId. */
150     private void addIdRef(String JavaDoc content, Hashtable JavaDoc IDREFList) {
151         if ( IDREFList.containsKey( content ) )
152             return;
153
154         try {
155             IDREFList.put( content, fNullValue );
156         }
157         catch ( OutOfMemoryError JavaDoc ex ) {
158             System.out.println( "Out of Memory: Hashtable of ID's has " + IDREFList.size() + " Elements" );
159             ex.printStackTrace();
160         }
161     } // addId(int):boolean
162
163
164     private void checkIdRefs(Hashtable JavaDoc IDList, Hashtable JavaDoc IDREFList) throws InvalidDatatypeValueException {
165         Enumeration JavaDoc en = IDREFList.keys();
166
167         while ( en.hasMoreElements() ) {
168             String JavaDoc key = (String JavaDoc)en.nextElement();
169             if ( !IDList.containsKey(key) ) {
170                 InvalidDatatypeValueException error = new InvalidDatatypeValueException( key );
171                 error.setMinorCode(XMLMessages.MSG_ELEMENT_WITH_ID_REQUIRED);
172                 error.setMajorCode(XMLMessages.VC_IDREF);
173                 throw error;
174             }
175         }
176     } // checkIdRefs()
177 }
178
Popular Tags