org.dlese.dpc.xml.schema

Class GlobalDeclaration

java.lang.Object

org.dlese.dpc.xml.schema.GlobalDeclaration

All Implemented Interfaces:

GlobalDef

Direct Known Subclasses:

AttributeGroup, GlobalAttribute, GlobalElement

public class GlobalDeclaration
extends java.lang.Object
implements GlobalDef

Wrapper for global delclarations in an XML Schema, which are defined as an immediate child of the schema element.

Global Declarations do NOT define a data type or model, but they do define a construct that can be referred to by other schema elements via the "ref" attribute.

Author:

Jonathan Ostwald

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	debug
protected java.lang.String	documentation
protected org.dom4j.Element	element
protected java.lang.String	location
protected java.lang.String	name
protected org.dom4j.Namespace	namespace
protected SchemaReader	schemaReader
protected java.lang.String	type
protected java.lang.String	xsdPrefix

Fields inherited from interface org.dlese.dpc.xml.schema.GlobalDef

ATTRIBUTE_GROUP, BUILT_IN_TYPE, COMPLEX_TYPE, GENERIC_TYPE, GLOBAL_ATTRIBUTE, GLOBAL_DECLARATION, GLOBAL_ELEMENT, MODEL_GROUP, SIMPLE_TYPE

Constructor Summary

Constructors

Constructor and Description
GlobalDeclaration(org.dom4j.Element element, java.lang.String location, org.dom4j.Namespace namespace, SchemaReader schemaReader) Constructor for the GlobalDeclaration object

Method Summary

Modifier and Type	Method and Description
void	extractDocumentation()
int	getDataType() Gets the dataType attribute of the GlobalDeclaration object
java.lang.String	getDocumentation()
org.dom4j.Element	getElement() Gets the element attribute of the GlobalDeclaration object
java.lang.String	getElementAsXml()
java.lang.String	getLocation() Gets the location attribute of the GlobalDeclaration object
java.lang.String	getName() Gets the name attribute of the GlobalDeclaration object
org.dom4j.Namespace	getNamespace() Gets the namespace attribute of the GlobalDeclaration object
java.lang.String	getQualifiedInstanceName() use prefix for namespace as defined at the instance level.
java.lang.String	getQualifiedName()
SchemaReader	getSchemaReader()
java.lang.String	getType() Gets the type attribute of the GlobalDeclaration object
boolean	isAnyType()
boolean	isAttributeGroup()
boolean	isBuiltIn() Gets the builtIn attribute of the GlobalDeclaration object
boolean	isComplexType() Gets the complexType attribute of the GlobalDeclaration object
boolean	isGlobalAttribute()
boolean	isGlobalDeclaration() Gets the GlobalDeclaration attribute of the GlobalDeclaration object
boolean	isGlobalElement()
boolean	isModelGroup()
boolean	isSimpleType() Gets the simpleType attribute of the GlobalDeclaration object
boolean	isTypeDef() Gets the builtIn attribute of the GlobalDef object
protected static void	prtln(java.lang.String s)
protected static void	prtlnErr(java.lang.String s)
java.lang.String	toString() NOT YET DOCUMENTED

Methods inherited from class java.lang.Object

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

Field Detail

debug

protected static boolean debug

name

protected java.lang.String name

type

protected java.lang.String type

element

protected org.dom4j.Element element

location

protected java.lang.String location

namespace

protected org.dom4j.Namespace namespace

schemaReader

protected SchemaReader schemaReader

documentation

protected java.lang.String documentation

xsdPrefix

protected java.lang.String xsdPrefix

Constructor Detail

GlobalDeclaration

public GlobalDeclaration(org.dom4j.Element element,
                         java.lang.String location,
                         org.dom4j.Namespace namespace,
                         SchemaReader schemaReader)

Constructor for the GlobalDeclaration object

Parameters:

element - NOT YET DOCUMENTED

location - NOT YET DOCUMENTED

namespace - NOT YET DOCUMENTED

Method Detail

getSchemaReader

public SchemaReader getSchemaReader()

Specified by:

getSchemaReader in interface GlobalDef

isTypeDef

public boolean isTypeDef()

Description copied from interface: GlobalDef

Gets the builtIn attribute of the GlobalDef object

Specified by:

isTypeDef in interface GlobalDef

Returns:

The builtIn value

extractDocumentation

public void extractDocumentation()

getDocumentation

public java.lang.String getDocumentation()

Specified by:

getDocumentation in interface GlobalDef

isSimpleType

public boolean isSimpleType()

Gets the simpleType attribute of the GlobalDeclaration object

Specified by:

isSimpleType in interface GlobalDef

Returns:

The simpleType value

isComplexType

public boolean isComplexType()

Gets the complexType attribute of the GlobalDeclaration object

Specified by:

isComplexType in interface GlobalDef

Returns:

The complexType value

isModelGroup

public boolean isModelGroup()

Specified by:

isModelGroup in interface GlobalDef

isGlobalDeclaration

public boolean isGlobalDeclaration()

Gets the GlobalDeclaration attribute of the GlobalDeclaration object

Specified by:

isGlobalDeclaration in interface GlobalDef

Returns:

The GlobalDeclaration value

isGlobalAttribute

public boolean isGlobalAttribute()

Specified by:

isGlobalAttribute in interface GlobalDef

isGlobalElement

public boolean isGlobalElement()

Specified by:

isGlobalElement in interface GlobalDef

isAttributeGroup

public boolean isAttributeGroup()

Specified by:

isAttributeGroup in interface GlobalDef

isBuiltIn

public boolean isBuiltIn()

Gets the builtIn attribute of the GlobalDeclaration object

Specified by:

isBuiltIn in interface GlobalDef

Returns:

The builtIn value

isAnyType

public boolean isAnyType()

Specified by:

isAnyType in interface GlobalDef

getDataType

public int getDataType()

Gets the dataType attribute of the GlobalDeclaration object

Specified by:

getDataType in interface GlobalDef

Returns:

The dataType value

getType

public java.lang.String getType()

Gets the type attribute of the GlobalDeclaration object

Specified by:

getType in interface GlobalDef

Returns:

The type value

getName

public java.lang.String getName()

Gets the name attribute of the GlobalDeclaration object

Specified by:

getName in interface GlobalDef

Returns:

The name value

getQualifiedName

public java.lang.String getQualifiedName()

Specified by:

getQualifiedName in interface GlobalDef

getQualifiedInstanceName

public java.lang.String getQualifiedInstanceName()

use prefix for namespace as defined at the instance level. NOTE: namespaces may not be defined at the instance level!

Specified by:

getQualifiedInstanceName in interface GlobalDef

getNamespace

public org.dom4j.Namespace getNamespace()

Gets the namespace attribute of the GlobalDeclaration object

Specified by:

getNamespace in interface GlobalDef

Returns:

The namespace value

getLocation

public java.lang.String getLocation()

Gets the location attribute of the GlobalDeclaration object

Specified by:

getLocation in interface GlobalDef

Returns:

The location value

getElement

public org.dom4j.Element getElement()

Gets the element attribute of the GlobalDeclaration object

Specified by:

getElement in interface GlobalDef

Returns:

The element value

getElementAsXml

public java.lang.String getElementAsXml()

Specified by:

getElementAsXml in interface GlobalDef

toString

public java.lang.String toString()

NOT YET DOCUMENTED

Specified by:

toString in interface GlobalDef

Overrides:

toString in class java.lang.Object

Returns:

NOT YET DOCUMENTED

prtln

protected static void prtln(java.lang.String s)

prtlnErr

protected static void prtlnErr(java.lang.String s)