com.pega.pegarules.pub.services.xsd
Interface XSDTypeDefinition

All Superinterfaces:

XSDComponent

All Known Subinterfaces:

XSDComplexTypeDefinition, XSDSimpleTypeDefinition

public interface XSDTypeDefinition
extends XSDComponent

Base class for all XML Schema type definition classes

Version:

$Revision: 31 $ $Date: 2009-06-24 09:38:04 -0400 (Wed, 24 Jun 2009) $

Author:

Peter Tandara-Kuhns

Field Summary

static java.lang.String	COPYRIGHT
static java.lang.String	VERSION

Method Summary

XSDTypeDefinition	getBaseTypeDefinition() Get the type definition component that this type is derived from.
javax.xml.namespace.QName	getBaseTypeReferenceValue() Get the qualified name of the type that this type is derived from.
java.lang.String	getDerivationType() Get the content type value for this type definition.
java.lang.String	getFinalValue() Get the value of the 'final' attribute.
java.lang.String	getName() Get the name of this type, if it is a named type.
java.lang.String	getNamespaceURI() Get the namespace URI that this type belongs to, if it is a named type.
XSDComponentList	getRestrictionFacets() Get the list of simple type restriction facet components used to constrain the scalar content of this type.
boolean	isGlobal() Determine if the type definition has global scope.
boolean	isRedefine() Determine if the type definition redefines an existing definition.

Methods inherited from interface com.pega.pegarules.pub.services.xsd.XSDComponent

getAllMetadata, getAnnotations, getIDValue

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

Method Detail

getNamespaceURI

java.lang.String getNamespaceURI()

Get the namespace URI that this type belongs to, if it is a named type.

Returns:

the namespace URI value, or null if the type is anonymous

getName

java.lang.String getName()

Get the name of this type, if it is a named type.

Returns:

the name value, or null if the type is anonymous

getFinalValue

java.lang.String getFinalValue()

Get the value of the 'final' attribute. Legal values for complex types are '#all' or a whitespace-delimited list containing the values 'extension' or 'restriction'. Legal values for simple types are '#all' or a whitespace-delimited list containing the values 'restriction', 'list', or 'union'.

Returns:

the value, or the schema 'finalDefault' value if the attribute is not present

getDerivationType

java.lang.String getDerivationType()

Get the content type value for this type definition. Legal derivation type values for complex types are 'extension' or 'restriction'. Legal content derivation type values for simple types are 'restriction', 'list', or 'union'.

Returns:

the content type value

isGlobal

boolean isGlobal()

Determine if the type definition has global scope. All named type definitions have global scope. All anonymous type definitions have local scope.

Returns:

true if the type definition is global, false otherwise

isRedefine

boolean isRedefine()

Determine if the type definition redefines an existing definition.

Returns:

true if this is a type redefinition, false otherwise

getBaseTypeReferenceValue

javax.xml.namespace.QName getBaseTypeReferenceValue()

Get the qualified name of the type that this type is derived from. All defined types will have a base type reference. Complex types will be derived from the built-in xsd:anyType ur-type, unless they are derived from another defined complex type. Simple types will be derived from the built-in xsd:anySimpleType ur-type, unless they are derived from another defined simple type. The built-in XSD types are described in the W3C XML Schema specification, Part 2.

Returns:

the base type definition component

getBaseTypeDefinition

XSDTypeDefinition getBaseTypeDefinition()

Get the type definition component that this type is derived from.

Returns:

the base type definition component, or null if unresolved or not declared

getRestrictionFacets

XSDComponentList getRestrictionFacets()

Get the list of simple type restriction facet components used to constrain the scalar content of this type. List elements are of type XSDSimpleTypeRestrictionFacet.

Returns:

the list of simple type restriction facets