| /* |
| * The Apache Software License, Version 1.1 |
| * |
| * |
| * Copyright (c) 1999, 2000 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Xerces" and "Apache Software Foundation" must |
| * not be used to endorse or promote products derived from this |
| * software without prior written permission. For written |
| * permission, please contact apache@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache", |
| * nor may "Apache" appear in their name, without prior written |
| * permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation and was |
| * originally based on software copyright (c) 1999, International |
| * Business Machines, Inc., http://www.apache.org. For more |
| * information on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| */ |
| |
| package org.apache.xerces.impl.dv.dtd; |
| |
| import java.util.Hashtable; |
| import java.util.Vector; |
| import java.util.Enumeration; |
| import java.util.Locale; |
| import java.text.Collator; |
| import java.util.Enumeration; |
| import java.util.StringTokenizer; |
| import java.util.NoSuchElementException; |
| |
| |
| |
| /** |
| * StringValidator validates that XML content is a W3C string type. |
| */ |
| public class ListDatatypeValidator extends AbstractDatatypeValidator |
| implements StatefullDatatypeValidator { |
| private Locale fLocale = null; |
| DatatypeValidator fBaseValidator = null; // Native datatypes have null |
| |
| private int fLength = 0; |
| private int fMaxLength = Integer.MAX_VALUE; |
| private int fMinLength = 0; |
| private String fPattern = null; |
| private Vector fEnumeration = null; |
| private int fFacetsDefined = 0; |
| private boolean fDerivedByList = false;//default |
| |
| //private RegularExpression fRegex = null; |
| |
| |
| |
| |
| public ListDatatypeValidator () throws InvalidDatatypeFacetException{ |
| this( null, null, false ); // Native, No Facets defined, Restriction |
| |
| } |
| |
| public ListDatatypeValidator ( DatatypeValidator base, Hashtable facets, |
| boolean derivedByList ) throws InvalidDatatypeFacetException { |
| |
| setBasetype( base ); // Set base type |
| |
| fDerivedByList = derivedByList; |
| |
| if (facets != null) { |
| for (Enumeration e = facets.keys(); e.hasMoreElements();) { |
| String key = (String) e.nextElement(); |
| if (key.equals("length")) { |
| fFacetsDefined += DatatypeValidator.FACET_LENGTH; |
| String lengthValue = (String)facets.get(key); |
| try { |
| fLength = Integer.parseInt( lengthValue ); |
| } catch (NumberFormatException nfe) { |
| throw new InvalidDatatypeFacetException("Length value '"+lengthValue+"' is invalid."); |
| } |
| if (fLength < 0) |
| throw new InvalidDatatypeFacetException("Length value '"+lengthValue+"' must be a nonNegativeInteger."); |
| |
| } else if (key.equals("minlength")) { |
| fFacetsDefined += DatatypeValidator.FACET_MINLENGTH; |
| String minLengthValue = (String)facets.get(key); |
| try { |
| fMinLength = Integer.parseInt( minLengthValue ); |
| } catch (NumberFormatException nfe) { |
| throw new InvalidDatatypeFacetException("maxLength value '"+minLengthValue+"' is invalid."); |
| } |
| } else if (key.equals("maxlength")) { |
| fFacetsDefined += DatatypeValidator.FACET_MAXLENGTH; |
| String maxLengthValue = (String)facets.get(key); |
| try { |
| fMaxLength = Integer.parseInt( maxLengthValue ); |
| } catch (NumberFormatException nfe) { |
| throw new InvalidDatatypeFacetException("maxLength value '"+maxLengthValue+"' is invalid."); |
| } |
| } else if (key.equals("enumeration")) { |
| fFacetsDefined += DatatypeValidator.FACET_ENUMERATION; |
| fEnumeration = (Vector)facets.get(key); |
| } else { |
| throw new InvalidDatatypeFacetException("invalid facet tag : " + key); |
| } |
| } |
| if (((fFacetsDefined & DatatypeValidator.FACET_LENGTH ) != 0 )) { |
| if (((fFacetsDefined & DatatypeValidator.FACET_MAXLENGTH ) != 0 )) { |
| throw new InvalidDatatypeFacetException( |
| "It is an error for both length and maxLength to be members of facets." ); |
| } else if (((fFacetsDefined & DatatypeValidator.FACET_MINLENGTH ) != 0 )) { |
| throw new InvalidDatatypeFacetException( |
| "It is an error for both length and minLength to be members of facets." ); |
| } |
| } |
| |
| if (( (fFacetsDefined & ( DatatypeValidator.FACET_MINLENGTH | |
| DatatypeValidator.FACET_MAXLENGTH) ) != 0 )) { |
| if (fMinLength > fMaxLength) { |
| throw new InvalidDatatypeFacetException( "Value of minLength = " + fMinLength + |
| "must be greater that the value of maxLength" + fMaxLength ); |
| } |
| } |
| }// End of Facets Setting |
| } |
| |
| |
| |
| |
| /** |
| * validate that a string is a W3C string type |
| * |
| * @param content A string containing the content to be validated |
| * @param list |
| * @exception throws InvalidDatatypeException if the content is |
| * not a W3C string type |
| * @exception InvalidDatatypeValueException |
| */ |
| public void validate(String content, Object state) throws InvalidDatatypeValueException |
| { |
| checkContent( content, state ); |
| } |
| |
| |
| /** |
| * set the locate to be used for error messages |
| */ |
| public void setLocale(Locale locale) { |
| fLocale = locale; |
| } |
| |
| |
| /** |
| * |
| * @return A Hashtable containing the facets |
| * for this datatype. |
| */ |
| public Hashtable getFacets() { |
| return null; |
| } |
| |
| public int compare( String content, String facetValue ) { |
| // if derive by list then this should iterate through |
| // the tokens in each string and compare using the base type |
| // compare function. |
| // if not derived by list just pass the compare down to the |
| // base type. |
| return 0; |
| } |
| |
| /** |
| * Returns a copy of this object. |
| */ |
| public Object clone() throws CloneNotSupportedException { |
| ListDatatypeValidator newObj = null; |
| try { |
| newObj = new ListDatatypeValidator(); |
| |
| newObj.fLocale = this.fLocale; |
| newObj.fBaseValidator = this.fBaseValidator; |
| newObj.fLength = this.fLength; |
| newObj.fMaxLength = this.fMaxLength; |
| newObj.fMinLength = this.fMinLength; |
| newObj.fPattern = this.fPattern; |
| newObj.fEnumeration = this.fEnumeration; |
| newObj.fFacetsDefined = this.fFacetsDefined; |
| newObj.fDerivedByList = this.fDerivedByList; |
| } catch (InvalidDatatypeFacetException ex) { |
| ex.printStackTrace(); |
| } |
| return newObj; |
| } |
| |
| // Private methods |
| private void checkContent( String content, Object state )throws InvalidDatatypeValueException |
| { |
| StringTokenizer parsedList = new StringTokenizer( content ); |
| try { |
| int numberOfTokens = parsedList.countTokens(); |
| if ((fFacetsDefined & DatatypeValidator.FACET_MAXLENGTH) != 0) { |
| if (numberOfTokens > fMaxLength) { |
| throw new InvalidDatatypeValueException("Value '"+content+ |
| "' with length ='"+ numberOfTokens + "' tokens"+ |
| "' exceeds maximum length facet of '"+fMaxLength+"' tokens."); |
| } |
| } |
| if ((fFacetsDefined & DatatypeValidator.FACET_MINLENGTH) != 0) { |
| if (numberOfTokens < fMinLength) { |
| throw new InvalidDatatypeValueException("Value '"+content+ |
| "' with length ='"+ numberOfTokens+ "' tokens" + |
| "' is less than minimum length facet of '"+fMinLength+"' tokens." ); |
| } |
| } |
| |
| if ((fFacetsDefined & DatatypeValidator.FACET_LENGTH) != 0) { |
| if (numberOfTokens != fLength) { |
| throw new InvalidDatatypeValueException("Value '"+content+ |
| "' with length ='"+ numberOfTokens+ "' tokens" + |
| "' is not equal to length facet of '"+fLength+"' tokens."); |
| } |
| } |
| |
| if ((fFacetsDefined & DatatypeValidator.FACET_ENUMERATION) != 0) { |
| // Enumerations are defined in the value space so the contains method |
| // of vector doesn't really do the right thing, we really should check using compare |
| if (fEnumeration.contains( content ) == false) |
| throw new InvalidDatatypeValueException("Value '"+ |
| content+"' must be one of "+fEnumeration); |
| } |
| try { |
| if (this.fDerivedByList) { |
| if( numberOfTokens == 0 ){ |
| InvalidDatatypeValueException error = new InvalidDatatypeValueException( content ); |
| throw error; |
| } |
| while (parsedList.hasMoreTokens()) { //Check each token in list against base type |
| if (this.fBaseValidator != null) {//validate against parent type if any |
| this.fBaseValidator.validate( parsedList.nextToken(), state ); |
| } |
| } |
| } else { |
| if (this.fBaseValidator != null) {//validate against parent type if any |
| this.fBaseValidator.validate( content, state ); |
| } |
| } |
| } catch (InvalidDatatypeValueException ex) { //Keep bubbling up exception but change content to list content |
| //Unfortunately we need to throw a new Exception |
| InvalidDatatypeValueException error = new InvalidDatatypeValueException( content );//Need Message |
| error.setKeyIntoReporter( ex.getKeyIntoReporter() ); |
| throw error;//type message repacked with the List content message |
| } |
| |
| } catch (NoSuchElementException e) { |
| e.printStackTrace(); |
| } |
| } |
| |
| private void setBasetype( DatatypeValidator base) { |
| fBaseValidator = base; |
| } |
| |
| /** |
| * <P>Initializes the internal datattype state with documentInstance state information</P> |
| * <P>This method should be called before calling the |
| * validate method</P> |
| * |
| * @param documentInstanceState |
| */ |
| public void initialize( Object documentInstanceState ) { |
| if (fBaseValidator instanceof StatefullDatatypeValidator) { |
| ((StatefullDatatypeValidator)fBaseValidator).initialize( documentInstanceState ); |
| } |
| } |
| |
| /** |
| * <P>Initializes the internal datatype state |
| */ |
| |
| public void validate()throws InvalidDatatypeValueException { |
| if ((fBaseValidator instanceof |
| org.apache.xerces.impl.dv.dtd.IDREFDatatypeValidator )) { |
| ((StatefullDatatypeValidator)fBaseValidator).validate(); |
| } |
| |
| } |
| /** |
| * <P>This method returns some internal state of a statefull validator</P> |
| * It returns a reference to the internal state |
| * |
| * @return Object |
| */ |
| public Object getInternalStateInformation() { |
| Object value = null; |
| if (fBaseValidator instanceof |
| org.apache.xerces.impl.dv.dtd.IDDatatypeValidator) { |
| value = ((StatefullDatatypeValidator)fBaseValidator).getInternalStateInformation(); |
| } |
| return value; |
| } |
| |
| |
| |
| } |
| |
