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

java.lang.Object
  extended by org.exolab.castor.xml.schema.reader.ComponentReader
      extended by org.exolab.castor.xml.schema.reader.SchemaUnmarshaller

public class SchemaUnmarshaller
extends ComponentReader

Version:
$Revision: 7506 $ $Date: 2006-04-13 06:47:36 -0600 (Thu, 13 Apr 2006) $
Author:
Keith Visco

Nested Class Summary
(package private) static class SchemaUnmarshaller.RemappedPrefixes
          This class handles remapping of namespace prefixes for attributes of type QName.
 
Field Summary
(package private)  Schema _schema
           
(package private)  boolean skipAll
           
static java.lang.String[] UNSUPPORTED_NAMESPACES
          Unsupported namespace definitions, pointing to older XML schema specifications.
static java.lang.String XSD_NAMESPACE
          W3C XML schema namespace.
 
Constructor Summary
SchemaUnmarshaller(SchemaContext schemaContext)
          Creates a SchemaUnmarshaller instance.
SchemaUnmarshaller(SchemaContext schemaContext, AttributeSet atts)
          Creates a SchemaUnmarshaller instance.
SchemaUnmarshaller(SchemaContext schemaContext, boolean include, SchemaUnmarshallerState state, URIResolver uriResolver)
          Creates a SchemaUnmarshaller instance.
SchemaUnmarshaller(SchemaContext schemaContext, SchemaUnmarshallerState state)
          Creates a SchemaUnmarshaller instance.
 
Method Summary
 void characters(char[] ch, int start, int length)
          Signals to recieve charactes
 java.lang.String elementName()
          Returns the name of the element that this ComponentReader handles.
 void endElement(java.lang.String name, java.lang.String namespace)
          Signals to end of the element with the given name.
 java.lang.Object getObject()
          Returns the Object created by this ComponentReader.
 Schema getSchema()
          Returns the Schema instance representing the XML schema (file) just processed.
 void setSchema(Schema schema)
          Sets the Schema instance to be processed.
 void startElement(java.lang.String name, java.lang.String namespace, AttributeSet atts, Namespaces nsDecls)
          Signals the start of an element with the given name.
 
Methods inherited from class org.exolab.castor.xml.schema.reader.ComponentReader
error, error, finish, getDocumentLocator, getResolver, getSchemaContext, getURIResolver, illegalAttribute, illegalElement, isWhiteSpace, outOfOrder, redefinedElement, redefinedElement, setDocumentLocator, setResolver, setSchemaContext, setURIResolver, toInt
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

XSD_NAMESPACE

public static final java.lang.String XSD_NAMESPACE
W3C XML schema namespace.

See Also:
Constant Field Values

UNSUPPORTED_NAMESPACES

public static final java.lang.String[] UNSUPPORTED_NAMESPACES
Unsupported namespace definitions, pointing to older XML schema specifications.


skipAll

boolean skipAll

_schema

Schema _schema
Constructor Detail

SchemaUnmarshaller

public SchemaUnmarshaller(SchemaContext schemaContext)
                   throws XMLException
Creates a SchemaUnmarshaller instance.

Parameters:
schemaContext - A SchemaContext to be used during schema unmarshalling.
Throws:
XMLException - Indicates that the XML schema cannnot be processed

SchemaUnmarshaller

public SchemaUnmarshaller(SchemaContext schemaContext,
                          SchemaUnmarshallerState state)
                   throws XMLException
Creates a SchemaUnmarshaller instance.

Parameters:
schemaContext - A SchemaContext to be used during schema unmarshalling.
state - A SchemaUnmarshallerState to be used during unmarshalling.
Throws:
XMLException - Indicates that the XML schema cannnot be processed

SchemaUnmarshaller

public SchemaUnmarshaller(SchemaContext schemaContext,
                          boolean include,
                          SchemaUnmarshallerState state,
                          URIResolver uriResolver)
                   throws XMLException
Creates a SchemaUnmarshaller instance.

Parameters:
schemaContext - A SchemaContext to be used during schema unmarshalling.
include - Indicates whether the Schema to be processed ia an included schema.
state - A SchemaUnmarshallerState to be used during unmarshalling.
uriResolver - URIResolver to be used during processing.
Throws:
XMLException - Signals a problem in processing the XML schema. Called from IncludeUnmarshaller.
See Also:
IncludeUnmarshaller}

SchemaUnmarshaller

public SchemaUnmarshaller(SchemaContext schemaContext,
                          AttributeSet atts)
                   throws XMLException
Creates a SchemaUnmarshaller instance. Exists for backward compatibility

Parameters:
schemaContext - A SchemaContext to be used during schema unmarshalling.
atts - Attribute set to be processed.
Throws:
XMLException - Signals a problem in processing the XML schema.
Method Detail

getSchema

public Schema getSchema()
Returns the Schema instance representing the XML schema (file) just processed.

Returns:
the Schema instance obtained from processing an XML schema file.

setSchema

public void setSchema(Schema schema)
Sets the Schema instance to be processed.

Parameters:
schema - Schema instancetp be processed.

getObject

public java.lang.Object getObject()
Returns the Object created by this ComponentReader.

Specified by:
getObject in class ComponentReader
Returns:
the Object created by this ComponentReader

elementName

public java.lang.String elementName()
Returns the name of the element that this ComponentReader handles.

Specified by:
elementName in class ComponentReader
Returns:
the name of the element that this ComponentReader handles

startElement

public void startElement(java.lang.String name,
                         java.lang.String namespace,
                         AttributeSet atts,
                         Namespaces nsDecls)
                  throws XMLException
Signals the start of an element with the given name.

Overrides:
startElement in class ComponentReader
Parameters:
name - the NCName of the element. It is an error if the name is a QName (ie. contains a prefix).
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.
atts - the AttributeSet containing the attributes associated with the element.
nsDecls - the namespace declarations being declared for this element. This may be null.
Throws:
XMLException - To indicate a problem in processing the current element.

endElement

public void endElement(java.lang.String name,
                       java.lang.String namespace)
                throws XMLException
Signals to end of the element with the given name.

Overrides:
endElement in class ComponentReader
Parameters:
name - the NCName of the element. It is an error if the name is a QName (ie. contains a prefix).
namespace - the namespace of the element.
Throws:
XMLException - To indicate that the current element cannnot be processed successfully.

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws XMLException
Signals to recieve charactes

Overrides:
characters in class ComponentReader
Parameters:
ch - the character array containing the characters
start - the starting index into the character array
length - the number of characters to recieve
Throws:
XMLException
See Also:
ComponentReader.characters(char[], int, int)


Intalio Inc. (C) 1999-2008. All rights reserved http://www.intalio.com