001: /*
002: * The Apache Software License, Version 1.1
003: *
004: *
005: * Copyright (c) 1999, 2000 The Apache Software Foundation. All rights
006: * reserved.
007: *
008: * Redistribution and use in source and binary forms, with or without
009: * modification, are permitted provided that the following conditions
010: * are met:
011: *
012: * 1. Redistributions of source code must retain the above copyright
013: * notice, this list of conditions and the following disclaimer.
014: *
015: * 2. Redistributions in binary form must reproduce the above copyright
016: * notice, this list of conditions and the following disclaimer in
017: * the documentation and/or other materials provided with the
018: * distribution.
019: *
020: * 3. The end-user documentation included with the redistribution,
021: * if any, must include the following acknowledgment:
022: * "This product includes software developed by the
023: * Apache Software Foundation (http://www.apache.org/)."
024: * Alternately, this acknowledgment may appear in the software itself,
025: * if and wherever such third-party acknowledgments normally appear.
026: *
027: * 4. The names "Xerces" and "Apache Software Foundation" must
028: * not be used to endorse or promote products derived from this
029: * software without prior written permission. For written
030: * permission, please contact apache@apache.org.
031: *
032: * 5. Products derived from this software may not be called "Apache",
033: * nor may "Apache" appear in their name, without prior written
034: * permission of the Apache Software Foundation.
035: *
036: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
040: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: * SUCH DAMAGE.
048: * ====================================================================
049: *
050: * This software consists of voluntary contributions made by many
051: * individuals on behalf of the Apache Software Foundation and was
052: * originally based on software copyright (c) 1999, International
053: * Business Machines, Inc., http://www.apache.org. For more
054: * information on the Apache Software Foundation, please see
055: * <http://www.apache.org/>.
056: */
057:
058: package org.apache.xerces.validators.datatype;
059:
060: import java.util.Hashtable;
061: import java.util.Enumeration;
062: import java.util.Vector;
063: import org.apache.xerces.utils.XMLCharacterProperties;
064: import org.apache.xerces.utils.XMLMessages;
065: import org.apache.xerces.validators.schema.SchemaSymbols;
066:
067: /**
068: * IDREFValidator defines the interface that data type validators must obey.
069: * These validators can be supplied by the application writer and may be useful as
070: * standalone code as well as plugins to the validator architecture.
071: *
072: * @author Jeffrey Rodriguez-
073: * @author Mark Swinkles - List Validation refactoring
074: * @version $Id: IDREFDatatypeValidator.java,v 1.23 2001/06/20 15:09:07 sandygao Exp $
075: */
076: public class IDREFDatatypeValidator extends StringDatatypeValidator {
077: private static Object fNullValue = new Object();
078:
079: public static final int IDREF_VALIDATE = 0;
080: public static final int IDREF_CHECKID = 1;
081:
082: public IDREFDatatypeValidator()
083: throws InvalidDatatypeFacetException {
084: this (null, null, false); // Native, No Facets defined, Restriction
085: }
086:
087: public IDREFDatatypeValidator(DatatypeValidator base,
088: Hashtable facets, boolean derivedByList)
089: throws InvalidDatatypeFacetException {
090:
091: // all facets are handled in StringDatatypeValidator
092: super (base, facets, derivedByList);
093:
094: // list types are handled by ListDatatypeValidator, we do nothing here.
095: if (derivedByList)
096: return;
097:
098: // the type is NAME by default
099: if (base != null)
100: setTokenType(((IDREFDatatypeValidator) base).fTokenType);
101: else
102: setTokenType(SPECIAL_TOKEN_IDREFNAME);
103: }
104:
105: /**
106: * return value of whiteSpace facet
107: */
108: public short getWSFacet() {
109: return COLLAPSE;
110: }
111:
112: /**
113: * Checks that "content" string is valid
114: * datatype.
115: * If invalid a Datatype validation exception is thrown.
116: *
117: * @param content A string containing the content to be validated
118: * @param derivedBylist
119: * Flag which is true when type
120: * is derived by list otherwise it
121: * it is derived by extension.
122: *
123: * @exception throws InvalidDatatypeException if the content is
124: * invalid according to the rules for the validators
125: * @exception InvalidDatatypeValueException
126: * @see org.apache.xerces.validators.datatype.InvalidDatatypeValueException
127: */
128: public Object validate(String content, Object state)
129: throws InvalidDatatypeValueException {
130: StateMessageDatatype message = (StateMessageDatatype) state;
131: if (message != null
132: && message.getDatatypeState() == IDREF_CHECKID) {
133: Object[] params = (Object[]) message.getDatatypeObject();
134: checkIdRefs((Hashtable) params[0], (Hashtable) params[1]);
135: } else {
136: // use StringDatatypeValidator to validate content against facets
137: super .validate(content, state);
138:
139: if (message != null
140: && message.getDatatypeState() == IDREF_VALIDATE)
141: addIdRef(content, (Hashtable) message
142: .getDatatypeObject());
143: }
144:
145: return null;
146: }
147:
148: /**
149: * Returns a copy of this object.
150: */
151: public Object clone() throws CloneNotSupportedException {
152: throw new CloneNotSupportedException(
153: "clone() is not supported in "
154: + this .getClass().getName());
155: }
156:
157: /** addId. */
158: private void addIdRef(String content, Hashtable IDREFList) {
159: if (IDREFList.containsKey(content))
160: return;
161:
162: try {
163: IDREFList.put(content, fNullValue);
164: } catch (OutOfMemoryError ex) {
165: System.out.println("Out of Memory: Hashtable of ID's has "
166: + IDREFList.size() + " Elements");
167: ex.printStackTrace();
168: }
169: } // addId(int):boolean
170:
171: private void checkIdRefs(Hashtable IDList, Hashtable IDREFList)
172: throws InvalidDatatypeValueException {
173: Enumeration en = IDREFList.keys();
174:
175: while (en.hasMoreElements()) {
176: String key = (String) en.nextElement();
177: if (!IDList.containsKey(key)) {
178: InvalidDatatypeValueException error = new InvalidDatatypeValueException(
179: key);
180: error
181: .setMinorCode(XMLMessages.MSG_ELEMENT_WITH_ID_REQUIRED);
182: error.setMajorCode(XMLMessages.VC_IDREF);
183: throw error;
184: }
185: }
186: } // checkIdRefs()
187: }
|