com.wm.xmldata

Class XmlDataConstants

java.lang.Object

com.wm.xmldata.XmlDataConstants

public class XmlDataConstants
extends java.lang.Object

XmlDataConstants provides a collection of shortcuts for the lengthy names used by the XmlData packages. By importing the static members of this class, application code may conveniently use shortcuts rather than the full method names.

For example, instead of coding:

     tag = new XmlDataElementTag("name", "www.xyz.org")
 

one could instead code:

     tag = eTag("name", "www.xyz.org")
 

For example, instead of coding:

     data = new IData[]{
         XmlData.createGroupValue(
             new XmlDataElementTag("one", "xyz.com"), "abc", new XmlDataElementTag("two", "xyz.com"), "def"
         ),
         XmlData.createGroupValue(
             new XmlDataElementTag("one", "xyz.com"), "123", new XmlDataElementTag("two", "xyz.com"), "456"
         )
    };
 

to create a repeating group, one could instead code more compactly and readable:

     data = groups(
         groupValue(eTag("one", "xyz.com"), "abc", eTag("two", "xyz.com"), "def"),
         groupValue(eTag("one", "xyz.com"), "123", eTag("two", "xyz.com"), "456")
     );
 

The shortcuts provided by this fall into three general categories:

• XmlDataTag constructors:
  • eTag(String) -- create element-tags
  • gTag() -- create group-tags
  • aTag(String) -- create attributes-tags
  • sTag(String) -- create substitution-tags
  • anyTag() -- create any-tags
  • iTag(String) -- create iteratorTags
  • tTag(String) -- create type-tags
• Parsers that can decompose a full-name or a path-name into its component parts. These methods create an appropriate XmlDataTag instance created from the full-name or path-name. The component parts can be retrieved using accessors of the returned XmlDataTag instance.
  • eTagName(String)
  • aTagName(String)
  • gTagName(String)
  • sTagName(String)
  • aTagName(String)
  • iTagName(String)
  • tTagName(String)
• XmlData infoset item constructors:
  • groupValue(Object...) -- construct a group-value from a list of tags and values
  • groups(IData...) -- construct an array of group-values from a list of group-values
  • strings(String...) -- construct an array of simple-value Strings
  • objects(Object...) -- create an array of Objects from a list of Objects
  • attributes(Object...) -- create an attribute-set from a list of key value pairs
  • complexValue() -- create a complex-value using a group or simple value and an attribute-set
  • xCursor(IData) -- obtain an XmlDataCursor
  • xTreeCursor(IData) -- obtain an XmlDataTreeCursor
• Utility methods:
  • nsMap(String) -- create an XmlNamespaceMap from prefix/URI pairs

Constructor Summary

Constructors

Constructor and Description
XmlDataConstants()

Method Summary

Modifier and Type	Method and Description
static XmlDataAnyTag	anyTag() Creates an XmlDataAnyTag with a default particle-id of 1.
static XmlDataAnyTag	anyTag(int particleId) Creates an XmlDataAnyTag with the specified particle-id.
static XmlDataAnyTag	anyTag(int particleId, int index) Creates an XmlDataAnyTag with the specified particle-id and index.
static XmlDataAnyTag	anyTag(int particleId, int index, XmlDataElementTag contentTag) Creates an XmlDataAnyTag with the specified particle-id, index, and associated content tag specified as an XmlDataElementTag.
static XmlDataAnyTag	anyTag(int particleId, int index, XmlDataIteratorTag qualifierIterator) Creates an XmlDataAnyTag with an iterator-tag as the indirect-qualifier.
static XmlDataAnyTag	anyTag(int particleId, int index, XmlDataSubstitutionTag contentTag) Creates an XmlDataAnyTag with the specified particle-id, index, and substitution content tag.
static XmlDataAnyTag	anyTag(int particleId, XmlDataIteratorTag indexIterator, XmlDataIteratorTag qualifierIterator) Creates an XmlDataAnyTag with an iterator-tag for the index abd the indirect-qualifier.
static XmlDataAnyTag	anyTag(XmlDataElementTag contentTag) Creates an XmlDataAnyTag with an associated content tag specified as an XmlDataElementTag.
static XmlDataAnyTag	anyTag(XmlDataSubstitutionTag contentTag) Creates an XmlDataAnyTag with the a substitution content tag.
static XmlDataAttributeTag	aTag(java.lang.String ncName) Creates an XmlDataAttributeTag with the specified local name.
static XmlDataAttributeTag	aTag(java.lang.String ncName, java.lang.String namespace) Creates an XmlDataAttributeTag from the specified local name and namespace URI.
static XmlDataAttributeTag	aTagName(java.lang.String fullName) Creates an XmlDatAttributeTag from the full name.
static XmlDataAttributeTag	aTagName(java.lang.String fullName, java.lang.String pairs) Creates an XmlDataAttributeTag from its String representation using a prefix and a String containing prefix/namespace pairs.
static XmlDataAttributeTag	aTagName(java.lang.String fullName, XmlNamespaceMap nsDecls) Creates an XmlDataAttributeTag from its String representation using a prefix and an XmlNamespaceMap.
static IData	attributes(java.lang.Object... pairs) Creates the attributes set from a list of tags and values.
static IData	complexValue() Creates an empty complex-value
static IData	complexValue(IData attribute, java.lang.Object content) Creates a complex-value containing the specified attribute-set and complex-content.
static XmlDataElementTag	eTag(java.lang.String ncName) Creates an XmlDataElementTag with the specified local name.
static XmlDataElementTag	eTag(java.lang.String ncName, int particleId) Creates an XmlDataElementTag with the specified local name and particle-id.
static XmlDataElementTag	eTag(java.lang.String ncName, java.lang.String namespace) Creates an XmlDataElementTag with the specified local name and namespace.
static XmlDataElementTag	eTag(java.lang.String ncName, java.lang.String namespace, int particleId) Creates an XmlDataElementTag with the specified local name, namespace URI, and particle-id.
static XmlDataElementTag	eTag(java.lang.String ncName, java.lang.String namespace, int particleId, int index) Creates an XmlDataElementTag with the specified local name, namespace URI, particle-id, and index.
static XmlDataElementTag	eTag(java.lang.String ncName, java.lang.String namespace, int particleId, XmlDataIteratorTag iterator) Creates an XmlDataElementTag with the specified local name, namespace URI, particle-id, and iterator-tag.
static XmlDataElementTag	eTagName(java.lang.String fullName) Creates an XmlDataElementTag from its full name.
static XmlDataElementTag	eTagName(java.lang.String pathName, java.lang.String nsPairs) Creates an XmlDataElementTag from it String representation.
static XmlDataElementTag	eTagName(java.lang.String fullName, XmlNamespaceMap nsDecls) Creates an element-tag from a String, using the specified namespace map to resolves prefixes.
static IData[]	groups(IData... groups) Creates an IData[] from the list of group-values.
static IData	groupValue(java.lang.Object... items) Creates a group-value from pairs of content-tags and values.
static XmlDataGroupTag	gTag() Creates an XmlDataGroup tag with default particle-id of 1.
static XmlDataGroupTag	gTag(int particleId) Creates an XmlDataGroupTag with the specified particle-id.
static XmlDataGroupTag	gTag(int particleId, int index) Creates an XmlDataGroupTag with the specified particle-id and index.
static XmlDataGroupTag	gTagName(java.lang.String fullName) Creates an XmlDataGroupTag from its full String name.
static XmlDataIteratorTag	iTag(java.lang.String name) Creates an XmlDataIteratorTag with the specified name.
static XmlDataIteratorTag	iTag(java.lang.String name, int index) Creates an XmlDataIteratorTag with the specified name and index.
static XmlDataIteratorTag	iTag(java.lang.String name, int index, XmlDataContentTag indirectQualifier) Creates an XmlDataIteratorTag with the specified index and indirect-qualifier.
static XmlDataIteratorTag	iTag(java.lang.String name, XmlDataIteratorTag iter) Creates an XmlDataIteratorTag with the specified name and iterator index.
static XmlDataIteratorTag	iTag(java.lang.String name, XmlDataIteratorTag indexIterator, XmlDataContentTag indirectQualifier) Creates an XmlDataIteratorTag with the specified index iterator-tag and indirect-qualifier.
static XmlDataIteratorTag	iTagName(java.lang.String fullName) Creates an XmlDataIteratorTag from the String representation.
static XmlNamespaceMap	nsMap(java.lang.String pairs) Creates an XmlNamespaceMap from a String that contains prefix namespace pairs, separated by spaces.
static XmlNamespaceMap	nsMap(java.lang.String[] pairs) Creates an XmlNamespaceMap from a String that contains prefix namespace pairs, separated by spaces.
static java.lang.Object[]	objects(java.lang.Object... objects) Creates an Object[] from the list of Objects.
static XmlDataSubstitutionTag	sTag(java.lang.String ncName) Creates an XmlDataSubstitutionTag for the head of group with the specified local name part.
static XmlDataSubstitutionTag	sTag(java.lang.String ncName, java.lang.String namespace) Creates an XmlDataSubstitutionTag for head of group with the specified local name and namespace URI.
static XmlDataSubstitutionTag	sTag(java.lang.String ncName, java.lang.String namespace, int particleId) Creates an XmlDataSubstitutionTag for head of group with the specified local name, namespace URI, and particle-id.
static XmlDataSubstitutionTag	sTag(java.lang.String ncName, java.lang.String namespace, int particleId, int index) Creates an XmlDataSubstitutionTag for head of group with the specified local name, namespace URI, particle-id, and index.
static XmlDataSubstitutionTag	sTag(java.lang.String ncName, java.lang.String namespace, int partcleId, XmlDataIteratorTag iter) Creates a substitution-tag with the specified NCName, namespace, particle-id, and index iterator-tag.
static XmlDataSubstitutionTag	sTag(XmlDataElementTag eTag) Creates an XmlDataSubstitutionTag for the head of group from the properties extracted from the specified XmlDataElementTag.
static XmlDataSubstitutionTag	sTag(XmlDataElementTag eTag, XmlDataElementTag valueTag) Creates an XmlDataSubstitutionTag head with properties extracted from the specified XmlDataElementTag and provide a qualifying content tag using the specified XmlDataElementTag
static XmlDataSubstitutionTag	sTag(XmlDataElementTag eTag, XmlDataIteratorTag qualifierIterator) Creates an XmlDataSubstitutionTag head with properties extracted from the specified XmlDataElementTag and provide an indirect-qualifier using an iterator-tag.
static XmlDataSubstitutionTag	sTagName(java.lang.String fullName) Creates an XmlDataSubstitutionTag from its String full name form.
static XmlDataSubstitutionTag	sTagName(java.lang.String fullName, java.lang.String nsPairs) Creates an XmlDataSubstitutionTag from its String form using prefix notation with the namespace map expressed as a String of prefix/URI pairs.
static XmlDataSubstitutionTag	sTagName(java.lang.String fullName, XmlNamespaceMap nsDecls) Creates an XmlDataSubstitutionTag from its String form using prefix notation.
static java.lang.String[]	strings(java.lang.String... strings) Creates a String[] from a list of Strings.
static XmlDataTypeTag	tTag(java.lang.String name) Creates an XmlDataTypeTag with the specified local name.
static XmlDataTypeTag	tTag(java.lang.String name, java.lang.String namespace) Creates an XmlDataTypeTag with the specified local name and namespace URI.
static XmlDataTypeTag	tTagName(java.lang.String fullName) Creates an XmlDataTypeTag from the String representation.
static XmlDataTypeTag	tTagName(java.lang.String fullName, java.lang.String pairs) Creates an XmlDataTypeTag from its String representation using a prefix and a String containing prefix/namespace pairs.
static XmlDataTypeTag	tTagName(java.lang.String fullName, XmlNamespaceMap nsDecls) Creates an XmlDataTypeTag from its String representation using a prefix and an XmlNamespaceMap.
static XmlDataCursor	xCursor(IData data) Obtains an XmlDataCursor on the specified IData.
static XmlDataTreeCursor	xTreeCursor(IData data) Obtains an XmlDataTreeCursor on the specified IData.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlDataConstants

public XmlDataConstants()

Method Detail

complexValue

public static IData complexValue()

Creates an empty complex-value

Returns:

an empty IData

See Also:

"This method is short-cut for:", XmlData.createComplexValue(), "Similar short-cuts:", complexValue(IData, Object)

complexValue

public static IData complexValue(IData attribute,
                                 java.lang.Object content)

Creates a complex-value containing the specified attribute-set and complex-content.

Parameters:

attribute - the IData containing the attribute-tag value pairs. If null, no attribute child is created.

content - the content; must be a simple-value, or a (possibly repeating) group-value; If null, no content is created.

Returns:

a complex-value

See Also:

"This method is short-cut for:", XmlData.createComplexValue(IData, Object)

groupValue

public static IData groupValue(java.lang.Object... items)

Creates a group-value from pairs of content-tags and values.

Parameters:

items - alternating content-tags and values

Returns:

the IData group-value

See Also:

"This method is short-cut for:", XmlData.createGroupValue(Object...)

groups

public static IData[] groups(IData... groups)

Creates an IData[] from the list of group-values.

Parameters:

groups - a list of group values

Returns:

an IData[]

objects

public static java.lang.Object[] objects(java.lang.Object... objects)

Creates an Object[] from the list of Objects.

Parameters:

objects - a list of Objects

Returns:

an Object[]

strings

public static java.lang.String[] strings(java.lang.String... strings)

Creates a String[] from a list of Strings.

Parameters:

strings - a list of Strings

Returns:

String[]

attributes

public static IData attributes(java.lang.Object... pairs)

Creates the attributes set from a list of tags and values.

Parameters:

pairs - alternating pairs of attributes-tags and values

Returns:

IData attributes set

See Also:

"This method is short-cut for:", XmlData.createAttributes(Object...)

nsMap

public static XmlNamespaceMap nsMap(java.lang.String pairs)

Creates an XmlNamespaceMap from a String that contains prefix namespace pairs, separated by spaces.

Parameters:

pairs - space-separated prefix namespace pairs

Returns:

an XmlNamespace

See Also:

XmlNamespaceMap.createFromPairs(String)

xCursor

public static XmlDataCursor xCursor(IData data)

Obtains an XmlDataCursor on the specified IData.

Parameters:

data - the input IData

Returns:

an XmlDataCursor

xTreeCursor

public static XmlDataTreeCursor xTreeCursor(IData data)

Obtains an XmlDataTreeCursor on the specified IData.

Parameters:

data - the input IData

Returns:

an XmlDataTreeCursor

nsMap

public static XmlNamespaceMap nsMap(java.lang.String[] pairs)

Creates an XmlNamespaceMap from a String that contains prefix namespace pairs, separated by spaces.

Parameters:

pairs - an array of Strings with an even number of members

Returns:

an XmlNamespace

See Also:

XmlNamespaceMap.createFromPairs(String)

aTag

public static XmlDataAttributeTag aTag(java.lang.String ncName)

Creates an XmlDataAttributeTag with the specified local name.

Parameters:

ncName - the local name

Returns:

attribute-tag

See Also:

"this method is short-cut for:", XmlDataAttributeTag(String), "Simiar short-cuts:", aTag(String, String)

aTag

public static XmlDataAttributeTag aTag(java.lang.String ncName,
                                       java.lang.String namespace)

Creates an XmlDataAttributeTag from the specified local name and namespace URI.

Parameters:

ncName - (must not be null or empty)

namespace - (null or empty is treated like no namespace)

Returns:

attribute-tag

See Also:

"This method is short-cut for:", XmlDataAttributeTag(String, String)

aTagName

public static XmlDataAttributeTag aTagName(java.lang.String fullName)

Creates an XmlDatAttributeTag from the full name.

Parameters:

fullName - the full name

Returns:

ab attribute-tag

See Also:

"This method is short-cut for:", XmlDataAttributeTag.createFromFullName(String), "Similar short-cuts:", aTagName(String, XmlNamespaceMap)

aTagName

public static XmlDataAttributeTag aTagName(java.lang.String fullName,
                                           XmlNamespaceMap nsDecls)

Creates an XmlDataAttributeTag from its String representation using a prefix and an XmlNamespaceMap.

Parameters:

fullName - the full name using prefix notation

nsDecls - the XmlNamespaceMap containing the prefix definition

Returns:

an XmlDatAttributeTag

See Also:

"This method is short-cut for:", XmlDataAttributeTag.createFromFullName(String, XmlNamespaceMap)

aTagName

public static XmlDataAttributeTag aTagName(java.lang.String fullName,
                                           java.lang.String pairs)

Creates an XmlDataAttributeTag from its String representation using a prefix and a String containing prefix/namespace pairs.

Parameters:

fullName - the full name using prefix notation

pairs - a String containing space-delimited prefix/namespace pairs

Returns:

an XmlDataTypeTag

See Also:

"This method is short-cut for:", XmlDataAttributeTag.createFromFullName(String, String)

eTag

public static XmlDataElementTag eTag(java.lang.String ncName)

Creates an XmlDataElementTag with the specified local name.

Parameters:

ncName - the local name (must not be null or empty)

Returns:

element-tag

See Also:

"This method is short-cut for:", XmlDataElementTag(String), "Similar short-cuts:", eTag(String, int), eTag(String, String), eTag(String, String, int), eTag(String, String, int, int), eTag(String, String, int, XmlDataIteratorTag)

eTag

public static XmlDataElementTag eTag(java.lang.String ncName,
                                     java.lang.String namespace)

Creates an XmlDataElementTag with the specified local name and namespace.

Parameters:

ncName - the local name (must not be null or empty)

namespace - the namespace (a null value or the empty String is treated like no namespace)

Returns:

element-tag

See Also:

"This method is short-cut for:", XmlDataElementTag(String, String)

eTag

public static XmlDataElementTag eTag(java.lang.String ncName,
                                     int particleId)

Creates an XmlDataElementTag with the specified local name and particle-id.

Parameters:

ncName - local name (must not be null or empty)

particleId - the particle-id (must be > 0)

Returns:

element-tag

See Also:

"This method is short-cut for:", XmlDataElementTag(String, int)

eTag

public static XmlDataElementTag eTag(java.lang.String ncName,
                                     java.lang.String namespace,
                                     int particleId)

Creates an XmlDataElementTag with the specified local name, namespace URI, and particle-id.

Parameters:

ncName - the local name (must not be null or empty)

namespace - the namespace (a null value or the empty String is treated like no namespace)

particleId - the particle-id (must be > 0)

Returns:

element-tag

See Also:

"This method is short=cut for:", XmlDataElementTag(String, String, int)

eTag

public static XmlDataElementTag eTag(java.lang.String ncName,
                                     java.lang.String namespace,
                                     int particleId,
                                     int index)

Creates an XmlDataElementTag with the specified local name, namespace URI, particle-id, and index.

Parameters:

ncName - the local name (must not be null or empty)

namespace - the namespace (a null value or the empty String is treated like no namespace)

particleId - the particle-id(must be > 0)

index - (must be >= 0 to specify an index, or -1 to indicate no index)

Returns:

element-tag

See Also:

"This method is short-cut for:", XmlDataElementTag(String, String, int, int)

eTag

public static XmlDataElementTag eTag(java.lang.String ncName,
                                     java.lang.String namespace,
                                     int particleId,
                                     XmlDataIteratorTag iterator)

Creates an XmlDataElementTag with the specified local name, namespace URI, particle-id, and iterator-tag.

Parameters:

ncName - the local name (must not be null or empty)

namespace - the namespace (a null value or the empty String is treated like no namespace)

particleId - the particle-id(must be > 0)

iterator - an index-iterator

Returns:

element-tag

See Also:

"This method is short-cut for:", XmlDataElementTag(boolean, String, XmlDataIteratorTag)

eTagName

public static XmlDataElementTag eTagName(java.lang.String fullName)

Creates an XmlDataElementTag from its full name.

Parameters:

fullName - the full Sting name of the tag; for example {1}xyz#myNamepsace

Returns:

tag

See Also:

"This method is short-cut for:", XmlDataTag.createFromFullName(String), "Similar short-cuts:", eTagName(String, XmlNamespaceMap), eTagName(String, String)

eTagName

public static XmlDataElementTag eTagName(java.lang.String fullName,
                                         XmlNamespaceMap nsDecls)

Creates an element-tag from a String, using the specified namespace map to resolves prefixes.

Parameters:

fullName - the full name

nsDecls - an XmlNamespaceMap containing namespace declarations

Returns:

an element-tag

See Also:

"This method is short-cut for:", XmlDataElementTag.createFromPath(String, String), "Similar short-cuts:", eTagName(String, String)

eTagName

public static XmlDataElementTag eTagName(java.lang.String pathName,
                                         java.lang.String nsPairs)

Creates an XmlDataElementTag from it String representation. Qualified names are expressed using prefixes defined by a space-delimited list of prefix/namespace pairs.

Parameters:

pathName - the String format of an element-tag

nsPairs - the prefix assignments for namespaces

Returns:

the created element-tag

See Also:

"This method is short-cut for:", XmlDataElementTag.createFromPath(String, XmlNamespaceMap)

gTag

public static XmlDataGroupTag gTag()

Creates an XmlDataGroup tag with default particle-id of 1.

Returns:

group-tag

See Also:

"This method is short-cut for:", XmlDataGroupTag(), "Similar shortcuts:", gTag(int), gTag(int, int)

gTag

public static XmlDataGroupTag gTag(int particleId)

Creates an XmlDataGroupTag with the specified particle-id.

Parameters:

particleId - the particle-id (must be > 0)

Returns:

group-tag

See Also:

"This method is short-cut for:", XmlDataGroupTag(int)

gTag

public static XmlDataGroupTag gTag(int particleId,
                                   int index)

Creates an XmlDataGroupTag with the specified particle-id and index.

Parameters:

particleId - the particle-id (must be > 0)

index - index

Returns:

the constructed group-tag

See Also:

"This method is short-cut for:", XmlDataGroupTag(int, int)

gTagName

public static XmlDataGroupTag gTagName(java.lang.String fullName)

Creates an XmlDataGroupTag from its full String name.

Parameters:

fullName - full name

Returns:

tag

See Also:

"This method is short-cut for:", XmlDataGroupTag.createFromPath(String)

anyTag

public static XmlDataAnyTag anyTag()

Creates an XmlDataAnyTag with a default particle-id of 1.

Returns:

any-tag

See Also:

"This method is short-cut for:", XmlDataAnyTag(), "Simi;ar shortcuts:", anyTag(int), anyTag(int, int), anyTag(XmlDataElementTag), anyTag(int, int, XmlDataElementTag), anyTag(XmlDataSubstitutionTag), anyTag(int, int, XmlDataSubstitutionTag), anyTag(int, int, XmlDataIteratorTag), anyTag(int, XmlDataIteratorTag, XmlDataIteratorTag)

anyTag

public static XmlDataAnyTag anyTag(int particleId)

Creates an XmlDataAnyTag with the specified particle-id.

Parameters:

particleId - the particle-id (must be > 0)

Returns:

any-tag

See Also:

"This method is short-cut for:", XmlDataAnyTag(int)

anyTag

public static XmlDataAnyTag anyTag(int particleId,
                                   int index)

Creates an XmlDataAnyTag with the specified particle-id and index.

Parameters:

particleId - the particle-id (must be > 0)

index - (must be >= 0; use -1 for unspecified

Returns:

any-tag

See Also:

"This method is short-cut for:", XmlDataAnyTag(int, int)

anyTag

public static XmlDataAnyTag anyTag(XmlDataElementTag contentTag)

Creates an XmlDataAnyTag with an associated content tag specified as an XmlDataElementTag. The AnyTag has a default particle-id of 1 and no index.

Parameters:

contentTag - the tag associated with the any content

Returns:

any-tag

See Also:

"This method is short-cut for:", XmlDataAnyTag(XmlDataElementTag)

anyTag

public static XmlDataAnyTag anyTag(int particleId,
                                   int index,
                                   XmlDataElementTag contentTag)

Creates an XmlDataAnyTag with the specified particle-id, index, and associated content tag specified as an XmlDataElementTag.

Parameters:

particleId - the particle-id (must be > 0)

index - the index

contentTag - the content-tag

Returns:

any-tag

See Also:

"This method is short-cut for:", XmlDataAnyTag(int, int, XmlDataElementTag)

anyTag

public static XmlDataAnyTag anyTag(XmlDataSubstitutionTag contentTag)

Creates an XmlDataAnyTag with the a substitution content tag. The AnyTag has a default particle-id of 1 and no index.

Parameters:

contentTag - the tag associated with the any-item value

Returns:

any-tag

See Also:

"This method is short-cut for:", XmlDataAnyTag(XmlDataSubstitutionTag)

anyTag

public static XmlDataAnyTag anyTag(int particleId,
                                   int index,
                                   XmlDataSubstitutionTag contentTag)

Creates an XmlDataAnyTag with the specified particle-id, index, and substitution content tag.

Parameters:

particleId - the particle-id (must be > 0)

index - (must be >= 0)

contentTag - tag associated with any-item value

Returns:

any-tag

See Also:

"This method is short-cut for:", XmlDataAnyTag(int, int, XmlDataSubstitutionTag)

anyTag

public static XmlDataAnyTag anyTag(int particleId,
                                   int index,
                                   XmlDataIteratorTag qualifierIterator)

Creates an XmlDataAnyTag with an iterator-tag as the indirect-qualifier.

Parameters:

particleId - the particle-id (must be > 0)

index - the index

qualifierIterator - the indirect-qualifier iterator-tag

Returns:

a constructed any-tag

See Also:

"This method is short-cut for:", XmlDataAnyTag(int, int, XmlDataIteratorTag)

anyTag

public static XmlDataAnyTag anyTag(int particleId,
                                   XmlDataIteratorTag indexIterator,
                                   XmlDataIteratorTag qualifierIterator)

Creates an XmlDataAnyTag with an iterator-tag for the index abd the indirect-qualifier.

Parameters:

particleId - the particle-id (must be > 0)

indexIterator - the index iterator-tag

qualifierIterator - the indirect-qualifier iterator-tag

Returns:

an any-tag

See Also:

"This method is short-cut for:", XmlDataAnyTag(int, XmlDataIteratorTag, XmlDataIteratorTag)

sTag

public static XmlDataSubstitutionTag sTag(java.lang.String ncName)

Creates an XmlDataSubstitutionTag for the head of group with the specified local name part. The tag will be created as {1}*substitution-<ncName>.

Parameters:

ncName - the local name (must not be empty or null)

Returns:

substitution-tag

See Also:

"This method is short-cut for:", XmlDataSubstitutionTag(String), "Similar shortcuts:", sTag(String, String), sTag(String, String, int), sTag(String, String, int, int), sTag(String, String, int, XmlDataIteratorTag), sTag(XmlDataElementTag), sTag(XmlDataElementTag, XmlDataElementTag), sTag(XmlDataElementTag, XmlDataIteratorTag)

sTag

public static XmlDataSubstitutionTag sTag(java.lang.String ncName,
                                          java.lang.String namespace)

Creates an XmlDataSubstitutionTag for head of group with the specified local name and namespace URI. The tag will be created {1}as *substitution-<ncName>#>namespace>

Parameters:

ncName - the local name part of the head (must not be null or empty)

namespace - the namespace part of the head (a null value or the empty String is treated like no namespace)

Returns:

tag

See Also:

"This method is short-cut for:", XmlDataSubstitutionTag(String, String)

sTag

public static XmlDataSubstitutionTag sTag(java.lang.String ncName,
                                          java.lang.String namespace,
                                          int particleId)

Creates an XmlDataSubstitutionTag for head of group with the specified local name, namespace URI, and particle-id. The tag will be created as {id}*substitution-<ncName>#>namespace>

Parameters:

ncName - the local name part of the head (must not be null or empty)

namespace - the namespace part of the head (A null value or the empty String is treated like no namespace.)

particleId - the particle-id (must be > 0)

Returns:

substitution-tag

See Also:

"This method is short-cut for:", XmlDataSubstitutionTag(String, String, int)

sTag

public static XmlDataSubstitutionTag sTag(java.lang.String ncName,
                                          java.lang.String namespace,
                                          int particleId,
                                          int index)

Creates an XmlDataSubstitutionTag for head of group with the specified local name, namespace URI, particle-id, and index. The tag will be created as {id}*substitution-<ncName>#>namespace>

Parameters:

ncName - the local name part of the head (must not be null or empty)

namespace - the namespace part of the head (A null value or the empty String is treated like no namespace.)

particleId - the particle-id (must be > 0)

index - must be >= 0 to specify an index; -1 for unspecified

Returns:

substitution-tag

See Also:

"This method is short-cut for:", XmlDataSubstitutionTag(String, String, int, int)

sTag

public static XmlDataSubstitutionTag sTag(java.lang.String ncName,
                                          java.lang.String namespace,
                                          int partcleId,
                                          XmlDataIteratorTag iter)

Creates a substitution-tag with the specified NCName, namespace, particle-id, and index iterator-tag.

Parameters:

ncName - the ncName

namespace - the XML namespace

partcleId - the particle-id (must be > 0)

iter - the index iterator-tag

Returns:

the constructed substitution-tag

See Also:

"This method is short-cut for:", XmlDataSubstitutionTag(String, String, int, XmlDataIteratorTag)

sTag

public static XmlDataSubstitutionTag sTag(XmlDataElementTag eTag)

Creates an XmlDataSubstitutionTag for the head of group from the properties extracted from the specified XmlDataElementTag.

Parameters:

eTag - the element-tag from which local name, namespace, particle-id, and index are extracted.

Returns:

constructed substitution-tag

See Also:

"This method is short-cut for:", XmlDataSubstitutionTag(XmlDataElementTag)

sTag

public static XmlDataSubstitutionTag sTag(XmlDataElementTag eTag,
                                          XmlDataElementTag valueTag)

Creates an XmlDataSubstitutionTag head with properties extracted from the specified XmlDataElementTag and provide a qualifying content tag using the specified XmlDataElementTag

Parameters:

eTag - the XmlDataElementTag used as the pattern for the head of group

valueTag - the tag for the substitution-item value

Returns:

substitution-tag

See Also:

"This method is short-cut for:", XmlDataSubstitutionTag(XmlDataElementTag, XmlDataElementTag)

sTag

public static XmlDataSubstitutionTag sTag(XmlDataElementTag eTag,
                                          XmlDataIteratorTag qualifierIterator)

Creates an XmlDataSubstitutionTag head with properties extracted from the specified XmlDataElementTag and provide an indirect-qualifier using an iterator-tag. using the specified XmlDataElementTag

Parameters:

eTag - the element-tag from which ncName, namespace, particle-id, and index or index iterator-tag are extracted

qualifierIterator - the indirect-qualifier specified as an iterator-tag

Returns:

the constructed substitution-tag

See Also:

"This method is short-cut for:", XmlDataSubstitutionTag(XmlDataElementTag, XmlDataIteratorTag)

sTagName

public static XmlDataSubstitutionTag sTagName(java.lang.String fullName)

Creates an XmlDataSubstitutionTag from its String full name form.

Parameters:

fullName - the full name of the substitution tag

Returns:

substitution-tag

See Also:

"This method is short-cut for:", XmlDataSubstitutionTag.createFromPath(String), "Similar short-cuts:", sTagName(String, String), sTagName(String, XmlNamespaceMap)

sTagName

public static XmlDataSubstitutionTag sTagName(java.lang.String fullName,
                                              XmlNamespaceMap nsDecls)

Creates an XmlDataSubstitutionTag from its String form using prefix notation.

Parameters:

fullName - the String from of the tag

nsDecls - the XmlNamespaceMap containing teh prefix definitions

Returns:

the constructed substitution-tag

See Also:

"This method is short-cut for:", XmlDataSubstitutionTag.createFromPath(String, XmlNamespaceMap)

sTagName

public static XmlDataSubstitutionTag sTagName(java.lang.String fullName,
                                              java.lang.String nsPairs)

Creates an XmlDataSubstitutionTag from its String form using prefix notation with the namespace map expressed as a String of prefix/URI pairs.

Parameters:

fullName - the String form

nsPairs - the namespace map expressed as a String of pairs

Returns:

the constructed substitution-tag.

See Also:

"This method is short-cut for:", XmlDataSubstitutionTag(String, String)

iTag

public static XmlDataIteratorTag iTag(java.lang.String name)

Creates an XmlDataIteratorTag with the specified name.

Parameters:

name - the symbolic name of the iterator

Returns:

iterator-tag

See Also:

"This method is short-cut for:", XmlDataIteratorTag(String), "Similar short-cuts:", iTag(String, int), iTag(String, int, XmlDataContentTag), iTag(String, XmlDataIteratorTag, XmlDataContentTag)

iTag

public static XmlDataIteratorTag iTag(java.lang.String name,
                                      int index)

Creates an XmlDataIteratorTag with the specified name and index.

Parameters:

name - the symbolic name (must start with the ! character)

index - the numeric index

Returns:

constructed iterator-tag

See Also:

"This method is short-cut for:", XmlDataIteratorTag(String, int)

iTag

public static XmlDataIteratorTag iTag(java.lang.String name,
                                      XmlDataIteratorTag iter)

Creates an XmlDataIteratorTag with the specified name and iterator index.

Parameters:

name - the iterator-tag name

iter - the iterator-tag index iterator

Returns:

the constructed iterator-tag

See Also:

"This method is short-cut for:", XmlDataIteratorTag(String, XmlDataIteratorTag)

iTag

public static XmlDataIteratorTag iTag(java.lang.String name,
                                      int index,
                                      XmlDataContentTag indirectQualifier)

Creates an XmlDataIteratorTag with the specified index and indirect-qualifier.

Parameters:

name - the symbolic name of the iterator-tag

index - the numeric index

indirectQualifier - the indirect-qualifier

Returns:

the constructed iterator-tag

See Also:

"This method is short-cut for:", XmlDataIteratorTag(String, int, XmlDataContentTag)

iTag

public static XmlDataIteratorTag iTag(java.lang.String name,
                                      XmlDataIteratorTag indexIterator,
                                      XmlDataContentTag indirectQualifier)

Creates an XmlDataIteratorTag with the specified index iterator-tag and indirect-qualifier.

Parameters:

name - the symbolic name of the iterator-tag

indexIterator - the iterator-tag index

indirectQualifier - the indirect-qualifier iterator-tag

Returns:

the constructed XmlDataIteratorTag

See Also:

"This method is short-cut for:", XmlDataIteratorTag(String, XmlDataIteratorTag, XmlDataContentTag)

iTagName

public static XmlDataIteratorTag iTagName(java.lang.String fullName)

Creates an XmlDataIteratorTag from the String representation.

Parameters:

fullName - the full name; e.g. {1}!xyz. Generally the particle-id is irrelevant and is present only to satisfy the requirement of a content-tag.

Returns:

iterator-tag

See Also:

"This method is short-cut for:", XmlDataIteratorTag.createFromPath(String)

tTag

public static XmlDataTypeTag tTag(java.lang.String name)

Creates an XmlDataTypeTag with the specified local name.

Parameters:

name - the local name of the Type (must not be null or empty)

Returns:

type-tag

See Also:

"This method is short-cut for:", XmlDataTypeTag(String), "similar short-cuts:", tTag(String, String)

tTag

public static XmlDataTypeTag tTag(java.lang.String name,
                                  java.lang.String namespace)

Creates an XmlDataTypeTag with the specified local name and namespace URI.

Parameters:

name - the local name of the Type

namespace - the namespace URI (a null or empty String is treated like no namespace)

Returns:

type-tag

See Also:

"This method is short-cut for:", XmlDataTypeTag(String, String)

tTagName

public static XmlDataTypeTag tTagName(java.lang.String fullName)

Creates an XmlDataTypeTag from the String representation.

Parameters:

fullName - the full name

Returns:

type-tag

See Also:

"This method is short-cut for:", XmlDataTypeTag.createFromFullName(String), "similar short-cuts:", tTagName(String, XmlNamespaceMap), tTagName(String, String)

tTagName

public static XmlDataTypeTag tTagName(java.lang.String fullName,
                                      XmlNamespaceMap nsDecls)

Creates an XmlDataTypeTag from its String representation using a prefix and an XmlNamespaceMap.

Parameters:

fullName - the full name using prefix notation

nsDecls - the XmlNamespaceMap containing the prefix definition

Returns:

an XmlDataTypeTag

See Also:

"This method is short-cut for:", XmlDataTypeTag.createFromFullName(String, XmlNamespaceMap)

tTagName

public static XmlDataTypeTag tTagName(java.lang.String fullName,
                                      java.lang.String pairs)

Creates an XmlDataTypeTag from its String representation using a prefix and a String containing prefix/namespace pairs.

Parameters:

fullName - the full name using prefix notation

pairs - a String containing space-delimited prefix/namespace pairs

Returns:

an XmlDataTypeTag

See Also:

"This method is short-cut for:", XmlDataTypeTag.createFromFullName(String, String)