Inheritance diagram for org.exolab.castor.xml.schema.Schema:

Public Member Functions
	Schema ()
	Schema (String schemaNS)
	Schema (String prefix, String schemaNS)
void	addAttribute (AttributeDecl attribute) throws SchemaException
void	addAttributeGroup (AttributeGroupDecl attrGroup) throws SchemaException
synchronized void	addComplexType (ComplexType complexType) throws SchemaException
void	addElementDecl (ElementDecl elementDecl) throws SchemaException
void	addModelGroup (ModelGroup group) throws SchemaException
void	addRedefineSchema (RedefineSchema schema) throws SchemaException
synchronized void	addImportedSchema (Schema schema) throws SchemaException
synchronized void	cacheIncludedSchema (Schema schema) throws SchemaException
void	addNamespace (String prefix, String ns)
synchronized void	addSimpleType (SimpleType simpleType) throws SchemaException
ComplexType	createComplexType ()
ComplexType	createComplexType (String name)
SimpleType	createSimpleType (String name, String baseName, String derivation)
SimpleType	createSimpleType (String name, SimpleType baseType)
Form	getAttributeFormDefault ()
Enumeration	getAttributes ()
AttributeDecl	getAttribute (String name)
Enumeration	getAttributeGroups ()
AttributeGroup	getAttributeGroup (String name)
BlockList	getBlockDefault ()
String	getBuiltInTypeName (int builtInTypeCode)
ComplexType	getComplexType (String name)
Enumeration	getComplexTypes ()
ElementDecl	getElementDecl (String name)
Enumeration	getElementDecls ()
Form	getElementFormDefault ()
FinalList	getFinalDefault ()
SimpleType	getSimpleType (String name)
SimpleType	getSimpleType (String name, String namespace)
Enumeration	getSimpleTypes ()
String	getSchemaLocation ()
ModelGroup	getModelGroup (String name)
Enumeration	getModelGroups ()
String	getId ()
Enumeration	getImportedSchema ()
Schema	getImportedSchema (String ns)
Enumeration	getRedefineSchema ()
RedefineSchema	getRedefineSchema (String schemaLocation)
Schema	getCachedIncludedSchema (String schemaLocation)
Enumeration	getCachedIncludedSchemas ()
Schema	getImportedSchema (String ns, boolean localOnly)
final String	getNamespace (String prefix)
Namespaces	getNamespaces ()
void	addInclude (String include)
boolean	includeProcessed (String includeFile)
String	getSchemaNamespace ()
String	getTargetNamespace ()
String	getVersion ()
boolean	isKnownNamespace (String namespaceURL)
boolean	removeComplexType (ComplexType complexType)
boolean	removeElement (ElementDecl element)
boolean	removeAttribute (AttributeDecl attribute)
boolean	removeGroup (ModelGroup group)
boolean	removeAttributeGroup (AttributeGroupDecl group)
synchronized boolean	removeCachedIncludedSchema (Schema schema)
synchronized boolean	removeImportedSchema (Schema schema)
boolean	removeNamespace (String prefix)
synchronized boolean	removeRedefineSchema (RedefineSchema schema)
boolean	removeSimpleType (SimpleType simpleType)
void	setAttributeFormDefault (Form attributeFormDefault)
void	setBlockDefault (BlockList block)
void	setBlockDefault (String block)
void	setElementFormDefault (Form elementFormDefault)
void	setFinalDefault (FinalList finalList)
void	setFinalDefault (String finalValues)
void	setSchemaLocation (String schemaLocation)
XMLType	getType (String typeName)
void	setId (String id)
void	setTargetNamespace (String targetNamespace)
void	setVersion (String version)
short	getStructureType ()
void	validate () throws ValidationException
Static Public Attributes
static final String	DEFAULT_SCHEMA_NS = "http://www.w3.org/2001/XMLSchema"
static final String	XSI_NAMESPACE = "http://www.w3.org/2001/XMLSchema-instance"
Protected Member Functions
String	getNamespacePrefix (String namespace)
Schema	getMasterSchema ()
void	setMasterSchema (Schema masterSchema)
Static Package Functions
static SimpleTypesFactory	getTypeFactory ()

Detailed Description

A class representing an XML Schema Definition. This class also contains some Factory methods for creating Top-Level structures.

Author:: Keith Visco

Version:

Revision:: 1.10

Date:: 2004/10/01 13:25:21

Constructor & Destructor Documentation

org.exolab.castor.xml.schema.Schema.Schema ( )

Creates a new Schema definition

References org.exolab.castor.xml.schema.Schema.DEFAULT_SCHEMA_NS.

org.exolab.castor.xml.schema.Schema.Schema ( String schemaNS )

Creates a new Schema definition

Parameters:

schemaNS

the namespace of the XML Schema itself. Note this is not the same as the targetNamespace.

org.exolab.castor.xml.schema.Schema.Schema	(	String	prefix,
		String	schemaNS
	)

Creates a new Schema definition

Parameters:

	prefix	the desired namespace prefix for the schemaNS.
	schemaNS	the namespace of the XML Schema itself. Note this is not the same as the targetNamespace.

References org.exolab.castor.xml.schema.Schema.addNamespace(), and org.exolab.castor.xml.schema.Schema.DEFAULT_SCHEMA_NS.

Member Function Documentation

void org.exolab.castor.xml.schema.Schema.addAttribute ( AttributeDecl attribute ) throws SchemaException

Adds the given attribute definition to this Schema definition

Parameters:

attribute

the AttributeDecl to add

Exceptions:

SchemaException

if an AttributeDecl already exisits with the same name

References org.exolab.castor.xml.schema.Schema.getAttribute().

Referenced by org.exolab.castor.xml.schema.reader.SchemaUnmarshaller.endElement().

void org.exolab.castor.xml.schema.Schema.addAttributeGroup ( AttributeGroupDecl attrGroup ) throws SchemaException

Adds the given attribute group definition to this Schema definition.

Parameters:

attrGroup

the AttributeGroupDecl to add

Exceptions:

SchemaException

if an AttributeGroupDecl already exisits with the same name

References org.exolab.castor.xml.schema.Schema.getAttributeGroup(), and org.exolab.castor.xml.Namespaces.getNamespaceURI().

Referenced by org.exolab.castor.xml.schema.reader.SchemaUnmarshaller.endElement().

synchronized void org.exolab.castor.xml.schema.Schema.addComplexType ( ComplexType complexType ) throws SchemaException

Adds the given Complextype definition to this Schema defintion

Parameters:

complextype

the Complextype to add to this Schema

Exceptions:

SchemaException

if the Complextype does not have a name or if another Complextype already exists with the same name

References org.exolab.castor.xml.schema.Schema.getComplexType(), and org.exolab.castor.xml.schema.ComplexType.isRedefined().

Referenced by org.exolab.castor.xml.schema.reader.SchemaUnmarshaller.endElement(), and org.exolab.castor.xml.schema.XMLType.setName().

void org.exolab.castor.xml.schema.Schema.addElementDecl ( ElementDecl elementDecl ) throws SchemaException

Adds the given Element declaration to this Schema defintion

Parameters:

elementDecl

the ElementDecl to add to this SchemaDef

Exceptions:

SchemaException

when an ElementDecl already exists with the same name as the given ElementDecl

References org.exolab.castor.xml.schema.Schema.getElementDecl().

Referenced by org.exolab.castor.xml.dtd.Converter.convertDTDObjectToSchemaObject(), org.exolab.castor.xml.schema.util.XMLInstance2SchemaHandler.endElement(), and org.exolab.castor.xml.schema.reader.SchemaUnmarshaller.endElement().

synchronized void org.exolab.castor.xml.schema.Schema.addImportedSchema ( Schema schema ) throws SchemaException

Adds the given Schema definition to this Schema definition as an imported schenma

Parameters:

schema

the Schema to add to this Schema as an imported schema

Exceptions:

SchemaException

if the Schema already exists

Referenced by org.exolab.castor.xml.schema.reader.ImportUnmarshaller.ImportUnmarshaller().

void org.exolab.castor.xml.schema.Schema.addInclude ( String include )

Indicates that the given XML Schema file has been processed via an <xs:include>

Referenced by org.exolab.castor.xml.schema.reader.IncludeUnmarshaller.IncludeUnmarshaller().

void org.exolab.castor.xml.schema.Schema.addModelGroup ( ModelGroup group ) throws SchemaException

Adds the given Group declaration to this Schema definition

Parameters:

group

the Group to add to this SchemaDef

Exceptions:

SchemaException

when an Group already exists with the same name as the given Group

References org.exolab.castor.xml.schema.Schema.getModelGroup(), and org.exolab.castor.xml.schema.ModelGroup.isRedefined().

Referenced by org.exolab.castor.xml.schema.reader.SchemaUnmarshaller.endElement().

void org.exolab.castor.xml.schema.Schema.addNamespace	(	String	prefix,
		String	ns
	)

Adds to the namespaces declared in this Schema

Parameters:

namespaces

the list of namespaces

References org.exolab.castor.xml.Namespaces.addNamespace().

Referenced by org.exolab.castor.xml.schema.Schema.Schema(), and org.exolab.castor.xml.schema.util.XMLInstance2SchemaHandler.XMLInstance2SchemaHandler().

void org.exolab.castor.xml.schema.Schema.addRedefineSchema ( RedefineSchema schema ) throws SchemaException

Adds the given redefinition of structures to this Schema definition. This structure is mainly used to allow the writing of an XML schema that contains redefinitions. The validation process is permissive since the method won't check that the XML Schema is already imported nor will it check that the redefined structures exist.

Parameters:

redefineSchema

the Group to add to this SchemaDef

Exceptions:

SchemaException

when an redefintion already exists with the same name as the given ElementDecl

Referenced by org.exolab.castor.xml.schema.reader.RedefineUnmarshaller.RedefineUnmarshaller().

synchronized void org.exolab.castor.xml.schema.Schema.addSimpleType ( SimpleType simpleType ) throws SchemaException

Adds the given SimpletType definition to this Schema defintion

Parameters:

simpletype

the SimpleType to add to this Schema

Exceptions:

SchemaException

if the SimpleType does not have a name or if another SimpleType already exists with the same name

References org.exolab.castor.xml.schema.Schema.getSimpleType(), and org.exolab.castor.xml.schema.SimpleType.isRedefined().

Referenced by org.exolab.castor.xml.schema.reader.SchemaUnmarshaller.endElement(), and org.exolab.castor.xml.schema.XMLType.setName().

synchronized void org.exolab.castor.xml.schema.Schema.cacheIncludedSchema ( Schema schema ) throws SchemaException

Caches the given Schema definition as an included XML Schema of this Schema definition.

Parameters:

schema

the Schema to add to this Schema as a cached included schema.

Exceptions:

SchemaException

if the Schema already exists

Referenced by org.exolab.castor.xml.schema.reader.IncludeUnmarshaller.IncludeUnmarshaller().

ComplexType org.exolab.castor.xml.schema.Schema.createComplexType ( )

Creates a new ComplexType using this Schema as the owning Schema document. A call to addComplexType must still be made in order to add the complexType to this Schema.

Returns:: the new ComplexType

Referenced by org.exolab.castor.xml.schema.reader.ComplexTypeUnmarshaller.ComplexTypeUnmarshaller().

ComplexType org.exolab.castor.xml.schema.Schema.createComplexType ( String name )

Creates a new ComplexType using this Schema as the owning Schema document. A call to addComplexType must still be made in order to add the complexType to this Schema.

Parameters:

name

the name of the ComplexType

Returns:: the new ComplexType

SimpleType org.exolab.castor.xml.schema.Schema.createSimpleType	(	String	name,
		String	baseName,
		String	derivation
	)

Creates a new SimpleType using this Schema as the owning Schema document. A call to addSimpleType must till be made in order to add the SimpleType to this Schema.

Parameters:

	name	the name of the SimpleType
	baseName	the name of the SimpleType's base type
	derivation	the name of the derivation method (""/"list"/"restriction")

Returns:: the new SimpleType.

References org.exolab.castor.xml.schema.SimpleTypesFactory.createUserSimpleType().

Referenced by org.exolab.castor.xml.schema.reader.SimpleTypeDefinition.createSimpleType().

SimpleType org.exolab.castor.xml.schema.Schema.createSimpleType	(	String	name,
		SimpleType	baseType
	)

Creates a new SimpleType using this Schema as the owning Schema document. A call to addSimpleType must till be made in order to add the SimpleType to this Schema if the type is to be global.

Parameters:

	name	the name of the SimpleType
	baseType	the base type of the SimpleType to create

Returns:: the new SimpleType.

References org.exolab.castor.xml.schema.SimpleTypesFactory.createUserSimpleType().

AttributeDecl org.exolab.castor.xml.schema.Schema.getAttribute ( String name )

Returns the top-level Attribute associated with the given name.

Returns:: the Attribute associated with the given name, or null if no Attribute association is found.

References org.exolab.castor.xml.schema.Schema.getAttribute(), org.exolab.castor.xml.schema.Schema.getImportedSchema(), org.exolab.castor.xml.Namespaces.getNamespaceURI(), and org.exolab.castor.xml.schema.Schema.setMasterSchema().

Referenced by org.exolab.castor.xml.schema.Schema.addAttribute(), org.exolab.castor.xml.schema.Schema.getAttribute(), org.exolab.castor.xml.schema.AttributeDecl.getReference(), and org.exolab.castor.xml.schema.AttributeDecl.validate().

Form org.exolab.castor.xml.schema.Schema.getAttributeFormDefault ( )

Returns the attributeFormDefault property of this Schema.

Returns:: the attributeFormDefault property of this Schema, or null if no default Form was set. If no default Form has been set, the user should assume Form.Unqualified.

Referenced by org.exolab.castor.builder.binding.XMLBindingComponent.getTargetNamespace().

AttributeGroup org.exolab.castor.xml.schema.Schema.getAttributeGroup ( String name )

Returns the AttributeGroup associated with the given name.

Returns:: the AttributeGroup associated with the given name, or null if no AttributeGroup association is found.

References org.exolab.castor.xml.schema.RedefineSchema.getAttributeGroup(), org.exolab.castor.xml.schema.Schema.getAttributeGroup(), org.exolab.castor.xml.schema.Schema.getImportedSchema(), org.exolab.castor.xml.Namespaces.getNamespaceURI(), org.exolab.castor.xml.schema.RedefineSchema.getOriginalSchema(), org.exolab.castor.xml.schema.Schema.getRedefineSchema(), org.exolab.castor.xml.schema.RedefineSchema.hasAttributeGroupRedefinition(), and org.exolab.castor.xml.schema.Schema.setMasterSchema().

Referenced by org.exolab.castor.xml.schema.Schema.addAttributeGroup(), org.exolab.castor.xml.schema.reader.RedefineUnmarshaller.endElement(), org.exolab.castor.xml.schema.Schema.getAttributeGroup(), and org.exolab.castor.xml.schema.AttributeGroupReference.resolveReference().

Enumeration org.exolab.castor.xml.schema.Schema.getAttributeGroups ( )

Returns an Enumeration of all top-level AttributeGroup declarations

Returns:: an Enumeration of all top-level AttributeGroup declarations

References org.exolab.castor.xml.schema.RedefineSchema.enumerateAttributeGroups(), org.exolab.castor.xml.schema.Schema.getAttributeGroups(), org.exolab.castor.xml.schema.RedefineSchema.getOriginalSchema(), org.exolab.castor.xml.schema.RedefineSchema.hasAttributeGroupRedefinition(), and org.exolab.castor.xml.schema.Schema.setMasterSchema().

Referenced by org.exolab.castor.xml.schema.Schema.getAttributeGroups().

Enumeration org.exolab.castor.xml.schema.Schema.getAttributes ( )

Returns an Enumeration of all top-level Attribute declarations

Returns:: an Enumeration of all top-level Attribute declarations

References org.exolab.castor.xml.schema.Schema.getAttributes(), and org.exolab.castor.xml.schema.Schema.setMasterSchema().

Referenced by org.exolab.castor.xml.schema.Schema.getAttributes().

BlockList org.exolab.castor.xml.schema.Schema.getBlockDefault ( )

Returns the default BlockList for this Schema.

Returns:: the default BlockList for this Schema.

String org.exolab.castor.xml.schema.Schema.getBuiltInTypeName ( int builtInTypeCode )

Gets a built in type's name given its code.

References org.exolab.castor.xml.schema.SimpleTypesFactory.getBuiltInTypeName().

Schema org.exolab.castor.xml.schema.Schema.getCachedIncludedSchema ( String schemaLocation )

Returns the cached included schema with the given SchemaLocation

Parameters:

schemaLocation

the schemaLocation value used as a key to store the cached included XML schema

Returns:: the cached included XML schema

Enumeration org.exolab.castor.xml.schema.Schema.getCachedIncludedSchemas ( )

Returns an enumeration of all the included schemas that are cached in this XML Schema Definition.

Returns:: an enumeration of all the included schemas that are cached in this XML Schema Definition.

ComplexType org.exolab.castor.xml.schema.Schema.getComplexType ( String name )

Returns the ComplexType of associated with the given name

Returns:: the ComplexType of associated with the given name, or null if no ComplexType with the given name was found.

References org.exolab.castor.xml.schema.RedefineSchema.getComplexType(), org.exolab.castor.xml.schema.Schema.getComplexType(), org.exolab.castor.xml.schema.Schema.getImportedSchema(), org.exolab.castor.xml.Namespaces.getNamespaceURI(), org.exolab.castor.xml.schema.RedefineSchema.getOriginalSchema(), org.exolab.castor.xml.schema.Schema.getRedefineSchema(), org.exolab.castor.xml.schema.RedefineSchema.hasComplexTypeRedefinition(), and org.exolab.castor.xml.schema.Schema.setMasterSchema().

Referenced by org.exolab.castor.xml.schema.Schema.addComplexType(), org.exolab.castor.xml.schema.reader.RedefineUnmarshaller.endElement(), org.exolab.castor.xml.schema.Schema.getComplexType(), org.exolab.castor.xml.schema.Schema.getType(), and org.exolab.castor.xml.schema.TypeReference.resolveTypeReference().

Enumeration org.exolab.castor.xml.schema.Schema.getComplexTypes ( )

Returns an Enumeration of all top-level ComplexType declarations

Returns:: an Enumeration of all top-level ComplexType declarations

References org.exolab.castor.xml.schema.RedefineSchema.enumerateComplexTypes(), org.exolab.castor.xml.schema.Schema.getComplexTypes(), org.exolab.castor.xml.schema.XMLType.getName(), org.exolab.castor.xml.schema.RedefineSchema.getOriginalSchema(), org.exolab.castor.xml.schema.RedefineSchema.hasComplexTypeRedefinition(), and org.exolab.castor.xml.schema.Schema.setMasterSchema().

Referenced by com.cosylab.cdb.jdal.XSDElementTypeResolver.doesExtend(), org.exolab.castor.xml.schema.Schema.getComplexTypes(), and com.cosylab.cdb.jdal.XSDElementTypeResolver.internalGetElementTypes().

ElementDecl org.exolab.castor.xml.schema.Schema.getElementDecl ( String name )

Returns the ElementDecl of associated with the given name

Returns:: the ElementDecl of associated with the given name, or null if no ElementDecl with the given name was found.

References org.exolab.castor.xml.schema.Schema.getElementDecl(), org.exolab.castor.xml.schema.Schema.getImportedSchema(), org.exolab.castor.xml.Namespaces.getNamespaceURI(), and org.exolab.castor.xml.schema.Schema.setMasterSchema().

Referenced by org.exolab.castor.xml.schema.Schema.addElementDecl(), org.exolab.castor.xml.schema.Schema.getElementDecl(), org.exolab.castor.xml.schema.ElementDecl.getReference(), and org.exolab.castor.xml.schema.ElementDecl.validate().

Enumeration org.exolab.castor.xml.schema.Schema.getElementDecls ( )

Returns an Enumeration of all top-level element declarations

Returns:: an Enumeration of all top-level element declarations

References org.exolab.castor.xml.schema.Schema.getElementDecls(), org.exolab.castor.xml.schema.RedefineSchema.getOriginalSchema(), and org.exolab.castor.xml.schema.Schema.setMasterSchema().

Referenced by com.cosylab.cdb.jdal.XSDElementTypeResolver.doesExtend(), org.exolab.castor.xml.schema.Schema.getElementDecls(), org.exolab.castor.xml.schema.ElementDecl.getSubstitutionGroupMembers(), and com.cosylab.cdb.jdal.XSDElementTypeResolver.internalGetElementTypes().

Form org.exolab.castor.xml.schema.Schema.getElementFormDefault ( )

Returns the elementFormDefault property of this Schema.

Returns:: the elementFormDefault property of this Schema, or null if no default Form was set. If no default Form has been set, the user should assume Form.Unqualified.

Referenced by org.exolab.castor.builder.binding.XMLBindingComponent.getTargetNamespace().

FinalList org.exolab.castor.xml.schema.Schema.getFinalDefault ( )

Returns the default FinalList for this Schema.

Returns:: final the default FinalList for this Schema.

String org.exolab.castor.xml.schema.Schema.getId ( )

Returns the Id for this Schema, as specified by the Id attribute, or null if no Id exists.

Returns:: the Id for this Scheam, or null if no Id exists

Enumeration org.exolab.castor.xml.schema.Schema.getImportedSchema ( )

Returns the imported schemas of this schema

Returns:: the hashtable of the imported schemas

Referenced by org.exolab.castor.xml.schema.Schema.getAttribute(), org.exolab.castor.xml.schema.Schema.getAttributeGroup(), org.exolab.castor.xml.schema.Schema.getComplexType(), org.exolab.castor.xml.schema.Schema.getElementDecl(), org.exolab.castor.xml.schema.Schema.getImportedSchema(), org.exolab.castor.xml.schema.Schema.getModelGroup(), org.exolab.castor.xml.schema.Schema.getSimpleType(), and org.exolab.castor.xml.schema.reader.ImportUnmarshaller.ImportUnmarshaller().

Schema org.exolab.castor.xml.schema.Schema.getImportedSchema ( String ns )

Returns the imported schema with the given namespace

Parameters:

ns

the namespace of the imported schema to return

Returns:: the imported schema

References org.exolab.castor.xml.schema.Schema.getImportedSchema().

Schema org.exolab.castor.xml.schema.Schema.getImportedSchema	(	String	ns,
		boolean	localOnly
	)

Returns the imported schema with the given namespace

Parameters:

	ns	the namespace of the imported schema to return
	localOnly	a boolean that indicates only local imports should be searched.

Returns:: the imported schema

References org.exolab.castor.xml.schema.Schema.getImportedSchema().

Schema org.exolab.castor.xml.schema.Schema.getMasterSchema ( ) [protected]

Returns the master schema in which this instance of schema is used at runtime. This method is meant to be used at runtime.

Returns:: the master schema in which this instance of schema is used at runtime. This method is meant to be used at runtime.

Referenced by org.exolab.castor.xml.schema.ModelGroup.getReference(), org.exolab.castor.xml.schema.AttributeDecl.getSimpleType(), org.exolab.castor.xml.schema.ElementDecl.getType(), and org.exolab.castor.xml.schema.AttributeGroupReference.resolveReference().

ModelGroup org.exolab.castor.xml.schema.Schema.getModelGroup ( String name )

Returns the ModeGroup of associated with the given name

Returns:: the ModelGroup of associated with the given name, or null if no ModelGroup with the given name was found.

References org.exolab.castor.xml.schema.Schema.getImportedSchema(), org.exolab.castor.xml.schema.RedefineSchema.getModelGroup(), org.exolab.castor.xml.schema.Schema.getModelGroup(), org.exolab.castor.xml.Namespaces.getNamespaceURI(), org.exolab.castor.xml.schema.RedefineSchema.getOriginalSchema(), org.exolab.castor.xml.schema.Schema.getRedefineSchema(), org.exolab.castor.xml.schema.RedefineSchema.hasGroupRedefinition(), and org.exolab.castor.xml.schema.Schema.setMasterSchema().

Referenced by org.exolab.castor.xml.schema.Schema.addModelGroup(), org.exolab.castor.xml.schema.reader.RedefineUnmarshaller.endElement(), org.exolab.castor.xml.schema.Schema.getModelGroup(), and org.exolab.castor.xml.schema.ModelGroup.getReference().

Enumeration org.exolab.castor.xml.schema.Schema.getModelGroups ( )

Returns an Enumeration of all top-level ModelGroup declarations

Returns:: an Enumeration of all top-level ModelGroup declarations

References org.exolab.castor.xml.schema.RedefineSchema.enumerateGroups(), org.exolab.castor.xml.schema.Schema.getModelGroups(), org.exolab.castor.xml.schema.ModelGroup.getName(), org.exolab.castor.xml.schema.RedefineSchema.getOriginalSchema(), org.exolab.castor.xml.schema.RedefineSchema.hasGroupRedefinition(), and org.exolab.castor.xml.schema.Schema.setMasterSchema().

Referenced by org.exolab.castor.xml.schema.Schema.getModelGroups().

final String org.exolab.castor.xml.schema.Schema.getNamespace ( String prefix )

Returns the namespace associated with the given prefix.

Returns:: the namespace associated with the given prefix, or null if no associated namespace exists.

References org.exolab.castor.xml.Namespaces.getNamespaceURI().

Referenced by org.exolab.castor.xml.schema.RedefineSchema.addAttributeGroup(), org.exolab.castor.xml.schema.TypeReference.resolveTypeReference(), and org.exolab.castor.xml.schema.reader.SimpleTypeUnmarshaller.SimpleTypeUnmarshaller().

String org.exolab.castor.xml.schema.Schema.getNamespacePrefix ( String namespace ) [protected]

Returns the namespace prefix associated with the given namespace. If more than one prefix has been associated, the first one found will be returned.

Returns:: the namespace prefix associaed with the given namespace.

References org.exolab.castor.xml.Namespaces.getNamespacePrefix().

Referenced by org.exolab.castor.xml.schema.ElementDecl.setReference().

Namespaces org.exolab.castor.xml.schema.Schema.getNamespaces ( )

Returns the namespaces declared for this Schema

Returns:: the namespaces declared for this Schema

Referenced by org.exolab.castor.xml.schema.util.XMLInstance2SchemaHandler.XMLInstance2SchemaHandler().

RedefineSchema org.exolab.castor.xml.schema.Schema.getRedefineSchema ( String schemaLocation )

Returns the redefined schema corresponding schemaLocation.

Parameters:

schemaLocation

the string corresponding to the schemaLocation.

Returns:: the redefined schema corresponding schemaLocation.

Enumeration org.exolab.castor.xml.schema.Schema.getRedefineSchema ( )

Returns an enumeration of redefined schemas.

Returns:: an enumeration of redefined schemas.

String org.exolab.castor.xml.schema.Schema.getSchemaLocation ( )

Returns the schemaLocation hint provided of this schema

Returns:: the schemaLocation hint provided of this schema

Referenced by org.exolab.castor.xml.schema.reader.RedefineUnmarshaller.endElement(), org.exolab.castor.builder.SourceGenerator.generateSource(), org.exolab.castor.builder.binding.XMLBindingComponent.getSchemaLocation(), org.exolab.castor.xml.schema.reader.ImportUnmarshaller.ImportUnmarshaller(), org.exolab.castor.xml.schema.reader.IncludeUnmarshaller.IncludeUnmarshaller(), org.exolab.castor.xml.schema.RedefineSchema.RedefineSchema(), org.exolab.castor.xml.schema.reader.RedefineUnmarshaller.RedefineUnmarshaller(), and org.exolab.castor.xml.schema.Schema.removeCachedIncludedSchema().

String org.exolab.castor.xml.schema.Schema.getSchemaNamespace ( )

Returns the namespace of the XML Schema
Note: This is not the same as targetNamespace. This is the namespace of "XML Schema" itself and not the namespace of the schema that is represented by this object model (see getTargetNamespace).

Returns:: the namespace of the XML Schema

Referenced by org.exolab.castor.xml.schema.TypeReference.resolveTypeReference().

SimpleType org.exolab.castor.xml.schema.Schema.getSimpleType ( String name )

Returns the SimpleType associated with the given name, or null if no such SimpleType exists.

Parameters:

name

the name of the SimpleType. The name may be a QName (contain a namespace prefix).

Returns:: the SimpleType associated with the given name, or null if no such SimpleType exists.

References org.exolab.castor.xml.Namespaces.getNamespaceURI().

Referenced by org.exolab.castor.xml.schema.Schema.addSimpleType(), org.exolab.castor.xml.schema.SimpleTypesFactory.createUserSimpleType(), org.exolab.castor.xml.schema.reader.RedefineUnmarshaller.endElement(), org.exolab.castor.xml.schema.Schema.getSimpleType(), org.exolab.castor.xml.schema.AttributeDecl.getSimpleType(), org.exolab.castor.xml.schema.Schema.getType(), org.exolab.castor.xml.schema.TypeReference.resolveTypeReference(), and org.exolab.castor.xml.schema.SimpleTypeReference.resolveTypeReference().

SimpleType org.exolab.castor.xml.schema.Schema.getSimpleType	(	String	name,
		String	namespace
	)

Returns the SimpleType associated with the given name and namespace, or null if no such SimpleType exists.

Parameters:

	name	the name of the simpleType. It is an error if this name contains a prefix, it must be an NCName.
	namespace	the namespace URI of the simpleType.

Returns:: the SimpleType, or null if no such SimpleType exists.

Enumeration org.exolab.castor.xml.schema.Schema.getSimpleTypes ( )

Returns an Enumeration of all SimpleType declarations

Returns:: an Enumeration of all SimpleType declarations

References org.exolab.castor.xml.schema.RedefineSchema.enumerateSimpleTypes(), org.exolab.castor.xml.schema.XMLType.getName(), org.exolab.castor.xml.schema.RedefineSchema.getOriginalSchema(), org.exolab.castor.xml.schema.Schema.getSimpleTypes(), org.exolab.castor.xml.schema.XMLType.getType(), org.exolab.castor.xml.schema.RedefineSchema.hasSimpleTypeRedefinition(), org.exolab.castor.xml.schema.Schema.setMasterSchema(), and org.exolab.castor.xml.schema.SimpleType.setParent().

Referenced by org.exolab.castor.xml.schema.Schema.getSimpleTypes().

short org.exolab.castor.xml.schema.Schema.getStructureType ( ) [virtual]

Returns the type of this Schema Structure

Returns:: the type of this Schema Structure

Implements org.exolab.castor.xml.schema.Structure.

String org.exolab.castor.xml.schema.Schema.getTargetNamespace ( )

Returns the target namespace for this Schema, or null if no namespace has been defined.

Returns:: the target namespace for this Schema, or null if no namespace has been defined

XMLType org.exolab.castor.xml.schema.Schema.getType ( String typeName )

Returns the first simple or complex type which name equals TypeName

References org.exolab.castor.xml.schema.Schema.DEFAULT_SCHEMA_NS, org.exolab.castor.xml.schema.Schema.getComplexType(), org.exolab.castor.xml.Namespaces.getNamespaceURI(), and org.exolab.castor.xml.schema.Schema.getSimpleType().

static SimpleTypesFactory org.exolab.castor.xml.schema.Schema.getTypeFactory ( ) [static, package]

Gets the type factory, package private

String org.exolab.castor.xml.schema.Schema.getVersion ( )

Returns the version information of the XML Schema definition represented by this Schema instance.

Returns:: the version information of the XML Schema definition, or null if no version information exists.

boolean org.exolab.castor.xml.schema.Schema.includeProcessed ( String includeFile )

Returns True if the given XML Schema has already been included via <xs:include>

Returns:: True if the file specified has already been processed

Referenced by org.exolab.castor.xml.schema.reader.IncludeUnmarshaller.IncludeUnmarshaller().

boolean org.exolab.castor.xml.schema.Schema.isKnownNamespace ( String namespaceURL )

Returns True if the namespace is known to this schema

Parameters:

namespace

the namespace URL

Returns:: True if the namespace was declared in the schema

References org.exolab.castor.xml.Namespaces.getNamespacePrefix().

boolean org.exolab.castor.xml.schema.Schema.removeAttribute ( AttributeDecl attribute )

Removes the given top level Attribute from this Schema

Parameters:

attribute

the AttributeDecl to remove

Returns:: true if the AttributeDecl has been removed, or false if the AttributeDecl wasn't top level or didn't exist in this Schema

References org.exolab.castor.xml.schema.AttributeDecl.getName(), and org.exolab.castor.xml.schema.Schema.removeAttribute().

Referenced by org.exolab.castor.xml.schema.Schema.removeAttribute().

boolean org.exolab.castor.xml.schema.Schema.removeAttributeGroup ( AttributeGroupDecl group )

Removes the given AttributeGroup definition from this Schema

Parameters:

group

the AttributeGroup definition to remove

Returns:: true if the AttributeGroup definition has been removed.

References org.exolab.castor.xml.schema.AttributeGroupDecl.getName(), org.exolab.castor.xml.schema.Schema.getRedefineSchema(), org.exolab.castor.xml.schema.RedefineSchema.removeAttributeGroup(), and org.exolab.castor.xml.schema.Schema.removeAttributeGroup().

Referenced by org.exolab.castor.xml.schema.Schema.removeAttributeGroup().

synchronized boolean org.exolab.castor.xml.schema.Schema.removeCachedIncludedSchema ( Schema schema )

Removes the given cached included schema from this Schema definition's list of cached included schema.

Parameters:

schema

the Schema to remove from this Schema's redefinition list

Returns:: true if the Schema was removed, otherwise false

References org.exolab.castor.xml.schema.Schema.getSchemaLocation().

boolean org.exolab.castor.xml.schema.Schema.removeComplexType ( ComplexType complexType )

Removes the given top level ComplexType from this Schema

Parameters:

complexType

the ComplexType to remove

Returns:: true if the complexType has been removed, or false if the complexType wasn't top level or didn't exist in this Schema

References org.exolab.castor.xml.schema.XMLType.getName(), org.exolab.castor.xml.schema.Schema.getRedefineSchema(), org.exolab.castor.xml.schema.ComplexType.isTopLevel(), org.exolab.castor.xml.schema.RedefineSchema.removeComplexType(), org.exolab.castor.xml.schema.Schema.removeComplexType(), and org.exolab.castor.xml.schema.ComplexType.setParent().

Referenced by org.exolab.castor.xml.schema.Schema.removeComplexType(), and org.exolab.castor.xml.schema.XMLType.setName().

boolean org.exolab.castor.xml.schema.Schema.removeElement ( ElementDecl element )

Removes the given top level Element from this Schema

Parameters:

element

the ElementDecl to remove

Returns:: true if the ElementDecl has been removed, or false if the ElementDecl wasn't top level or didn't exist in this Schema

References org.exolab.castor.xml.schema.ElementDecl.getName(), and org.exolab.castor.xml.schema.Schema.removeElement().

Referenced by org.exolab.castor.xml.schema.Schema.removeElement().

boolean org.exolab.castor.xml.schema.Schema.removeGroup ( ModelGroup group )

Removes the given top level ModelGroup definition from this Schema

Parameters:

group

the ModelGroup definition to remove

Returns:: true if the ModelGroup definition has been removed, or false if the ModelGroup definition wasn't top level or didn't exist in this Schema.

References org.exolab.castor.xml.schema.ModelGroup.getName(), org.exolab.castor.xml.schema.Schema.getRedefineSchema(), org.exolab.castor.xml.schema.RedefineSchema.removeGroup(), and org.exolab.castor.xml.schema.Schema.removeGroup().

Referenced by org.exolab.castor.xml.schema.Schema.removeGroup().

synchronized boolean org.exolab.castor.xml.schema.Schema.removeImportedSchema ( Schema schema )

Removes the given Schema definition from this Schema definition's list of imported schenma

Parameters:

schema

the Schema to remove from this Schema's import list

Returns:: true if the Schema was removed, otherwise false

References org.exolab.castor.xml.schema.Schema.getTargetNamespace().

boolean org.exolab.castor.xml.schema.Schema.removeNamespace ( String prefix )

Removes the namespace from the set of namespace declarations for this Schema definition.

Parameters:

prefix

the namespace prefix of the namespace to remove.

References org.exolab.castor.xml.Namespaces.removeNamespace().

Referenced by org.exolab.castor.xml.schema.reader.SchemaUnmarshaller.SchemaUnmarshaller().

synchronized boolean org.exolab.castor.xml.schema.Schema.removeRedefineSchema ( RedefineSchema schema )

Removes the given redefined structure from this Schema definition's list of redefinitions.

Parameters:

schema

the Schema to remove from this Schema's redefinition list

Returns:: true if the Schema was removed, otherwise false

References org.exolab.castor.xml.schema.RedefineSchema.getSchemaLocation().

Referenced by org.exolab.castor.xml.schema.reader.SchemaUnmarshaller.endElement().

boolean org.exolab.castor.xml.schema.Schema.removeSimpleType ( SimpleType simpleType )

Removes the given top level SimpleType from this Schema

Parameters:

SimpleType

the SimpleType to remove

Returns:: true if the SimpleType has been removed, or false if the SimpleType wasn't top level or didn't exist in this Schema

References org.exolab.castor.xml.schema.XMLType.getName(), org.exolab.castor.xml.schema.Schema.getRedefineSchema(), org.exolab.castor.xml.schema.RedefineSchema.removeSimpleType(), and org.exolab.castor.xml.schema.Schema.removeSimpleType().

Referenced by org.exolab.castor.xml.schema.Schema.removeSimpleType(), and org.exolab.castor.xml.schema.XMLType.setName().

void org.exolab.castor.xml.schema.Schema.setAttributeFormDefault ( Form attributeFormDefault )

Sets the attributeFormDefault property of this Schema.

Parameters:

attributeFormDefault

the Form value of the attributeFormDefault property for this Schema.

void org.exolab.castor.xml.schema.Schema.setBlockDefault ( BlockList block )

Sets the default BlockList for this Schema.

Parameters:

block

the default BlockList to set for this Schema.

void org.exolab.castor.xml.schema.Schema.setBlockDefault ( String block )

Sets the default Block values for this Schema.

Parameters:

block

the default Block values to set for this Schema.

void org.exolab.castor.xml.schema.Schema.setElementFormDefault ( Form elementFormDefault )

Sets the elementFormDefault property of this Schema.

Parameters:

elementFormDefault

the Form value of the elementFormDefault property for this Schema.

void org.exolab.castor.xml.schema.Schema.setFinalDefault ( FinalList finalList )

Sets the default FinalList for this Schema.

Parameters:

final

the default FinalList to set for this Schema.

void org.exolab.castor.xml.schema.Schema.setFinalDefault ( String finalValues )

Sets the default final values for this Schema.

Parameters:

finalValues

the default final values to set for this Schema.

void org.exolab.castor.xml.schema.Schema.setId ( String id )

Sets the Id for this Schema

Parameters:

id

the Id for this Schema

Referenced by org.exolab.castor.xml.dtd.Converter.convertDTDObjectToSchemaObject().

void org.exolab.castor.xml.schema.Schema.setMasterSchema ( Schema masterSchema ) [protected]

Sets the master schema in which this instance of schema is used at runtime. This method is meant to be used at runtime. A master schema is a schema in which this instance of Schema is included, redefined or imported.

Parameters:

the

master schema in which this instance of schema is used at runtime. This method is meant to be used at runtime.

void org.exolab.castor.xml.schema.Schema.setSchemaLocation ( String schemaLocation )

Set the schemaLocation for this schema. This is useful when this schema has been imported by another schema

Parameters:

schemaLocation

the location hint for this Schema

Referenced by org.exolab.castor.xml.schema.reader.ImportUnmarshaller.ImportUnmarshaller(), and org.exolab.castor.xml.schema.reader.RedefineUnmarshaller.RedefineUnmarshaller().

void org.exolab.castor.xml.schema.Schema.setTargetNamespace ( String targetNamespace )

Sets the target namespace for this Schema

Parameters:

targetNamespace

the target namespace for this Schema

See also:: 2.7 XML Schema Part 1: Structures

Referenced by org.exolab.castor.xml.schema.reader.IncludeUnmarshaller.IncludeUnmarshaller(), and org.exolab.castor.xml.schema.reader.RedefineUnmarshaller.RedefineUnmarshaller().

void org.exolab.castor.xml.schema.Schema.setVersion ( String version )

Sets the version information for the XML Schema defintion represented by this Schema instance.

Parameters:

the

version for this XML Schema defination.

void org.exolab.castor.xml.schema.Schema.validate ( ) throws ValidationException [virtual]

Checks the validity of this Schema definition.

Exceptions:

ValidationException

when this Schema definition is invalid.

Implements org.exolab.castor.xml.schema.Structure.

References org.exolab.castor.xml.schema.SimpleType.validate(), and org.exolab.castor.xml.schema.ComplexType.validate().

Referenced by org.exolab.castor.builder.SourceGenerator.generateSource(), and org.exolab.castor.xml.schema.reader.SchemaReader.read().

Member Data Documentation

final String org.exolab.castor.xml.schema.Schema.DEFAULT_SCHEMA_NS = "http://www.w3.org/2001/XMLSchema" [static]

The Namespace supported by the W3C XML Schema Recommendation.

Referenced by org.exolab.castor.xml.schema.Schema.getType(), and org.exolab.castor.xml.schema.Schema.Schema().

final String org.exolab.castor.xml.schema.Schema.XSI_NAMESPACE = "http://www.w3.org/2001/XMLSchema-instance" [static]

The Namespace supported by the W3C XML Schema Recommendation for the built-in types: xsi:type, xsi:nil, and xsi:schemaLocation.

The documentation for this class was generated from the following file:

Schema.java

All Classes Namespaces Files Functions Variables Enumerations Properties

org.exolab.castor.xml.schema.Schema Class Reference

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Package Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation