org.dlese.dpc.xml.schema

Interface GlobalDef

All Known Implementing Classes:

AttributeGroup, BuiltInType, ComplexType, GenericType, GlobalAttribute, GlobalDeclaration, GlobalElement, ModelGroup, SimpleType

public interface GlobalDef

Interface for classes encapsulating XML Schema Elements, such as Elements, Attributes, and Type Definitions. There are two "families" of GlobalDefs: type definitions and declarations. Type definitions include GenericType, BuiltInType, SimpleType and ComplexType. Global Declarations include GlobalElement and GlobalAttributes.

Author:

ostwald

$Id $

Field Summary

Fields

Modifier and Type	Field and Description
static int	ATTRIBUTE_GROUP
static int	BUILT_IN_TYPE
static int	COMPLEX_TYPE
static int	GENERIC_TYPE
static int	GLOBAL_ATTRIBUTE
static int	GLOBAL_DECLARATION
static int	GLOBAL_ELEMENT
static int	MODEL_GROUP
static int	SIMPLE_TYPE

Method Summary

Modifier and Type	Method and Description
int	getDataType() Returns an integer contant that specifies whether this GlobalDef is Generic, Simple, Complex, Global or Built-in datatype.
java.lang.String	getDocumentation()
org.dom4j.Element	getElement() Gets the element attribute of the GlobalDef object
java.lang.String	getElementAsXml()
java.lang.String	getLocation() Returns string representation of URI to the schema file in which this GlobalDef is defined.
java.lang.String	getName() Returns the dataType name for this GlobalDef (e.g., "union.dateType", "stringTextType", etc).
org.dom4j.Namespace	getNamespace()
java.lang.String	getQualifiedInstanceName() use prefix for namespace as defined at the instance level.
java.lang.String	getQualifiedName()
SchemaReader	getSchemaReader()
java.lang.String	getType() Returns string representation of the Global Def's dataType (e.g., "simpleType", "complexType", etc).
boolean	isAnyType()
boolean	isAttributeGroup()
boolean	isBuiltIn() Gets the builtIn attribute of the GlobalDef object
boolean	isComplexType() Gets the complexType attribute of the GlobalDef object
boolean	isGlobalAttribute()
boolean	isGlobalDeclaration() Gets the globalElement attribute of the GlobalDef object
boolean	isGlobalElement()
boolean	isModelGroup()
boolean	isSimpleType() Gets the simpleType attribute of the GlobalDef object
boolean	isTypeDef() Gets the builtIn attribute of the GlobalDef object
java.lang.String	toString() Description of the Method

Field Detail

GENERIC_TYPE

static final int GENERIC_TYPE

See Also:

Constant Field Values

SIMPLE_TYPE

static final int SIMPLE_TYPE

See Also:

Constant Field Values

COMPLEX_TYPE

static final int COMPLEX_TYPE

See Also:

Constant Field Values

GLOBAL_DECLARATION

static final int GLOBAL_DECLARATION

See Also:

Constant Field Values

GLOBAL_ELEMENT

static final int GLOBAL_ELEMENT

See Also:

Constant Field Values

GLOBAL_ATTRIBUTE

static final int GLOBAL_ATTRIBUTE

See Also:

Constant Field Values

BUILT_IN_TYPE

static final int BUILT_IN_TYPE

See Also:

Constant Field Values

MODEL_GROUP

static final int MODEL_GROUP

See Also:

Constant Field Values

ATTRIBUTE_GROUP

static final int ATTRIBUTE_GROUP

See Also:

Constant Field Values

Method Detail

getDataType

int getDataType()

Returns an integer contant that specifies whether this GlobalDef is Generic, Simple, Complex, Global or Built-in datatype.

Returns:

The dataType value

getType

java.lang.String getType()

Returns string representation of the Global Def's dataType (e.g., "simpleType", "complexType", etc).

Returns:

The type value

getDocumentation

java.lang.String getDocumentation()

getName

java.lang.String getName()

Returns the dataType name for this GlobalDef (e.g., "union.dateType", "stringTextType", etc).

Returns:

The name value

getNamespace

org.dom4j.Namespace getNamespace()

getQualifiedName

java.lang.String getQualifiedName()

getQualifiedInstanceName

java.lang.String getQualifiedInstanceName()

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

getLocation

java.lang.String getLocation()

Returns string representation of URI to the schema file in which this GlobalDef is defined.

Returns:

The location value

getElement

org.dom4j.Element getElement()

Gets the element attribute of the GlobalDef object

Returns:

The element value

getElementAsXml

java.lang.String getElementAsXml()

toString

java.lang.String toString()

Description of the Method

Overrides:

toString in class java.lang.Object

Returns:

Description of the Return Value

getSchemaReader

SchemaReader getSchemaReader()

isTypeDef

boolean isTypeDef()

Gets the builtIn attribute of the GlobalDef object

Returns:

The builtIn value

isBuiltIn

boolean isBuiltIn()

Gets the builtIn attribute of the GlobalDef object

Returns:

The builtIn value

isAnyType

boolean isAnyType()

isSimpleType

boolean isSimpleType()

Gets the simpleType attribute of the GlobalDef object

Returns:

The simpleType value

isComplexType

boolean isComplexType()

Gets the complexType attribute of the GlobalDef object

Returns:

The complexType value

isModelGroup

boolean isModelGroup()

isAttributeGroup

boolean isAttributeGroup()

isGlobalDeclaration

boolean isGlobalDeclaration()

Gets the globalElement attribute of the GlobalDef object

Returns:

The globalElement value

isGlobalElement

boolean isGlobalElement()

isGlobalAttribute

boolean isGlobalAttribute()