com.wm.xmldata

Class XmlDataTag

java.lang.Object

com.wm.xmldata.XmlDataTag

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

XmlDataAttributeTag, XmlDataContentTag, XmlDataTypeTag

public class XmlDataTag
extends java.lang.Object
implements java.lang.Cloneable

This is the base construction class for all XmlData tags. This class maintains the three portions on an XmlData as three distinct components: the ncName, the namespace, and the particle-id. The various methods of the XmlData implementations expect instances of the various subclass of this class. The methods do not generally accept simple Strings as tags. The choice of subclass depends on the context usage. There are subclasses for XmlDataElementTag, XmlDataAttributeTag, XmlDataGroupTag, XmlDataSubstitutionTag and XmlDataIteratorTag.

Constructor Summary

Constructors

Constructor and Description
XmlDataTag(java.lang.String name) Constructs a generic XmlDataTag.

Method Summary

Modifier and Type	Method and Description
XmlDataTag	clone()
static XmlDataTag	createFromFullName(java.lang.String name) Creates an XMlDataTag object from the String representation of a tag.
static XmlDataTag	createInstanceFromFullName(java.lang.String name, boolean elementDefault)
static XmlDataTag	createInstanceFromFullName(java.lang.String name, boolean elementDefault, XmlNamespaceMap nsDecls) Creates the appropriate XmlDataTag object from a literal tag String.
boolean	equals(java.lang.Object other) Tests the equality of two XmlDataTags.
java.lang.String	getFullName() Creates the String representation of an XMlDataTag from its three components in the {particleId}ncName#namespace.
java.lang.String	getNcName() Returns the NCName portion of an XmlDataTag.
java.lang.String	getPartialName() Returns the full name without the particle-id portion.
java.lang.String	getPathName() Returns the tag in path-name format.
java.lang.String	getPathName(java.lang.String nsPairs) Returns the tag in path-name form using namespace prefixes.
java.lang.String	getPathName(XmlNamespaceMap nsDecls) Returns the tag in path-name form using namespace prefixes.
java.lang.String	getXmlNs() Returns the XML namespace of an XmlDataTag.
boolean	nameEquals(XmlDataTag other) Compares two XmlDataTags, ignoring the particle-id.
boolean	pathEquals(XmlDataTag other) Returns true only if all components of the tag are identical: ncName, namespace, particle-id, index (if specified), indirect-qualifier (if specified)
java.lang.String	toString() toString() generally returns the same value as getPathName, but might contain additional debugging information.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XmlDataTag

public XmlDataTag(java.lang.String name)

Constructs a generic XmlDataTag. This constructor is typically not used because most methods require a specific subclass of XMlDataTag.

Parameters:

name - the ncName portion of the tag

Method Detail

clone

public XmlDataTag clone()

Overrides:

clone in class java.lang.Object

createFromFullName

public static XmlDataTag createFromFullName(java.lang.String name)

Creates an XMlDataTag object from the String representation of a tag.

Parameters:

name - the String representation of an XMlDataTag

Returns:

an XMlDataTag created by parsing the input String

createInstanceFromFullName

public static XmlDataTag createInstanceFromFullName(java.lang.String name,
                                                    boolean elementDefault,
                                                    XmlNamespaceMap nsDecls)

Creates the appropriate XmlDataTag object from a literal tag String. It returns an instance of the appropriate subclass such as an XmlDataElementTag or an XmlDataGroupTag object, etc.

Parameters:

name - the full name of the tag. For example, "*group" or "{2}substitution-name#target", etc. When no particle id is specified for a tag that requires one, for example, *any, it defaults to {1}.

elementDefault - specifies how to treat tags that do not start with the { character and also are not one of the special tags such as *group or *instance. When false, it is treated as an attribute tag; when true it is treated as an element tag.

nsDecls - the namespace declarations

Returns:

an instance of XmlDataTag or one its subclasses

createInstanceFromFullName

public static XmlDataTag createInstanceFromFullName(java.lang.String name,
                                                    boolean elementDefault)

getNcName

public java.lang.String getNcName()

Returns the NCName portion of an XmlDataTag.

Returns:

ncName

getXmlNs

public java.lang.String getXmlNs()

Returns the XML namespace of an XmlDataTag.

Returns:

the XML namespace or null if there is no namespace.

equals

public boolean equals(java.lang.Object other)

Tests the equality of two XmlDataTags. This test is equivalent to this.getFullName().equals(other.getFullName()). Subclasses may include additional checks. Index and indirect-qualifier are ignored.

Overrides:

equals in class java.lang.Object

nameEquals

public boolean nameEquals(XmlDataTag other)

Compares two XmlDataTags, ignoring the particle-id. This test is equivalent to this.getPartialName().equals(other.getPartialName())

Parameters:

other - the XmlDataTag to compare

Returns:

true if the tags are identical, ignoring particle-id.

pathEquals

public boolean pathEquals(XmlDataTag other)

Returns true only if all components of the tag are identical: ncName, namespace, particle-id, index (if specified), indirect-qualifier (if specified)

Parameters:

other - the other tag

Returns:

true if identical

getFullName

public java.lang.String getFullName()

Creates the String representation of an XMlDataTag from its three components in the {particleId}ncName#namespace. For example, the third particle instance of a tag with ncName "sister" and namespace "family" is {3}sister#family. This is the name as it would appear in the pipeline and does not include an index or a indirect-qualifier.

Returns:

The full name of this tag

getPartialName

public java.lang.String getPartialName()

Returns the full name without the particle-id portion.

Returns:

the full name without the particle-id

toString

public java.lang.String toString()

toString() generally returns the same value as getPathName, but might contain additional debugging information. The result from toString() should never be used as a canonical representation of a path or tag. It is strictly for display and debugging.

Overrides:

toString in class java.lang.Object

Returns:

The String representation

getPathName

public java.lang.String getPathName()

Returns the tag in path-name format. The path-name is the full-name which include particle-id, ncName, and namespace as well as additional properties used by XmlDataMap or XmlDataCopy. The additional properties are index and indirect-qualifier. ualified names are returned in the form ncName#namespace. Index (if defined) is represented as [index] and indirect-qualifiers is represented as {content-tag}. If the namespace uses the path characters '[', ']', or '/', those characters are %-encoded using %2F for /, %5B for [, %5D for ], and %25 for %.

Returns:

a String representation of the path-name

getPathName

public java.lang.String getPathName(XmlNamespaceMap nsDecls)

Returns the tag in path-name form using namespace prefixes. The path-name is the full name with additional properties as it is used by XmlDataMap or XmlDataCopy. Qualified names are returned in the form prefix:ncName. The prefix is defined by the nsDecls argument.

Parameters:

nsDecls - the namespace declarations used to present names in prefixed form

Returns:

the String representation as used in a path.

getPathName

public java.lang.String getPathName(java.lang.String nsPairs)

Returns the tag in path-name form using namespace prefixes. The path-name is the full name with additional properties as it is used by XmlDataMap or XmlDataCopy. The prefix definitions are expressed as a String of space-delimited prefix/URI pairs rather than an XmlNamespaceMap.

Parameters:

nsPairs - prefix/URI pairs

Returns:

the tag in path-name form.