org.dlese.dpc.xml.schema

Class GlobalDefMap

java.lang.Object

org.dlese.dpc.xml.schema.GlobalDefMap

public class GlobalDefMap
extends java.lang.Object

Stores GlobalDef instances, which are wrappers for important elements of an XML Schema, including

• Simple and ComplexType definitions,
• Goup definitions, and
• Global Element and Global Attribute declarations

The definitions are stored in a two-level mapping. The first level is by namespaceUri, so there is a map for each namespace. The individual namespace maps store all the GlobalDefs for that namespace. To access a particular globalDefinition, the name of the definition (e.g., the type name) is required, as well as the namespaceUri for the namespace in which the definition is defined.

This class also contains a NamespaceRegistry that stores the namespaces defined at the global level of the schema. NOTE: it is possible that schemafiles define and use namespaces that are not visible at the top-level of the schema. In this case, there will be entries in the GlobalDefMap for these namespaces, but the namespaces themselves will not be registered in the NamespaceRegistry.

Author:

ostwald

Constructor Summary

Constructors

Constructor and Description
GlobalDefMap()

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(java.lang.String key) Description of the Method
void	destroy() Should release resources and call the finalize method.
java.util.List	getComplexTypes()
java.util.List	getDefsOfType(int type)
NamespaceRegistry	getNamespaces()
java.util.List	getNsKeys() Method to retrieve the list of names used to identify desired values.
java.util.Map	getNsMap(java.lang.String nsUri)
java.util.List	getNsValues(java.lang.String nsUri) Retrieves GlobalDefs associated with specified Namespace.
java.util.List	getSimpleTypes()
GlobalDef	getValue(java.lang.String name) Accessor method for retrieving a specific named GlobalDef.
GlobalDef	getValue(java.lang.String name, org.dom4j.Namespace ns)
GlobalDef	getValue(java.lang.String name, java.lang.String nsUri)
java.util.List	getValues()
boolean	init() Should initialize members as required.
static void	setDebug(boolean d)
void	setValue(java.lang.String name, GlobalDef def, org.dom4j.Namespace ns) Inserts a GlobalDef instance in the GlobalDefMap.

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalDefMap

public GlobalDefMap()

Method Detail

init

public boolean init()

Should initialize members as required.

Returns:

true if intialization successful, false otherwise

getNamespaces

public NamespaceRegistry getNamespaces()

destroy

public void destroy()

Should release resources and call the finalize method.

containsKey

public boolean containsKey(java.lang.String key)

Description of the Method

Parameters:

key - Description of the Parameter

Returns:

Description of the Return Value

getNsKeys

public java.util.List getNsKeys()

Method to retrieve the list of names used to identify desired values.

Returns:

The keys value

getValues

public java.util.List getValues()

getNsMap

public java.util.Map getNsMap(java.lang.String nsUri)

getSimpleTypes

public java.util.List getSimpleTypes()

getComplexTypes

public java.util.List getComplexTypes()

getDefsOfType

public java.util.List getDefsOfType(int type)

getNsValues

public java.util.List getNsValues(java.lang.String nsUri)

Retrieves GlobalDefs associated with specified Namespace.

Returns:

The values value

getValue

public GlobalDef getValue(java.lang.String name)

Accessor method for retrieving a specific named GlobalDef. Namespace prefixes for the default name space (or the targetNameSpace if there is no defaultNamespace defined), are stripped.

Parameters:

name - Description of the Parameter

Returns:

The value value

getValue

public GlobalDef getValue(java.lang.String name,
                          org.dom4j.Namespace ns)

getValue

public GlobalDef getValue(java.lang.String name,
                          java.lang.String nsUri)

setValue

public void setValue(java.lang.String name,
                     GlobalDef def,
                     org.dom4j.Namespace ns)
              throws java.lang.Exception

Inserts a GlobalDef instance in the GlobalDefMap.

Parameters:

name - The GlobalDef name

def - The globalDef object

Throws:

java.lang.Exception - if the GlobalDef is already in the map

setDebug

public static void setDebug(boolean d)