XML.Namespace manages the XML namespaces for an XML document. More...

Inheritance diagram for Namespaces:

[legend]

Collaboration diagram for Namespaces:

[legend]

Public Member Functions
_.Library.Status	AddInstanceNamespace (_.Library.String prefix)
	XML.Namespace manages the XML namespaces for an XML document. More...

_.Library.Status	AddNamespace (_.Library.String namespace, _.Library.String prefix, _.Library.String schemaLocation, _.Library.Boolean allowMultiplePrefixes)
	Add a namespace definition to the current level. More...

_.Library.Status	AddSOAP12Namespace (_.Library.String soapPrefix, _.Library.String schemaPrefix, _.Library.String xsiPrefix)
	Add the SOAP 1.2 encoding namespace, the XML schema namespace and the. More...

_.Library.Status	AddSOAPNamespace (_.Library.String soapPrefix, _.Library.String schemaPrefix, _.Library.String xsiPrefix)
	Add the SOAP 1.1 encoding namespace, the XML schema namespace and the. More...

_.Library.Status	AddSchemaNamespace (_.Library.String prefix)
	Add a the XML Schema namespace definition to the current level. More...

	DefineAllNamespacePrefixes (_.Library.Boolean prefixRequired)
	Make prefix definition for all newly added namespaces. More...

	DefineNamespacePrefix (_.Library.String namespace, _.Library.Boolean prefixRequired, _.Library.String prefix)
	Make prefix definition for a new namespace at the current level. More...

_.Library.String	GetNamespace (_.Library.String prefix)
	Get the namespace for the specified prefix at the current stack level. More...

_.Library.String	GetNewPrefix (_.Library.String prefix, _.Library.Boolean bTemp)
	Get a new unique prefix.

_.Library.String	GetNextDefinedNamespace (_.Library.String namespace)
	Get the next namespace.

_.Library.String	GetPrefix (_.Library.String namespace)
	Get the prefix for the specified namespace at the current stack level. More...

	PopNode ()
	Pop the namespace information for the last node pushed.

_.Library.Status	PushNode (_.Library.String namespace)
	Push a new current namespace onto the stack of active namespaces. More...

	Reset ()
	Reset myself.

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Static Public Member Functions
_.Library.String	GetNextClass (_.Library.String namespace, _.Library.String class)
	GetNextClass returns the next class in the XML namespace in class name order. More...

_.Library.String	GetNextNamespace (_.Library.String namespace)
	GetNextNamespace returns the next XML namespace in name order. More...

Public Attributes
	AttributeQualified
	If true, the XML document is the the form specified by attributeFormDefault="qualified". More...

	CurrentNamespace
	The namespace for the current node. More...

	DefaultDefined
	The default namespace that the XML document has defined or "" if none. More...

	DefaultNamespace
	The default namespace to use when no namespace is specified for the. More...

	DefaultPrefix
	DefaultPrefix(namespace)=prefix is an array of default prefixes to be used for. More...

	DefaultXmlns
	<property>DefaultXmlns</property> allows optional specification of the XML namespace More...

	ElementQualified
	If true, the XML document is the the form specified by elementFormDefault="qualified". More...

	OutputTypeAttribute
	<property>OutputTypeAttribute</property> allows the user to force the inclusion of the xsi:type More...

	SaveDefaultDefined
	Save default namespace when making temporary change before calling XMLExportInternal. More...

	SuppressXmlns
	<property>SuppressXmlns</property> allows optionally suppression of the use of xmlns= to set More...

Additional Inherited Members
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

XML.Namespace manages the XML namespaces for an XML document.

Member Function Documentation

◆ AddInstanceNamespace()

_.Library.Status AddInstanceNamespace ( _.Library.String prefix )

XML.Namespace manages the XML namespaces for an XML document.

Add a the XML Schema instance namespace definition to the current level.

<method>PopNode</method> will remove this definition. The next <method>PushNode...</method> will cause the attributes to be created for adding this namespace to the XML document.

prefix is the optional preferred prefix for this namespace. If no prefix is specified, a unique prefix will be computed.

◆ AddNamespace()

_.Library.Status AddNamespace	(	_.Library.String	namespace,
		_.Library.String	prefix,
		_.Library.String	schemaLocation,
		_.Library.Boolean	allowMultiplePrefixes
	)

Add a namespace definition to the current level.

<method>PopNode</method> will remove this definition. The next <method>PushNode...</method> will cause the attributes to be created for adding this namespace to the XML document.

prefix is the optional preferred prefix for this namespace. If no prefix is specified, a unique prefix will be computed.

A schemaLocation attribute value for the first definition of this namespace may also specified.

If allowMultiplePrefixes is true then multiple prefixes may be defined for the same namespace. The default is false which will override the previously defined prefix for the same namespace.

◆ AddSOAP12Namespace()

_.Library.Status AddSOAP12Namespace	(	_.Library.String	soapPrefix,
		_.Library.String	schemaPrefix,
		_.Library.String	xsiPrefix
	)

Add the SOAP 1.2 encoding namespace, the XML schema namespace and the.

XML Schema instance namespace definitions to the current level. <method>PopNode</method> will remove these definitions. The next <method>PushNode...</method> will cause the attributes to be created for adding these namespaces to the XML document.

soapPrefix, schemaPrefixPrefix and xsiPrefix are the optional preferred prefix for these namespaces. If no prefix is specified, a unique prefix will be computed.

◆ AddSOAPNamespace()

_.Library.Status AddSOAPNamespace	(	_.Library.String	soapPrefix,
		_.Library.String	schemaPrefix,
		_.Library.String	xsiPrefix
	)

Add the SOAP 1.1 encoding namespace, the XML schema namespace and the.

XML Schema instance namespace definitions to the current level. <method>PopNode</method> will remove these definitions. The next <method>PushNode...</method> will cause the attributes to be created for adding these namespaces to the XML document.

soapPrefix, schemaPrefixPrefix and xsiPrefix are the optional preferred prefix for these namespaces. If no prefix is specified, a unique prefix will be computed.

◆ AddSchemaNamespace()

_.Library.Status AddSchemaNamespace ( _.Library.String prefix )

Add a the XML Schema namespace definition to the current level.

<method>PopNode</method> will remove this definition. The next <method>PushNode...</method> will cause the attributes to be created for adding this namespace to the XML document.

prefix is the optional preferred prefix for this namespace. If no prefix is specified, a unique prefix will be computed.

◆ DefineAllNamespacePrefixes()

DefineAllNamespacePrefixes ( _.Library.Boolean prefixRequired )

Make prefix definition for all newly added namespaces.

◆ DefineNamespacePrefix()

DefineNamespacePrefix	(	_.Library.String	namespace,
		_.Library.Boolean	prefixRequired,
		_.Library.String	prefix
	)

Make prefix definition for a new namespace at the current level.

Optionally force the prefix to be used by specifying 3rd argument.

◆ GetNamespace()

_.Library.String GetNamespace ( _.Library.String prefix )

Get the namespace for the specified prefix at the current stack level.

"" is returned if the prefix is not defined.

◆ GetNextClass()

_.Library.String GetNextClass	(	_.Library.String	namespace,
		_.Library.String	class
	)

static

GetNextClass returns the next class in the XML namespace in class name order.

A return of "", indicates no more classes to list.
Note that namespace="" indicates classes without an XML namespace defined.

◆ GetNextNamespace()

_.Library.String GetNextNamespace ( _.Library.String namespace )

static

GetNextNamespace returns the next XML namespace in name order.

A return of "", indicates no more XML namespaces to list.

◆ GetPrefix()

_.Library.String GetPrefix ( _.Library.String namespace )

Get the prefix for the specified namespace at the current stack level.

"" is returned if the namespace is not defined.

◆ PushNode()

_.Library.Status PushNode ( _.Library.String namespace )

Push a new current namespace onto the stack of active namespaces.

<var>namespace</var> is the XML namespace for the elements of the
node that is being created.  This method does not actually create the node.
It just does the required namespace handling.  If this namespace
has not yet been added, it will also be added with a default prefix.
The default namespace will be the namespace for the node if "" is specified.<br>

Member Data Documentation

◆ AttributeQualified

AttributeQualified

If true, the XML document is the the form specified by attributeFormDefault="qualified".

◆ CurrentNamespace

CurrentNamespace

The namespace for the current node.

◆ DefaultDefined

DefaultDefined

The default namespace that the XML document has defined or "" if none.

◆ DefaultNamespace

DefaultNamespace

The default namespace to use when no namespace is specified for the.

current namespace. The namespace "" is treated as equivalent to an XML document with no namespace.

◆ DefaultPrefix

DefaultPrefix

DefaultPrefix(namespace)=prefix is an array of default prefixes to be used for.

adding namespaces when no prefix is defined.

◆ DefaultXmlns

DefaultXmlns

<property>DefaultXmlns</property> allows optional specification of the XML namespace

to use as the default XML namespace when SuppressXmlns is false.

◆ ElementQualified

ElementQualified

If true, the XML document is the the form specified by elementFormDefault="qualified".

This is the default value to use if elementQualfied not specified in PushNodeForExport.

◆ OutputTypeAttribute

OutputTypeAttribute

<property>OutputTypeAttribute</property> allows the user to force the inclusion of the xsi:type

attribute for each element of object output.

◆ SaveDefaultDefined

SaveDefaultDefined

Save default namespace when making temporary change before calling XMLExportInternal.

in order to support form="unqualified"

◆ SuppressXmlns

SuppressXmlns

<property>SuppressXmlns</property> allows optionally suppression of the use of xmlns= to set

default XML namespace when ElementQualified is false.
If SuppressXmlns is true then a prefix is used for each tag rather than default namespace with xmlns=.

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddInstanceNamespace()

◆ AddNamespace()

◆ AddSOAP12Namespace()

◆ AddSOAPNamespace()

◆ AddSchemaNamespace()

◆ DefineAllNamespacePrefixes()

◆ DefineNamespacePrefix()

◆ GetNamespace()

◆ GetNextClass()

◆ GetNextNamespace()

◆ GetPrefix()

◆ PushNode()

Member Data Documentation

◆ AttributeQualified

◆ CurrentNamespace

◆ DefaultDefined

◆ DefaultNamespace

◆ DefaultPrefix

◆ DefaultXmlns

◆ ElementQualified

◆ OutputTypeAttribute

◆ SaveDefaultDefined

◆ SuppressXmlns