org.exolab.castor.xml.schema.reader
Class SchemaReader

java.lang.Object
  org.exolab.castor.xml.schema.reader.SchemaReader

public class SchemaReader
extends Object

A class for reading XML Schemas.

Version:

$Revision: 7410 $ $Date: 2004-10-05 14:27:10 -0600 (Tue, 05 Oct 2004) $

Author:

Keith Visco

Constructor Summary

SchemaReader()
New style how to create a SchemaReader instance, requiring that SchemaContext and InputSource are set before calling read.

SchemaReader(InputSource source)
Creates a new SchemaReader for the given InputSource

SchemaReader(Reader reader, String filename)
Creates a new SchemaReader for the given Reader

SchemaReader(String url)
Creates a new SchemaReader for the given URL

Method Summary

Schema	read() Reads the Schema from the source and returns the Schema object model.
void	setCacheIncludedSchemas(boolean cache) Sets wheter or not to cache the included xml schemas instead of inlining them as specified by the XML Schema specification.
void	setEntityResolver(EntityResolver resolver) Sets the EntityResolver used to resolve SYSTEM Identifier.
void	setErrorHandler(ErrorHandler errorHandler) Sets the ErrorHandler.
void	setInputSource(InputSource inputSource) A different way to create a SchemaReader by using an empty constructor and setting the InputSource afterwards.
void	setSchemaContext(SchemaContext schemaContext) To set the SchemaContext to be used.
void	setURIResolver(URIResolver uriresolver) Sets the URIResolver used to resolve hrefs.
void	setValidation(boolean validate) Sets whether or not post-read validation should occur.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SchemaReader

public SchemaReader(InputSource source)
             throws IOException

Creates a new SchemaReader for the given InputSource

Parameters:

source - the InputSource to read the Schema from.

Throws:

IOException

SchemaReader

public SchemaReader(Reader reader,
                    String filename)
             throws IOException

Creates a new SchemaReader for the given Reader

Parameters:

reader - the Reader to read the Schema from.

filename - for reporting errors.

Throws:

IOException

SchemaReader

public SchemaReader(String url)
             throws IOException

Creates a new SchemaReader for the given URL

Parameters:

url - the URL string

Throws:

IOException

SchemaReader

public SchemaReader()

New style how to create a SchemaReader instance, requiring that SchemaContext and InputSource are set before calling read.

Method Detail

setSchemaContext

public void setSchemaContext(SchemaContext schemaContext)

To set the SchemaContext to be used. Also resets the parser as it depends of the SchemaContext.

Parameters:

schemaContext - the SchemaContext to be used

setInputSource

public void setInputSource(InputSource inputSource)

A different way to create a SchemaReader by using an empty constructor and setting the InputSource afterwards.

Parameters:

inputSource - the InputSource to read the schema from

read

public Schema read()
            throws IOException

Reads the Schema from the source and returns the Schema object model.
Note: Subsequent calls to this method will simply return a cached copy of the Schema object. To read a new Schema object, create a new Reader.

Returns:

the new Schema created from the source of this SchemaReader

Throws:

IOException

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

Sets the ErrorHandler.

Parameters:

errorHandler -

setCacheIncludedSchemas

public void setCacheIncludedSchemas(boolean cache)

Sets wheter or not to cache the included xml schemas instead of inlining them as specified by the XML Schema specification.

Parameters:

cache - true to cache the included XML Schemas.

setValidation

public void setValidation(boolean validate)

Sets whether or not post-read validation should occur. By default, validation is enabled. Note that certain read validation cannot be disabled.

Parameters:

validate - a boolean that when true will force a call to Schema#validate after the schema is read.

setEntityResolver

public void setEntityResolver(EntityResolver resolver)

Sets the EntityResolver used to resolve SYSTEM Identifier. If the entity resolver is null, the default one will be used.

Parameters:

resolver - the EntityResolver to use.

setURIResolver

public void setURIResolver(URIResolver uriresolver)

Sets the URIResolver used to resolve hrefs. If the entity resolver is null, the default one will be used.

Parameters:

uriresolver - the URIResolver to use.