DLESE Tools
v1.6.0

org.dlese.dpc.xml.schema
Class GlobalDeclaration

java.lang.Object
  extended by org.dlese.dpc.xml.schema.GlobalDeclaration
All Implemented Interfaces:
GlobalDef
Direct Known Subclasses:
AttributeGroup, GlobalAttribute, GlobalElement

public class GlobalDeclaration
extends 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
protected static boolean debug
           
protected  String documentation
           
protected  Element element
           
protected  String location
           
protected  String name
           
protected  Namespace namespace
           
protected  SchemaReader schemaReader
           
protected  String type
           
protected  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
GlobalDeclaration(Element element, String location, Namespace namespace, SchemaReader schemaReader)
          Constructor for the GlobalDeclaration object
 
Method Summary
 void extractDocumentation()
           
 int getDataType()
          Gets the dataType attribute of the GlobalDeclaration object
 String getDocumentation()
           
 Element getElement()
          Gets the element attribute of the GlobalDeclaration object
 String getElementAsXml()
           
 String getLocation()
          Gets the location attribute of the GlobalDeclaration object
 String getName()
          Gets the name attribute of the GlobalDeclaration object
 Namespace getNamespace()
          Gets the namespace attribute of the GlobalDeclaration object
 String getQualifiedInstanceName()
          use prefix for namespace as defined at the instance level.
 String getQualifiedName()
           
 SchemaReader getSchemaReader()
           
 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(String s)
           
protected static void prtlnErr(String s)
           
 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 String name

type

protected String type

element

protected Element element

location

protected String location

namespace

protected Namespace namespace

schemaReader

protected SchemaReader schemaReader

documentation

protected String documentation

xsdPrefix

protected String xsdPrefix
Constructor Detail

GlobalDeclaration

public GlobalDeclaration(Element element,
                         String location,
                         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 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 String getType()
Gets the type attribute of the GlobalDeclaration object

Specified by:
getType in interface GlobalDef
Returns:
The type value

getName

public String getName()
Gets the name attribute of the GlobalDeclaration object

Specified by:
getName in interface GlobalDef
Returns:
The name value

getQualifiedName

public String getQualifiedName()
Specified by:
getQualifiedName in interface GlobalDef

getQualifiedInstanceName

public 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 Namespace getNamespace()
Gets the namespace attribute of the GlobalDeclaration object

Specified by:
getNamespace in interface GlobalDef
Returns:
The namespace value

getLocation

public String getLocation()
Gets the location attribute of the GlobalDeclaration object

Specified by:
getLocation in interface GlobalDef
Returns:
The location value

getElement

public Element getElement()
Gets the element attribute of the GlobalDeclaration object

Specified by:
getElement in interface GlobalDef
Returns:
The element value

getElementAsXml

public String getElementAsXml()
Specified by:
getElementAsXml in interface GlobalDef

toString

public String toString()
NOT YET DOCUMENTED

Specified by:
toString in interface GlobalDef
Overrides:
toString in class Object
Returns:
NOT YET DOCUMENTED

prtln

protected static void prtln(String s)

prtlnErr

protected static void prtlnErr(String s)

DLESE Tools
v1.6.0