/*
* Redistribution and use of this software and associated documentation
* ("Software"), with or without modification, are permitted provided
* that the following conditions are met:
*
* 1. Redistributions of source code must retain copyright
* statements and notices. Redistributions must also contain a
* copy of this document.
*
* 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 name "Exolab" must not be used to endorse or promote
* products derived from this Software without prior written
* permission of Intalio, Inc. For written permission,
* please contact info@exolab.org.
*
* 4. Products derived from this Software may not be called "Exolab"
* nor may "Exolab" appear in their names without prior written
* permission of Intalio, Inc. Exolab is a registered
* trademark of Intalio, Inc.
*
* 5. Due credit should be given to the Exolab Project
* (http://www.exolab.org/).
*
* THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
* ``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
* INTALIO, INC. 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.
*
* Copyright 1999-2003 (C) Intalio, Inc. All Rights Reserved.
*
* $Id$
*/
package org.exolab.castor.xml.validators;
import org.exolab.castor.xml.ValidationContext;
import org.exolab.castor.xml.ValidationException;
import org.exolab.castor.xml.XMLConstants;
/**
* The Name Validation class. This class handles validation for XML Name
* production types such as NCName and NMToken
*
* @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
* @version $Revision$ $Date: 2005-12-13 14:58:48 -0700 (Tue, 13 Dec 2005) $
*/
public class NameValidator extends StringValidator {
/** XML name type NCName. @deprecated - use XMLConstants.NAME_TYPE_NCNAME.
* Retained for backwards-compatility. */
public static final short NCNAME = XMLConstants.NAME_TYPE_NCNAME;
/** XML name type NMTOKEN. @deprecated - use XMLConstants.NAME_TYPE_NCTOKEN.
* Retained for backwards-compatility. */
public static final short NMTOKEN = XMLConstants.NAME_TYPE_NMTOKEN;
/** XML name type CDATA. @deprecated - use XMLConstants.NAME_TYPE_CDATA.
* Retained for backwards-compatility. */
public static final short CDATA = XMLConstants.NAME_TYPE_CDATA;
/** Name type. */
private short _type = XMLConstants.NAME_TYPE_NCNAME;
/**
* Creates a new NameValidator with the default validation set to NCName.
*/
public NameValidator() {
super();
} // -- NameValidator
/**
* Creates a new NameValidator with the given validation type.
*
* @param type
* the validation type for this NameValidator
*/
public NameValidator(final short type) {
super();
this._type = type;
} // -- NMTokenValidator
/**
* Sets whether or not a String is required (non null).
*
* @param required
* the flag indicating whether Strings are required
*/
public void setRequired(final boolean required) {
// not implemented?
}
/**
* Validates the given Object.
*
* @param value
* the string to validate
* @param context
* the ValidationContext
* @throws ValidationException if the object fails validation.
*/
public void validate(final String value, final ValidationContext context)
throws ValidationException {
super.validate(value, context);
switch (_type) {
case XMLConstants.NAME_TYPE_CDATA:
if (!ValidationUtils.isCDATA(value)) {
String err = "Name '" + value + "' is not a valid CDATA.";
throw new ValidationException(err);
}
break;
case XMLConstants.NAME_TYPE_NMTOKEN:
if (!ValidationUtils.isNMToken(value)) {
String err = "Name '" + value + "' is not a valid NMToken.";
throw new ValidationException(err);
}
break;
case XMLConstants.NAME_TYPE_QNAME:
if (!ValidationUtils.isQName(value)) {
String err = "Name '" + value + "' is not a valid QName.";
throw new ValidationException(err);
}
break;
case XMLConstants.NAME_TYPE_NCNAME:
default:
if (!ValidationUtils.isNCName(value)) {
String err = "Name '" + value + "' is not a valid NCName.";
throw new ValidationException(err);
}
break;
}
} // -- validate
/**
* Validates the given Object.
*
* @param object
* the Object to validate
* @throws ValidationException if the object fails validation.
*/
public void validate(final Object object) throws ValidationException {
validate(object, (ValidationContext) null);
} // -- validate
/**
* Validates the given Object.
*
* @param object
* the Object to validate
* @param context
* the ValidationContext
* @throws ValidationException if the object fails validation.
*/
public void validate(final Object object, final ValidationContext context)
throws ValidationException {
if (object != null) {
validate(object.toString(), context);
} else {
validate(null, context);
}
} // -- validate
} // -- NameValidator