com.wm.data.obsolete

Interface XmlDataCursor

public interface XmlDataCursor

This class contains the 9.10 version of the com.wm.data.XmlDataCursor class. In Integration Server version 9.12 and higher, the com.wm.data.XmlData and com.wm.data.XmlDataCursor have been revised and simplified. If you have any existing Java classes that use the 9.10 version of this class, you must modify your Java classes to either use new APIs introduced in com.wm.data.XmlData or change the Java imports in to reference the 9.10 version of the class which is now contained in com.wm.data.obsolete.XmlData. Software AG strongly recommends that existing applications be retrofitted to use the revised com.wm.data.XMLData class available in 9.12 and higher.

However, if you do not want to retrofit, to support any existing code that uses the 9.10 version of com.wm.data.XMLData, alter Java imports to reference the 9.10 definition. Specifically, change:

import com.wm.data.XmlData ---> to ---> import com.wm.data.obsolete.XmlData

import com.wm.data.XmlDataCursor ---> to ---> import com.wm.data.obsolete.XmlDataCursor

Software AG maintains this version for compatibility purposes only. Software AG will not provide fixes for this version.

Summary of difference between the 9.10 version of the com.wm.data.XmlDataCursor class and the 9.12 and higher version of the com.wm.data.XmlDataCursor class:

• The setObject() and getObject() methods no longer support an index. They set or get the entire value at the current position (which is an array in the case of repeating values). A new method, deleteObject() is used to delete the entire object at the current cursor position. Therefore, setObject(), getObject(), and the new deleteObject() methods are meant primarily for manipulating an entire repeating value aggregate (repeating values are always stored as arrays). This change make a clearer distinction between working with aggregates of repeating values and single values.
The new methods get() and set() along with delete() are meant to be used only on scalar items. When referencing repeating values, an index must be supplied. It is an error to pass an array as an argument to set() or expect an array as the result of get(). It is also an error if more than one repeating value is present and no index is specified. An index of 0 may be specified for a scalar and the index may be omitted if an array contains only one item. This allows an array of size 1 and a scalar to be treated identically.
• This change make a clearer distinction between working with aggregates of repeating values and single values.
The getCopy() method has been renamed to copyCursor(). A new method, newCursor(), creates an XMlDataCursor using the same factory used to create this cursor.
• A new option 'recast' is enabled via the recast() method and queried via the isRecast() method. Recast causes String[]s and IData[]s arrays to be recreated as Object[]s when incompatible values are assigned. If recast is not enabled, it is an error to assign String values to an IData[] or an IData to a String[].
• The getValue(), getValueKey(), setValue(), and setValuekey() methods have been enhanced to work whether the current key is an element, any, or substitution key. In the original implementation, it was necessary for the user to explicitly handle each of these key types in a different manner, which required detailed knowledge of the XmlData structure.
• New methods setNamespaceDecl(), getNamepsaceDecl(), setInstanceProp(), getInstanceProp(), and getNamespaceDecls() allow these metadata attributes to be queried or set using the current cursor position.
• The insertValueBefore() and insertValueAfter() methods have been renamed to simply insertBefore() and insertAfter(). This naming makes it clearer that insert is working with a raw object that must conform to the current key (whereas the value methods adapt their behaviors to be compatible with the current key).

XmlDataCursor defines the behavior for manipulating XmlData element content. There is only one implementation of this interface. The XmlData concrete class is used to obtain an XmlDataCursor on an IData object.

The XMlDataCursor allows a program to iterate over the element content of an XmlData-formatted IData document. The content of XmlData-formated IData is a collection of key/value pairs. The key has a very specialized format. The key is comprised of several components: a particle ID, a local name, and an optional namespace. There are four different types of keys: element tags, wildcard (any) tags, group tags, and substitution tags. On a historical note, the legacy form of IData encoding for XML only had element tags. The values also have specialized structure. Element tags have either IData or String values which represent either simple or complex content. Wildcard (any) tags has special any object contents which in turn contain the name and actual value. This indirect representation allows Flow Maps to manipulate wildcard content. Substitution tags also have a specialized structure. They contain a substitution object which is an IData containing the actual key/value pair. Group tags contain nested complex content that mirrors the model groups of schema. Groups always contain an IData (or IData[] for repeating values).

Retrieving and updating the content of XmlData content is very similar to that of the legacy approach, but rather than obtaining an IDataCursor, the XmlData class is used to obtain an XmlDataCursor on an IData object. The XmlDataCursor is used to navigate through the element content. Navigation using XnlDataCursor is much more structured and constrained than using the legacy IDataCursor.

There are three different ways of accessing the content of the XmlDataCursor: object, value, or content. The getObject() and setObject() methods directly access the content associated with the key. For example, when an any object is present, getObject() returns the any object. On the other hand. getValue() returns the value referenced by the any object. In a similar way, getKey() returns the actual key (which would be the *any tag), while getValueKey() returns the key stored on the any object. While getValue() returns the fully element content (which includes the attributes), getContent() returns only the content content portion of the item. This will always be either a String (from simple content) or an IData (for complex content).

Attributes are also accessed through the XMlDataCursor. However, unlike the legacy IData structure, XmlData stores attributes separately from the element content. The attributes are not accessible as "peers" of the elements. Instead, there are explicit methods to get and set attributes values for the element at the current cursor position.

See Also:

XmlData

Method Summary

Modifier and Type	Method and Description
int	count() Returns the number of values stored at the current cursor position.
boolean	delete(int... index) Removes the current item (key and value) from the content.
void	destroy() Release any resources associated with the current cursor.
boolean	first() Positions the cursor at the first item.
boolean	first(XmlDataContentTag key) Position the cursor on the first occurrence of the specified tag and return true.
XmlDataAttributeTag[]	getAttributeNames(int... index) Returns a list of attribute names for the current element.
IData	getAttributes(int... index) Returns an IData list of attributes and values at the current cursor location.
java.lang.String	getAttributeValue(XmlDataAttributeTag attribute, int... index) Returns the value of an attribute for the current item.
java.lang.Object	getContent(int... index) Returns the content associated with the current item.
XmlDataCursor	getCopy()
XmlDataContentTag	getKey() Returns the key of the content item.
java.lang.Object	getObject(int... index) Returns the value stored at the cursor.
java.lang.Object	getValue(int... index) Returns the value of the object at the current cursor position.
XmlDataElementTag	getValueKey(int... index) Returns the key associated with the current item.
boolean	hasAttributes(int... index) Determines if the current entry has attributes.
void	home() The cursor becomes unpositioned as if newly created.
void	insertAfter(XmlDataContentTag tag, java.lang.Object value) A content item (a key and value pair) is inserted into the content after the current cursor position.
void	insertBefore(XmlDataContentTag tag, java.lang.Object value) A content item (a key and value pair) is inserted into the content before the current cursor position.
void	insertValueAfter(java.lang.Object value, int index) Inserts a repeating value for the current key in the array of recurring values after the specified index.
void	insertValueBefore(java.lang.Object value, int index) Inserts a repeating value for the current key in the array of repeating values before the specified index.
boolean	isAny() Determines if the cursor is positioned on an element wildcard item
boolean	isGroup() Determines if the cursor is positioned on a Group item
boolean	isHome() Indicates whether the cursor is unpositioned.
boolean	isRepeating() Indicates if the current item is a repeating key.
boolean	isSubstitution() Determines if the cursor is positioned on a Substitution head item
boolean	last() Positions the cursor at the last item.
boolean	last(XmlDataContentTag key) Position the cursor on the last occurrence of the specified tag and return true.
boolean	next() Positions the cursor on the next content item.
boolean	next(XmlDataContentTag key) Position the cursor on the next occurrence of the specified tag and return true.
boolean	previous() Positions the cursor on the previous item.
boolean	previous(XmlDataContentTag key) Position the cursor on the previous occurrence of the specified tag and return true.
boolean	removeAttribute(XmlDataAttributeTag attribute, int... index) Removes the specified attribute from the current element.
void	setAttributes(IData attributes, int... index)
void	setAttributeValue(XmlDataAttributeTag attribute, java.lang.String value, int... index) Sets the value for the specified attribute.
void	setContent(java.lang.Object data, int... index) Replace the value of the current element while preserving any original associated attributes.
void	setKey(XmlDataContentTag tag) Sets the key of the current content item.
void	setObject(java.lang.Object object, int... index) Set the object stored at the current cursor position.
void	setValue(java.lang.Object object, int... index) Sets the value stored at the current cursor.
void	setValueKey(XmlDataContentTag key, int... index) Sets the key of the value of the current cursor.

Method Detail

count

int count()

Returns the number of values stored at the current cursor position. For a key with repeating values (for example, an array value), the length of the array is returned. For a non-repeating key, 1 is returned. if the cursor is unpositioned, 0 is returned.

Returns:

number of values held by the current item.

delete

boolean delete(int... index)

Removes the current item (key and value) from the content. If an item contains repeating content (the content is an array), the item specified by the index is removed. An index of -1 removes the last item. if no index is specified, the key and entire array are removed. If there is only one remaining item in the array, the entire item is removed (key and array; no empty arrays are maintained)

Parameters:

index - - optional offset into the array if repeating content is present

Returns:

true if cursor is positioned on the next item after deletion

Throws:

XmlDataException.UnpositionedCursor - - when cursor is not positioned

XmlDataException.IndexOutOfRange - - when index exceeds number of repeating values

destroy

void destroy()

Release any resources associated with the current cursor. The cursor becomes unpositioned and no longer has any content.

first

boolean first()

Positions the cursor at the first item. Items are either elements, element wildcards, groups, or substitution heads. If there is no first item, the cursor remains unpositioned.

Returns:

true if there is a first item

first

boolean first(XmlDataContentTag key)

Position the cursor on the first occurrence of the specified tag and return true. Otherwise return false and leave the cursor unpositioned. For purpose of first(), the particle IDs of the input key content items are ignored so as to find the first occurrence regardless of its particle Id. It is as if the first() method is invoked and then the next() method is invoked until the condition key.getPartialName().equals(cursor.getKey().getPartialName()) is satisfied.

Parameters:

key - - the XmlDataContentTag to be searched

Returns:

true if item is found

getAttributeNames

XmlDataAttributeTag[] getAttributeNames(int... index)

Returns a list of attribute names for the current element. I the current elemnt has repeating content, it is necessary to specify an index to select a specific member of the array

Parameters:

index - - offset into the repeating content array (if repeating content is present)

Returns:

An array of XmlDataAttributeTgas, null if no attributes present

Throws:

XmlDataException.UnpositionedCursor - - when cursor is not positioned

XmlDataException.IndexOutOfRange - - when index exceeds number of repeating values

XmlDataException.IndexRequired - - when an index is not specified and repeating values are present

getAttributes

IData getAttributes(int... index)

Returns an IData list of attributes and values at the current cursor location. This is the content of the *attributes child. If the current item is not complex content, or does not have *attributes child. a null is returned.

Parameters:

index - - the offset of the item if repeating values are present

Returns:

An IData object containing the attributes.

getAttributeValue

java.lang.String getAttributeValue(XmlDataAttributeTag attribute,
                                   int... index)

Returns the value of an attribute for the current item. It is an error if the cursor is unpositioned. It is an error if an element has repeating values and no index is specified. If the attribute is not defined, null is returned

Parameters:

attribute - - the key of the attribute XmlDataAttributeTag)

index - - offset into the list of repeating values (starting at 0)

Returns:

null if attribute not present. May return empty String if attribute has that value.

Throws:

XmlDataException.UnpositionedCursor - - when cursor is not positioned

XmlDataException.IndexOutOfRange - - when index exceeds number of repeating values

XmlDataException.IndexRequired - - when an index is not specified and repeating values are present

getContent

java.lang.Object getContent(int... index)

Returns the content associated with the current item. If repeating values are present, an index must be specified. This method may be thought of as logical operator that returns the content of the current cursor position regardless of the format )complex content, group content, or simple content) .

For an element, content is one of:

• the simple String content directly associated with the key
• When there are no attributes or top-level groups, the IData content directly associated with the key
• when attributes are present, the String content associated with the *simple key
• the attributes are present, the highest level *group Document.

In other words, content always excludes any structure that might contain the *attributes Document.

Parameters:

index - - the index of the repeating value

Returns:

the contentObject

Throws:

XmlDataException.UnpositionedCursor - - when cursor is not positioned

XmlDataException.IndexRequired - - when an index is not specified and repeating values are present

XmlDataException.IndexOutOfRange - - when index exceeds number of repeating values

getCopy

XmlDataCursor getCopy()

Returns:

a copy of the cursor

getKey

XmlDataContentTag getKey()

Returns the key of the content item. The key will be either an XmlDataElementTag, an XmlDataAnyTag, an XmlDataGroupTag, or an XmlDataSubstitutionTag. An exception is thrown if the cursor is not positioned.

Returns:

One of the XmlDataContentTags mentioned above.

Throws:

XmlDataException.UnpositionedCursor - - when cursor is not positioned

getObject

java.lang.Object getObject(int... index)

Returns the value stored at the cursor. It is an error if the cursor is not positioned. If no index is specified, the full value is returned, which may be an array if repeating values are present. If an index is specified, the content at that offset in the array is returned. It is an error if index exceeds the number of items present. An index of -1 is equal to the index of the last repeating value. If the value is a scalar and index of 0 or -1 is specified, the value is returned; otherwise it is an error to specify an index for a scalar value. Empty values should always be represented as empty Strings or empty IDatas. Normally, getValue() will return a String, String[], IData, IData[], or Object[]. It will return a null only when an array has been enlarged by a setting a value with an index larger than the current length. In that one situation, the skipped entries are Java null.

Parameters:

index - - the index of the repeating value

Returns:

the requested value

Throws:

XmlDataException.UnpositionedCursor - - when cursor is not positioned

XmlDataException.IndexOutOfRange - - when index exceeds number of repeating values

getValue

java.lang.Object getValue(int... index)

Returns the value of the object at the current cursor position. For items with keys other than XmlDataAnyTag pr XmlDataSubstitutionTag, this method returns the same result as getObject(). For XmlDataSubstitutionTags, the object of the substituted child is returned. For XmlDataAnyTags, the object stored in the *content field is returned. In general terms, getObject() can be though of as returning the physical content at a position, while getValue() returns the logical content (it essentially evaluates the *any or *substitution object to determine the value it contains. Most application programmers will find it simpler to use getValue() and setValue() rather than getObjec() and setObject(). GetObject() and setObject() are used when detailed knowledge of the instance data is needed.

Parameters:

index - - the offset into repeating content

Returns:

The value stored at the current cursor position. It will be either complex content, group content, or a simple string.

getValueKey

XmlDataElementTag getValueKey(int... index)

Returns the key associated with the current item. If the current item is an element or a group, the current item key is returned. The behavior is the same as that of getKey(). If the current item is an element wildcard, an XmlDataElemntTag is constructed from the ncname and namespace fields of the any content. If the current item is a substitution head, the XmlDataElementTag of the first and only content child is returned. If the content is repeating, the index is used to select a particular member of the array of repeating values.

Parameters:

index - - the index of the repeating value

Returns:

an instance of a subclass of XmlDataTag

Throws:

XmlDataException.UnpositionedCursor - - when cursor is not positioned

XmlDataException.IndexRequired - - when an index is not specified and repeating values are present

XmlDataException.IndexOutOfRange - - when index exceeds number of repeating values

hasAttributes

boolean hasAttributes(int... index)

Determines if the current entry has attributes. If an index is not specified and the current item has repeating values, true is returned if any of the values has attributes. If an index is specified, true is returned if the specified member has attributes.

Parameters:

index - - the index of the repeating value

Returns:

true if any member of the value has attributes, or the specified index member has attributes.

Throws:

XmlDataException.UnpositionedCursor - - when cursor is not positioned

XmlDataException.IndexOutOfRange - - when index exceeds number of repeating values

home

void home()

The cursor becomes unpositioned as if newly created.

insertAfter

void insertAfter(XmlDataContentTag tag,
                 java.lang.Object value)

A content item (a key and value pair) is inserted into the content after the current cursor position. The tag and contnet must be compatible.

Parameters:

tag - - the key of the key/value pair to be inserted after the current cursor position

value - - the value (must be String, String[], IData, IData[], or Object[])

insertBefore

void insertBefore(XmlDataContentTag tag,
                  java.lang.Object value)

A content item (a key and value pair) is inserted into the content before the current cursor position. The tag and contnet must be compatible.

Parameters:

tag - - the key of the key/value pair to be inserted before the current cursor position

value - - the value (must be String, String[], IData, IData[], or Object[])

insertValueAfter

void insertValueAfter(java.lang.Object value,
                      int index)

Inserts a repeating value for the current key in the array of recurring values after the specified index. An index of -1 causes the item to be appended to the end of the array. Otherwise, the index must be a number between 0 and the length of the array minus 1.

Parameters:

index - The insert position after which the item is inserted)

value - the value inserted (must be String or IData)

Throws:

XmlDataException.UnpositionedCursor - - when cursor is not positioned

XmlDataException.IndexOutOfRange - - when index exceeds number of repeating values

XmlDataException.UnsupportedType - - value is not a String or IData

insertValueBefore

void insertValueBefore(java.lang.Object value,
                       int index)

Inserts a repeating value for the current key in the array of repeating values before the specified index. An index == array.lenhth adds to end. AN index of -1 inserted the vaues before the last value.

Parameters:

index - - the index position before which the value is inserted

value - - he value inserted (must be STring or IData)

Throws:

XmlDataException.UnpositionedCursor - - when cursor is not positioned

XmlDataException.IndexOutOfRange - - when index exceeds number of repeating values

XmlDataException.UnsupportedType - - when value is not String or IData

isAny

boolean isAny()

Determines if the cursor is positioned on an element wildcard item

Returns:

true if the current item has an XmlDataAnyTag key

Throws:

XmlDataException.UnpositionedCursor - - when cursor is not positioned

isGroup

boolean isGroup()

Determines if the cursor is positioned on a Group item

Returns:

true if the current item has an XmlDataGroupTag key

Throws:

XmlDataException.UnpositionedCursor - - when cursor is not positioned

isHome

boolean isHome()

Indicates whether the cursor is unpositioned.

Returns:

true if the cursor is unpositioned

isRepeating

boolean isRepeating()

Indicates if the current item is a repeating key. True is returned in the value is array (by convention, zero-length arrays are not allowed). False is returned if the value is not an array.

Returns:

true if item contains a repeating value

Throws:

XmlDataException.UnpositionedCursor - - when cursor is not positionedt

isSubstitution

boolean isSubstitution()

Determines if the cursor is positioned on a Substitution head item

Returns:

true if the current item has an XmlDataSubstitutionTag key

Throws:

XmlDataException.UnpositionedCursor - - when cursor is not positioned

last

boolean last()

Positions the cursor at the last item. Items are either elements, element wildcards, groups, or substitution heads. If there is no last item, the cursor remains unpositioned.

Returns:

true if there is a last item

last

boolean last(XmlDataContentTag key)

Position the cursor on the last occurrence of the specified tag and return true. Otherwise return false and leave the cursor unpositioned. For purpose of last, the particle IDs of the input key and content items are ignored so as to find the last occurrence. It is as if the last() method is invoked and then the previous() method is invoked until the condition key.getPartialName().equals(cursor.getKey().getPartialName()) is satisfied.

Parameters:

key - - the XmlDataContentTag to be searched

Returns:

true if item is found

next

boolean next()

Positions the cursor on the next content item. Returns false if there is no next item and the cursor remained unchanged.

Returns:

true if there is a next item

next

boolean next(XmlDataContentTag key)

Position the cursor on the next occurrence of the specified tag and return true. Otherwise return false and leave the cursor unpositioned. For purpose of next, the particle IDs of the input key and content items are ignored so as to find the next occurrence. It is as if the next() method is invoked until the condition key.getPartialName().equals(cursor.getKey().getPartialName()) is satisfied.

Parameters:

key - = the key to search for

Returns:

true if item is found

previous

boolean previous()

Positions the cursor on the previous item. Returns false if there is no previous item and the cursor remains unchanged.

Returns:

true if there is a previous item

previous

boolean previous(XmlDataContentTag key)

Position the cursor on the previous occurrence of the specified tag and return true. Otherwise return false and leave the cursor unpositioned. For purpose of previous, the particle IDs of the input key and content items are ignored so as to find the previous occurrence. It is as if the last() method is invoked until the condition key.getPartialName().equals(cursor.getKey().getPartialName()) is satisfied.

Parameters:

key - = the key to search for

Returns:

true if item is found

removeAttribute

boolean removeAttribute(XmlDataAttributeTag attribute,
                        int... index)

Removes the specified attribute from the current element. It is an error if the cursor is not positioned on an element item. It is an error if repeating content is present and an index is not provided.

Parameters:

attribute - - an XmlDataATtrubteTag naming the attribute

index - - the offset if the element is a repeating value

Returns:

true if the attribute was found and removed

Throws:

XmlDataException.UnpositionedCursor - - when cursor is not positioned

XmlDataException.IndexOutOfRange - - when index exceeds number of repeating values

XmlDataException.IndexRequired - - when an index is not specified and repeating values are present

setAttributes

void setAttributes(IData attributes,
                   int... index)

setAttributeValue

void setAttributeValue(XmlDataAttributeTag attribute,
                       java.lang.String value,
                       int... index)

Sets the value for the specified attribute. If a repeating value is present, an index must be specified. If the current content is simple (a String), the content is replaced by complex content with a *simple child containing the original String value.

Parameters:

attribute - - an XmlDqtaAttributeTag naming the attribute

value - - the value to set (must be a String)

index - - optional offset into array of repeating values

Throws:

XmlDataException.UnpositionedCursor - - when cursor is not positioned

XmlDataException.IndexOutOfRange - - when index exceeds number of repeating values

XmlDataException.IndexRequired - - when an index is not specified and repeating values are present

XmlDataException.UnsupportedType - - value is not a String

setContent

void setContent(java.lang.Object data,
                int... index)

Replace the value of the current element while preserving any original associated attributes. If the current element has repeating values, then the value of the specified entry in the array is replaced but the original attributes are preserved. It is an error if the cursor is not positioned on an element. It is an error if the index lies outside the range of the list of values.

Parameters:

data - - the value that replaces the current content

index - - optional offset when repeating values are present

Throws:

XmlDataException.UnpositionedCursor - - when cursor is not positioned

XmlDataException.IndexOutOfRange - - when index exceeds number of repeating values

XmlDataException.IndexRequired - - when an index is not specified and repeating values are present

setKey

void setKey(XmlDataContentTag tag)

Sets the key of the current content item. The key must be either an XmlDataElementTag, an XmlDataAnyTag, an XmlDataGroupTag, or an XmlDataSubsttutionTag. The key must be compatible with the current content. A group tag can only be assigned to an item with IData content. An any tag can only be assigned to an item with content in the any format. An element tag may not be assigned to content that is in the any or substitution head format.

Parameters:

tag - is one of the XmlDataContentTags mentioned above.

Throws:

XmlDataException.UnpositionedCursor - - when cursor is not positioned

setObject

void setObject(java.lang.Object object,
               int... index)

Set the object stored at the current cursor position. It is an error if the cursor is unpositioned. The value must be a String, an IData, a String[], an IData[], or an Object[]. Repeating values are always represented as arrays; arrays must be of length 1 or greater. The value may not be null. Empty values should be represented by empty Strings or empty IData. For Doctype directed conversion, a repeating value is always represented as either a String[] or an IData[], as appropriate. For non-directed conversion, repeating values are always stored as Object[]s.

It is always preferable to use of the XmlData methods to construct the value if it is not a String or String[]. Use createGroupValue() if the content does not contain attributes and the top-level group does not contain repeating values. Otherwise using createComplexValue().

When no index is specified, the specified value completely replaces the existing value and all existing attributes for the element are cleared. If an index is specified, the specified value in the array of repeating values is set and any associated attributes cleared. The array is enlarged if necessary. When an index is specified, the object must be scalar String or IData object. An index of -1 is equivalent to the index of the last repeating item. It is an error if the value is incompatible with the current key. For example, *substitution, *group, and *any tags only accept an IData as value. If tag and content are not compatible, the TagAndContentConflict exception is thrown.

Parameters:

object - - the value to be replaced.

index - - the position in the list of repeating values to be set. When index is specified, the value may not be an array.

Throws:

XmlDataException.UnpositionedCursor - - when cursor is not positioned

XmlDataException.UnsupportedType - - value is not a String, String[], IData[], IData[], or Object[]

XmlDataException.TagAndContentConflict - - the object is not appropriate for the current tag type

XmlDataException.IndexOutOfRange - - when index exceeds number of repeating values

setValue

void setValue(java.lang.Object object,
              int... index)

Sets the value stored at the current cursor. If the current item key is an XmlDataElementTag or an XmlDataGroupTag, the object is stored directly. For XmlDataElementTags, the object must be a String or IData object. For XmlDataGroupTags, it must be an IData. If there is existing content and it is an array, an index must be specified. For an XmlDataAnyTag, the object is stored indirectly; it is stored in the *content field of the any object. For an XmlDataSubstitutionTag, the object is stored indirectly; it is stored as the value of the single child which\ contains a key/value pair representing the substituted content.

Parameters:

object - - the IData or String object that ia assigned as the value of the current cursor position.

index - - the offset into the repeating values if the current item is an array.

setValueKey

void setValueKey(XmlDataContentTag key,
                 int... index)

Sets the key of the value of the current cursor. If the current item key is an element or a group, the key is stored directly in the key/value pair. If the current item is an any object, the key is stored in the *ncName and *namespace fields of the any object. If the current item is a substitution object, the key is stored in as he key of the first and only child in the substitution object. The index parameter only has meaning for substitution and any objects (names of repeated elements and groups are identical forall entries).

Parameters:

key - - the key assigned to the current value

index - - the offset into the repeating value array.