/**
* 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-2002 (C) Intalio, Inc. All Rights Reserved.
*
* $Id$
*/
package org.exolab.castor.xml.schema.reader;
import org.exolab.castor.net.URIResolver;
import org.exolab.castor.xml.AttributeSet;
import org.exolab.castor.xml.Namespaces;
import org.exolab.castor.xml.XMLException;
import org.exolab.castor.xml.schema.SchemaContext;
import org.exolab.castor.xml.schema.Resolver;
import org.xml.sax.Locator;
/**
* The base class for separate component unmarshallers for
* reading an XML Schema component.
*
* @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
* @version $Revision$ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $
**/
public abstract class ComponentReader {
//--------------------/
//- Member Variables -/
//--------------------/
/** The Castor XML context to use. */
private SchemaContext _schemaContext;
private Locator _documentLocator;
/**
* The resolver to be used for resolving href.
*/
private URIResolver _uriResolver;
//----------------/
//- Constructors -/
//----------------/
private ComponentReader() {
super();
} //-- ComponentReader
/**
* To hand down a couple of configuration items to all Unmarshaller classes.
* @param schemaContext the {@link SchemaContext} to use
*/
protected ComponentReader(final SchemaContext schemaContext) {
this();
_schemaContext = schemaContext;
}
//-----------/
//- Methods -/
//-----------/
/**
* Returns the name of the element that this ComponentReader
* handles
* @return the name of the element that this ComponentReader
* handles
**/
public abstract String elementName();
/**
* Returns the Object created by this Unmarshaller
* @return the Object created by this Unmarshaller
**/
public abstract Object getObject();
/**
* Called to signal an end of unmarshalling. This method should
* be overridden to perform any necessary clean up by an unmarshaller
**/
public void finish() throws XMLException {}
/**
* Returns the resolver used for resolving id references.
* @return the resolver used for resolving id references.
**/
public Resolver getResolver() {
return _schemaContext.getSchemaResolver();
} //-- getResolver
/**
* Returns the URIresolver used for resolving hrefs.
*
* @return the URIresolver used for resolving hrefs.
**/
public URIResolver getURIResolver() {
return _uriResolver;
} //-- getResolver
/**
* Sets the Resolver to be used for resolving id references
* @param resolver the Resolver to be used for resolving
* id references
**/
public void setResolver(Resolver resolver) {
_schemaContext.setSchemaResolver(resolver);
} //-- setResolver
/**
* Sets the URIResolver to be used for resolving hrefs.
*
* @param uriResolver the URIResolver to be used for resolving hrefs.
**/
public void setURIResolver(URIResolver uriResolver) {
_uriResolver = uriResolver;
} //-- setResolver
/**
* Determines if the given sequence of characters consists
* of whitespace characters
* @param chars an array of characters to check for whitespace
* @param start the start index into the character array
* @param length the number of characters to check
* @return true if the characters specficied consist only
* of whitespace characters
**/
public static boolean isWhiteSpace(char[] chars, int start, int length) {
int max = start+length;
for (int i = start; i < max; i++) {
char ch = chars[i];
switch(ch) {
case ' ':
case '\n':
case '\t':
case '\r':
break;
default:
return false;
}
}
return true;
} //-- isWhiteSpace
/**
* This method is called for a general error.
* @param err the error message to report
**/
public void error(String err)
throws XMLException
{
if (getDocumentLocator() != null) {
err += "\n line: " + getDocumentLocator().getLineNumber();
}
throw new XMLException(err);
} //-- error
/**
* This method is called for a general error.
*
* @param ex the Exception that caused the error.
*/
public void error(Exception ex)
throws XMLException
{
if (getDocumentLocator() != null) {
String err = "An error occured at line: " + getDocumentLocator().getLineNumber();
throw new XMLException(err, ex);
}
throw new XMLException(ex);
} //-- error
/**
* This method is called when an illegal Attribute is encountered.
* @param attName the name of the illegal attribute.
**/
public void illegalAttribute(String attName)
throws XMLException
{
String err = "Illegal attribute '" + attName +
"' found on element <" + elementName() + ">.";
if (getDocumentLocator() != null) {
err += "\n line: " + getDocumentLocator().getLineNumber();
}
throw new XMLException(err);
} //-- illegalAttribute
/**
* This method is called when an illegal Element is encountered.
* @param name the name of the illegal element
**/
public void illegalElement(String name)
throws XMLException
{
String err = "Illegal element '" + name +
"' found as child of <" + elementName() + ">.";
if (getDocumentLocator() != null) {
err += "\n line: " + getDocumentLocator().getLineNumber();
}
throw new XMLException(err);
} //-- illegalElement
/**
* This method is called when an element which may only
* be defined once, is redefined.
* @param name the name of the element
**/
public void redefinedElement(String name)
throws XMLException
{
redefinedElement(name, null);
} //-- redefinedElement
/**
* This method is called when an element which may only
* be defined once, is redefined.
* @param name the name of the element
**/
public void redefinedElement(String name, String xtraInfo)
throws XMLException
{
String err = "redefintion of element '" + name +
"' within element <" + elementName() + ">.";
if (getDocumentLocator() != null) {
err += "\n line: " + getDocumentLocator().getLineNumber();
}
if (xtraInfo != null) {
err += "\n " + xtraInfo;
}
throw new XMLException(err+"\n");
} //-- redefinedElement
/**
* This method is called when an out of order element is encountered
**/
public void outOfOrder(String name)
throws XMLException
{
StringBuffer err = new StringBuffer("out of order element <");
err.append(name);
err.append("> found in <");
err.append(elementName());
err.append(">.");
throw new XMLException(err.toString());
}
/**
* Converts the given String to an int
* @param str the String to convert to an int
* @return the int derived from the given String
* @exception IllegalArgumentException when the given
* String does not represent a valid int
**/
public static int toInt(String str)
throws IllegalArgumentException
{
try {
return Integer.parseInt(str);
}
catch(NumberFormatException nfe) {
String err = str+" is not a valid integer. ";
throw new IllegalArgumentException(err);
}
} //-- toInt
public Locator getDocumentLocator() {
return _documentLocator;
} //-- getDocumentLocator
public void setDocumentLocator(Locator documentLocator) {
_documentLocator = documentLocator;
} //-- setDocumentLocator
/**
* Signals to recieve charactes
*
* @param chars the character array containing the characters
* @param start the starting index into the character array
* @param length the number of characters to recieve
**/
public void characters(char[] chars, int start, int length)
throws XMLException
{
//-- do nothing, this method is overwritten by subclasses
} //-- characters
/**
* Signals to end of the element with the given name.
*
* @param name the NCName of the element. It is an error
* if the name is a QName (ie. contains a prefix).
* @param namespace the namespace of the element.
**/
public void endElement(String name, String namespace)
throws XMLException
{
//-- do nothing, this method is overwritten by subclasses
} //-- endElement
/**
* Signals the start of an element with the given name.
*
* @param name the NCName of the element. It is an error
* if the name is a QName (ie. contains a prefix).
* @param namespace the namespace of the element. This may be null.
* Note: A null namespace is not the same as the default namespace unless
* the default namespace is also null.
* @param atts the AttributeSet containing the attributes associated
* with the element.
* @param nsDecls the namespace declarations being declared for this
* element. This may be null.
**/
public void startElement(String name, String namespace, AttributeSet atts,
Namespaces nsDecls)
throws XMLException
{
//-- do nothing, this method is overwritten by subclasses
} //-- startElement
/**
* To set the Castor XML schema context to be used.
* @param schemaContext the Castor XML schema context to be used
*/
public void setSchemaContext(final SchemaContext schemaContext) {
_schemaContext = schemaContext;
}
/**
* To get the Castor XML schema context used.
* @return the Castor XML schema context used
*/
public SchemaContext getSchemaContext() {
return _schemaContext;
}
} //-- ComponentReader