org.apache.ws.commons.schema

Class XmlSchema

java.lang.Object

org.apache.ws.commons.schema.XmlSchemaObject

org.apache.ws.commons.schema.XmlSchemaAnnotated

org.apache.ws.commons.schema.XmlSchema

All Implemented Interfaces:

NamespaceContextOwner, XmlSchemaObjectBase

public class XmlSchema
extends XmlSchemaAnnotated
implements NamespaceContextOwner

Contains the definition of a schema. All XML Schema definition language (XSD) elements are children of the schema element.

Field Summary

Fields

Modifier and Type	Field and Description
private XmlSchemaForm	attributeFormDefault
private java.util.Map<javax.xml.namespace.QName,XmlSchemaAttributeGroup>	attributeGroups
private java.util.Map<javax.xml.namespace.QName,XmlSchemaAttribute>	attributes
private XmlSchemaDerivationMethod	blockDefault
private XmlSchemaForm	elementFormDefault
private java.util.Map<javax.xml.namespace.QName,XmlSchemaElement>	elements
private java.util.List<XmlSchemaExternal>	externals
private XmlSchemaDerivationMethod	finalDefault
private java.util.Map<javax.xml.namespace.QName,XmlSchemaGroup>	groups
private java.lang.String	inputEncoding
private java.util.List<XmlSchemaObject>	items
private java.lang.String	logicalTargetNamespace
private NamespacePrefixList	namespaceContext
private java.util.Map<javax.xml.namespace.QName,XmlSchemaNotation>	notations
private XmlSchemaCollection	parent
(package private) static java.lang.String	SCHEMA_NS
private java.lang.String	schemaNamespacePrefix
private java.util.Map<javax.xml.namespace.QName,XmlSchemaType>	schemaTypes
private java.lang.String	syntacticalTargetNamespace
private static java.lang.String	UTF_8_ENCODING
private java.lang.String	version

Fields inherited from class org.apache.ws.commons.schema.XmlSchemaObject

lineNumber, linePosition, sourceURI

Constructor Summary

Constructors

Constructor and Description
XmlSchema() Create a schema that is not a member of a collection and has no target namespace or system ID.
XmlSchema(java.lang.String namespace, java.lang.String systemId, XmlSchemaCollection parent) Create a new schema with a target namespace and system ID, and record it as a member of a schema collection.
XmlSchema(java.lang.String namespace, XmlSchemaCollection parent) Create a new schema in a collection with a target namespace.

Method Summary

Modifier and Type	Method and Description
org.w3c.dom.Document[]	getAllSchemas() Return an array of DOM documents consisting of this schema and any schemas that it references.
XmlSchemaAttribute	getAttributeByName(javax.xml.namespace.QName name) Retrieve a global attribute by its QName.
protected XmlSchemaAttribute	getAttributeByName(javax.xml.namespace.QName name, boolean deep, java.util.Stack<XmlSchema> schemaStack)
XmlSchemaAttribute	getAttributeByName(java.lang.String name) Look for an attribute by its local name.
XmlSchemaForm	getAttributeFormDefault()
XmlSchemaAttributeGroup	getAttributeGroupByName(javax.xml.namespace.QName name) Retrieve an attribute group by QName.
protected XmlSchemaAttributeGroup	getAttributeGroupByName(javax.xml.namespace.QName name, boolean deep, java.util.Stack<XmlSchema> schemaStack)
java.util.Map<javax.xml.namespace.QName,XmlSchemaAttributeGroup>	getAttributeGroups() Return a map containing all the defined attribute groups of this schema.
java.util.Map<javax.xml.namespace.QName,XmlSchemaAttribute>	getAttributes() Return a map containing all the defined attributes of this schema.
XmlSchemaDerivationMethod	getBlockDefault() Return the default block value for this schema.
XmlSchemaElement	getElementByName(javax.xml.namespace.QName name) Look for a element by its QName.
protected XmlSchemaElement	getElementByName(javax.xml.namespace.QName name, boolean deep, java.util.Stack<XmlSchema> schemaStack)
XmlSchemaElement	getElementByName(java.lang.String name) get an element by its local name.
XmlSchemaForm	getElementFormDefault()
java.util.Map<javax.xml.namespace.QName,XmlSchemaElement>	getElements() Return a map containing all the defined elements of this schema.
java.util.List<XmlSchemaExternal>	getExternals() Return all of the includes, imports, and redefines for this schema.
XmlSchemaDerivationMethod	getFinalDefault()
XmlSchemaGroup	getGroupByName(javax.xml.namespace.QName name) Retrieve a group by QName.
protected XmlSchemaGroup	getGroupByName(javax.xml.namespace.QName name, boolean deep, java.util.Stack<XmlSchema> schemaStack)
java.util.Map<javax.xml.namespace.QName,XmlSchemaGroup>	getGroups() Return a map containing all the defined groups of this schema.
java.lang.String	getInputEncoding() Return the character encoding for this schema.
java.util.List<XmlSchemaObject>	getItems() Return all of the global items in this schema. If org.apache.ws.commons.schema.protectReadOnlyCollections is 'true', this will return a map that checks at runtime.
java.lang.String	getLogicalTargetNamespace() Return the logical target namespace.
NamespacePrefixList	getNamespaceContext() Returns the objects namespace context.
XmlSchemaNotation	getNotationByName(javax.xml.namespace.QName name) Retrieve a notation by QName.
protected XmlSchemaNotation	getNotationByName(javax.xml.namespace.QName name, boolean deep, java.util.Stack<XmlSchema> schemaStack)
java.util.Map<javax.xml.namespace.QName,XmlSchemaNotation>	getNotations() Return a map containing all the defined notations of this schema.
XmlSchemaCollection	getParent() Return the parent XmlSchemaCollection.
private XmlSchema	getSchema(java.lang.Object includeOrImport) Get a schema from an import
org.w3c.dom.Document	getSchemaDocument() Retrieve a DOM tree for this one schema, independent of any included or related schemas.
java.lang.String	getSchemaNamespacePrefix()
java.util.Map<javax.xml.namespace.QName,XmlSchemaType>	getSchemaTypes() Return a map containing all the defined types of this schema.
(package private) java.lang.String	getSyntacticalTargetNamespace()
java.lang.String	getTargetNamespace() Return the declared target namespace of this schema.
XmlSchemaType	getTypeByName(javax.xml.namespace.QName name) Search this schema, and its peers in its parent collection, for a schema type specified by QName.
protected XmlSchemaType	getTypeByName(javax.xml.namespace.QName name, boolean deep, java.util.Stack<XmlSchema> schemaStack) Protected method that allows safe (non-recursive schema loading).
XmlSchemaType	getTypeByName(java.lang.String name) Retrieve a named type from this schema.
java.lang.String	getVersion() Return the declared XML Schema version of this schema.
private void	loadDefaultOptions(java.util.Map<java.lang.String,java.lang.String> options) Load the default options
private void	serializeInternal(java.io.Writer out, java.util.Map<java.lang.String,java.lang.String> options) serialize the schema - this is the method tht does to work
void	setAttributeFormDefault(XmlSchemaForm value) Set the default attribute form for this schema.
void	setBlockDefault(XmlSchemaDerivationMethod blockDefault) Set the default block value for this schema.
void	setElementFormDefault(XmlSchemaForm elementFormDefault) Set the default element form for this schema.
void	setFinalDefault(XmlSchemaDerivationMethod finalDefault) Set the default 'final' value for this schema.
void	setInputEncoding(java.lang.String encoding) Set the character encoding name for the schema.
(package private) void	setLogicalTargetNamespace(java.lang.String logicalTargetNamespace)
void	setNamespaceContext(NamespacePrefixList namespaceContext) Sets the schema elements namespace context.
(package private) void	setParent(XmlSchemaCollection parent)
void	setSchemaNamespacePrefix(java.lang.String schemaNamespacePrefix) Set the namespace prefix corresponding to the target namespace.
(package private) void	setSyntacticalTargetNamespace(java.lang.String syntacticalTargetNamespace)
void	setTargetNamespace(java.lang.String targetNamespace) Set the target namespace for this schema.
(package private) void	setVersion(java.lang.String version)
java.lang.String	toString()
void	write(java.io.OutputStream out) Serialize the schema as XML to the specified stream using the encoding established with setInputEncoding(String).
void	write(java.io.OutputStream out, java.util.Map<java.lang.String,java.lang.String> options) Serialize the schema as XML to the specified stream using the encoding established with setInputEncoding(String).
void	write(java.io.Writer writer) Serialize the schema to a Writer.
void	write(java.io.Writer writer, java.util.Map<java.lang.String,java.lang.String> options) Serialize the schema to a Writer.

Methods inherited from class org.apache.ws.commons.schema.XmlSchemaAnnotated

getAnnotation, getId, getUnhandledAttributes, setAnnotation, setId, setUnhandledAttributes

Methods inherited from class org.apache.ws.commons.schema.XmlSchemaObject

addMetaInfo, equals, getLineNumber, getLinePosition, getMetaInfoMap, getSourceURI, hashCode, setLineNumber, setLinePosition, setMetaInfoMap, setSourceURI

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SCHEMA_NS

static final java.lang.String SCHEMA_NS

See Also:

Constant Field Values

UTF_8_ENCODING

private static final java.lang.String UTF_8_ENCODING

See Also:

Constant Field Values

items

private java.util.List<XmlSchemaObject> items

parent

private XmlSchemaCollection parent

blockDefault

private XmlSchemaDerivationMethod blockDefault

finalDefault

private XmlSchemaDerivationMethod finalDefault

elementFormDefault

private XmlSchemaForm elementFormDefault

attributeFormDefault

private XmlSchemaForm attributeFormDefault

externals

private java.util.List<XmlSchemaExternal> externals

attributeGroups

private java.util.Map<javax.xml.namespace.QName,XmlSchemaAttributeGroup> attributeGroups

attributes

private java.util.Map<javax.xml.namespace.QName,XmlSchemaAttribute> attributes

elements

private java.util.Map<javax.xml.namespace.QName,XmlSchemaElement> elements

groups

private java.util.Map<javax.xml.namespace.QName,XmlSchemaGroup> groups

notations

private java.util.Map<javax.xml.namespace.QName,XmlSchemaNotation> notations

schemaTypes

private java.util.Map<javax.xml.namespace.QName,XmlSchemaType> schemaTypes

syntacticalTargetNamespace

private java.lang.String syntacticalTargetNamespace

schemaNamespacePrefix

private java.lang.String schemaNamespacePrefix

logicalTargetNamespace

private java.lang.String logicalTargetNamespace

version

private java.lang.String version

namespaceContext

private NamespacePrefixList namespaceContext

inputEncoding

private java.lang.String inputEncoding

Constructor Detail

XmlSchema

public XmlSchema()

Create a schema that is not a member of a collection and has no target namespace or system ID.

XmlSchema

public XmlSchema(java.lang.String namespace,
                 java.lang.String systemId,
                 XmlSchemaCollection parent)

Create a new schema with a target namespace and system ID, and record it as a member of a schema collection.

Parameters:

namespace - the target namespace.

systemId - the system ID for the schema. This is used to resolve references to other schemas.

parent - the parent collection.

XmlSchema

public XmlSchema(java.lang.String namespace,
                 XmlSchemaCollection parent)

Create a new schema in a collection with a target namespace.

Parameters:

namespace - the target namespace.

parent - the containing collection.

Method Detail

getAllSchemas

public org.w3c.dom.Document[] getAllSchemas()

Return an array of DOM documents consisting of this schema and any schemas that it references. Referenced schemas are only returned if the XmlSchemaExternal objects corresponding to them have their 'schema' fields filled in.

Returns:

DOM documents.

getAttributeByName

public XmlSchemaAttribute getAttributeByName(javax.xml.namespace.QName name)

Retrieve a global attribute by its QName.

Parameters:

name -

Returns:

the attribute.

getAttributeByName

public XmlSchemaAttribute getAttributeByName(java.lang.String name)

Look for an attribute by its local name.

Parameters:

name -

Returns:

the attribute

getAttributeFormDefault

public XmlSchemaForm getAttributeFormDefault()

Returns:

the default attribute form for this schema.

getAttributeGroupByName

public XmlSchemaAttributeGroup getAttributeGroupByName(javax.xml.namespace.QName name)

Retrieve an attribute group by QName.

Parameters:

name -

Returns:

getAttributeGroups

public java.util.Map<javax.xml.namespace.QName,XmlSchemaAttributeGroup> getAttributeGroups()

Return a map containing all the defined attribute groups of this schema. The keys are QNames, where the namespace will always be the target namespace of this schema. This makes it easier to look up items for cross-schema references.
If org.apache.ws.commons.schema.protectReadOnlyCollections is 'true', this will return a map that checks at runtime.

Returns:

the map of attribute groups.

getAttributes

public java.util.Map<javax.xml.namespace.QName,XmlSchemaAttribute> getAttributes()

Return a map containing all the defined attributes of this schema. The keys are QNames, where the namespace will always be the target namespace of this schema. This makes it easier to look up items for cross-schema references.
If org.apache.ws.commons.schema.protectReadOnlyCollections is 'true', this will return a map that checks at runtime.

Returns:

the map of attributes.

getBlockDefault

public XmlSchemaDerivationMethod getBlockDefault()

Return the default block value for this schema.

Returns:

the default block value.

getElementByName

public XmlSchemaElement getElementByName(javax.xml.namespace.QName name)

Look for a element by its QName.

Parameters:

name -

Returns:

the element.

getElementByName

public XmlSchemaElement getElementByName(java.lang.String name)

get an element by its local name.

Parameters:

name -

Returns:

the element.

getElementFormDefault

public XmlSchemaForm getElementFormDefault()

Returns:

the default element form for this schema.

getElements

public java.util.Map<javax.xml.namespace.QName,XmlSchemaElement> getElements()

Return a map containing all the defined elements of this schema. The keys are QNames, where the namespace will always be the target namespace of this schema. This makes it easier to look up items for cross-schema references.
If org.apache.ws.commons.schema.protectReadOnlyCollections is 'true', this will return a map that checks at runtime

Returns:

the map of elements.

getExternals

public java.util.List<XmlSchemaExternal> getExternals()

Return all of the includes, imports, and redefines for this schema.
If org.apache.ws.commons.schema.protectReadOnlyCollections is 'true', this will return a list that checks at runtime

Returns:

a list of the objects representing includes, imports, and redefines.

getFinalDefault

public XmlSchemaDerivationMethod getFinalDefault()

Returns:

the default 'final' value for this schema.

getGroupByName

public XmlSchemaGroup getGroupByName(javax.xml.namespace.QName name)

Retrieve a group by QName.

Parameters:

name -

Returns:

getGroups

public java.util.Map<javax.xml.namespace.QName,XmlSchemaGroup> getGroups()

Return a map containing all the defined groups of this schema. The keys are QNames, where the namespace will always be the target namespace of this schema. This makes it easier to look up items for cross-schema references.
If org.apache.ws.commons.schema.protectReadOnlyCollections is 'true', this will return a map that checks at runtime

Returns:

the map of groups.

getInputEncoding

public java.lang.String getInputEncoding()

Return the character encoding for this schema. This will only be present if either the schema was read from an XML document or there was a call to setInputEncoding(String).

Returns:

getItems

public java.util.List<XmlSchemaObject> getItems()

Return all of the global items in this schema.
If org.apache.ws.commons.schema.protectReadOnlyCollections is 'true', this will return a map that checks at runtime.

Returns:

all of the global items from this schema.

getLogicalTargetNamespace

public java.lang.String getLogicalTargetNamespace()

Return the logical target namespace. If a schema document has no target namespace, but it is referenced via an xs:include or xs:redefine, its logical target namespace is the target namespace of the including schema.

Returns:

the logical target namespace.

getNamespaceContext

public NamespacePrefixList getNamespaceContext()

Returns the objects namespace context.

Specified by:

getNamespaceContext in interface NamespaceContextOwner

getNotationByName

public XmlSchemaNotation getNotationByName(javax.xml.namespace.QName name)

Retrieve a notation by QName.

Parameters:

name -

Returns:

the notation

getNotations

public java.util.Map<javax.xml.namespace.QName,XmlSchemaNotation> getNotations()

Return a map containing all the defined notations of this schema. The keys are QNames, where the namespace will always be the target namespace of this schema. This makes it easier to look up items for cross-schema references.
If org.apache.ws.commons.schema.protectReadOnlyCollections is 'true', this will return a map that checks at runtime.

Returns:

the map of notations.

getParent

public XmlSchemaCollection getParent()

Return the parent XmlSchemaCollection. If this schema was not initialized in a collection the return value will be null.

Returns:

the parent collection.

getSchemaDocument

public org.w3c.dom.Document getSchemaDocument()
                                       throws XmlSchemaSerializer.XmlSchemaSerializerException

Retrieve a DOM tree for this one schema, independent of any included or related schemas.

Returns:

The DOM document.

Throws:

XmlSchemaSerializer.XmlSchemaSerializerException

getSchemaNamespacePrefix

public java.lang.String getSchemaNamespacePrefix()

Returns:

the namespace prefix for the target namespace.

getSchemaTypes

public java.util.Map<javax.xml.namespace.QName,XmlSchemaType> getSchemaTypes()

Return a map containing all the defined types of this schema. The keys are QNames, where the namespace will always be the target namespace of this schema. This makes it easier to look up items for cross-schema references.

Returns:

the map of types.

getTargetNamespace

public java.lang.String getTargetNamespace()

Return the declared target namespace of this schema.

Returns:

the namespace URI.

See Also:

getLogicalTargetNamespace()

getTypeByName

public XmlSchemaType getTypeByName(javax.xml.namespace.QName name)

Search this schema, and its peers in its parent collection, for a schema type specified by QName.

Parameters:

name - the type name.

Returns:

the type.

getTypeByName

public XmlSchemaType getTypeByName(java.lang.String name)

Retrieve a named type from this schema.

Parameters:

name -

Returns:

the type.

getVersion

public java.lang.String getVersion()

Return the declared XML Schema version of this schema. XmlSchema supports only version 1.0.

Returns:

setAttributeFormDefault

public void setAttributeFormDefault(XmlSchemaForm value)

Set the default attribute form for this schema.

Parameters:

value - the form. This may not be null.

setBlockDefault

public void setBlockDefault(XmlSchemaDerivationMethod blockDefault)

Set the default block value for this schema.

Parameters:

blockDefault - the new block value.

setElementFormDefault

public void setElementFormDefault(XmlSchemaForm elementFormDefault)

Set the default element form for this schema.

Parameters:

elementFormDefault - the element form. This may not be null.

setFinalDefault

public void setFinalDefault(XmlSchemaDerivationMethod finalDefault)

Set the default 'final' value for this schema. The value may not be null.

Parameters:

finalDefault - the new final value.

setInputEncoding

public void setInputEncoding(java.lang.String encoding)

Set the character encoding name for the schema. This is typically set when reading a schema from an XML file, so that it can be written back out in the same encoding.

Parameters:

encoding - Character encoding name.

setNamespaceContext

public void setNamespaceContext(NamespacePrefixList namespaceContext)

Sets the schema elements namespace context. This may be used for schema serialization, until a better mechanism was found.

setSchemaNamespacePrefix

public void setSchemaNamespacePrefix(java.lang.String schemaNamespacePrefix)

Set the namespace prefix corresponding to the target namespace.

Parameters:

schemaNamespacePrefix -

setTargetNamespace

public void setTargetNamespace(java.lang.String targetNamespace)

Set the target namespace for this schema.

Parameters:

targetNamespace - the new target namespace URI. A value of "" is ignored.

toString

public java.lang.String toString()

Overrides:

toString in class XmlSchemaAnnotated

write

public void write(java.io.OutputStream out)
           throws java.io.UnsupportedEncodingException

Serialize the schema as XML to the specified stream using the encoding established with setInputEncoding(String).

Parameters:

out - - the output stream to write to

Throws:

java.io.UnsupportedEncodingException - for an invalid encoding.

write

public void write(java.io.OutputStream out,
                  java.util.Map<java.lang.String,java.lang.String> options)
           throws java.io.UnsupportedEncodingException

Serialize the schema as XML to the specified stream using the encoding established with setInputEncoding(String).

Parameters:

out - - the output stream to write to

options - - a map of options

Throws:

java.io.UnsupportedEncodingException

write

public void write(java.io.Writer writer)

Serialize the schema to a Writer.

Parameters:

writer - - the writer to write this

write

public void write(java.io.Writer writer,
                  java.util.Map<java.lang.String,java.lang.String> options)

Serialize the schema to a Writer.

Parameters:

writer - - the writer to write this

getAttributeByName

protected XmlSchemaAttribute getAttributeByName(javax.xml.namespace.QName name,
                                                boolean deep,
                                                java.util.Stack<XmlSchema> schemaStack)

getAttributeGroupByName

protected XmlSchemaAttributeGroup getAttributeGroupByName(javax.xml.namespace.QName name,
                                                          boolean deep,
                                                          java.util.Stack<XmlSchema> schemaStack)

getElementByName

protected XmlSchemaElement getElementByName(javax.xml.namespace.QName name,
                                            boolean deep,
                                            java.util.Stack<XmlSchema> schemaStack)

getGroupByName

protected XmlSchemaGroup getGroupByName(javax.xml.namespace.QName name,
                                        boolean deep,
                                        java.util.Stack<XmlSchema> schemaStack)

getNotationByName

protected XmlSchemaNotation getNotationByName(javax.xml.namespace.QName name,
                                              boolean deep,
                                              java.util.Stack<XmlSchema> schemaStack)

getTypeByName

protected XmlSchemaType getTypeByName(javax.xml.namespace.QName name,
                                      boolean deep,
                                      java.util.Stack<XmlSchema> schemaStack)

Protected method that allows safe (non-recursive schema loading). It looks for a type with constraints.

Parameters:

name -

deep -

schemaStack -

Returns:

the type.

getSyntacticalTargetNamespace

java.lang.String getSyntacticalTargetNamespace()

setLogicalTargetNamespace

void setLogicalTargetNamespace(java.lang.String logicalTargetNamespace)

setParent

void setParent(XmlSchemaCollection parent)

setSyntacticalTargetNamespace

void setSyntacticalTargetNamespace(java.lang.String syntacticalTargetNamespace)

setVersion

void setVersion(java.lang.String version)

getSchema

private XmlSchema getSchema(java.lang.Object includeOrImport)

Get a schema from an import

Parameters:

includeOrImport -

Returns:

return the schema object.

loadDefaultOptions

private void loadDefaultOptions(java.util.Map<java.lang.String,java.lang.String> options)

Load the default options

Parameters:

options - - the map of

serializeInternal

private void serializeInternal(java.io.Writer out,
                               java.util.Map<java.lang.String,java.lang.String> options)

serialize the schema - this is the method tht does to work

Parameters:

out -

options -