XmlDataCursorImpl (webMethods Java API Reference)

java.lang.Object
- com.wm.xmldata.XmlDataCursorImpl

All Implemented Interfaces:

XmlDataCursor
```
public class XmlDataCursorImpl
extends java.lang.Object
implements XmlDataCursor
```
Methods for navigating and manipulating the XmlData infoset.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String INSTANCE

static java.lang.String NAMESPACE

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`INSTANCE`
`static java.lang.String`	`NAMESPACE`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`XmlDataCursor`	`copyCursor()`
`int`	`count()` Returns the number of items stored at the current cursor position.
`IData`	`data()` Returns the IData for which this cursor is defined.
`boolean`	`deleteItem(int... optionalIndex)` Removes a single item from the array of items stored at the current cursor position.
`boolean`	`deleteObject()` Removes the tag-object-pair (single value or array of repeating values) from the current position.
`void`	`destroy()` Release any resources associated with the current cursor.
`boolean`	`first()` Positions the cursor at the first tag-object-pair.
`boolean`	`first(XmlDataContentTag key)` Positions the cursor on the first tag-object-pair with the specified tag and returns true.
`boolean`	`firstPartial(XmlDataContentTag key)` Positions the cursor on the first tag-object-pair with a tag that partially matches the specified tag.
`XmlDataContentTag`	`getAnyTag(int... optionalIndex)` Returns a parsed-tag constructed from the ncName and namespace fields in the any-item.
`XmlDataAttributeTag[]`	`getAttributeNames(int... optionalIndex)` Returns a list of attribute-tags for a complex-value stored at the current cursor position.
`IData`	`getAttributes(int... optionalIndex)` Returns an IData list of attributes and values for the complex-value stored at the current cursor position.
`java.lang.String`	`getAttributeValue(XmlDataAttributeTag attribute, int... optionalIndex)` Returns the value of an attribute for the complex-value at the current cursor position.
`java.lang.Object`	`getComplexValueContent(int... optionalIndex)` Returns the value paired with the *simple field or the solitary top-level group-tag.
`java.lang.Object`	`getContent(int... index)` Returns the content of the current value.
`java.lang.String`	`getInstanceProp(java.lang.String name, int... optionalIndex)` Retrieves the value of an instance (xsi) attribute specified for the current value.
`java.lang.Object`	`getItem(int... optionalIndex)` Returns an item from the current-object.
`java.lang.String`	`getNamespaceDecl(java.lang.String prefix, int... optionalIndex)` Returns the the namespace URI associated with the specified prefix.
`IData`	`getNamespaceDecls(int... optionalIndex)` Gets all of the namespace-prefix associations for the current value.
`java.lang.Object`	`getObject()` Returns the current-object, the object stored at the current-position.
`XmlDataContentTag`	`getTag()` Returns the current-tag as a parsed-tag.
`java.lang.Object`	`getValue(int... optionalIndex)` Returns a value from the current-object.
`XmlDataCursor`	`getValueCursor(int... optionalIndex)` Returns an XmlDataCursor positioned on the first child of the specified value in the current-object.
`XmlDataContentTag`	`getValueTag(int... optionalIndex)` Returns the value-tag associated with the value at the current-position.
`boolean`	`hasAttributes(int... index)` Determines if the value at the specified index has attributes.
`void`	`home()` The cursor becomes unpositioned as if newly created.
`void`	`insertItemAfter(java.lang.Object value, int index)` Inserts an item after the specified index into the array of repeating values at the current-position.
`void`	`insertItemBefore(java.lang.Object value, int index)` Inserts an item before the specified index into the array of repeating values at the current-position.
`void`	`insertObjectAfter(XmlDataContentTag key, java.lang.Object value)` Inserts a tag-object-pair after the current-position.
`void`	`insertObjectBefore(XmlDataContentTag key, java.lang.Object value)` Inserts a tag-object-pair before the current-position.
`void`	`insertValueAfter(XmlDataContentTag tag, java.lang.Object value, int index)` Inserts a value into an array of repeating values at the current-position, after the specified index.
`void`	`insertValueBefore(XmlDataContentTag tag, java.lang.Object value, int index)` Inserts a value into an array of repeating values at the current-position, before the specified index.
`boolean`	`isAny()` Determines if the current-tag is an any-tag.
`boolean`	`isComplexValue(int... index)` Determines if the value at the current-position is an IData with a single group tag, an attribute tga, or a simple tag.
`boolean`	`isEmpty(int... index)` Determines if the value at the current-position is empty (or non-existent complex content for complex-values).
`boolean`	`isGroup()` Determines if the current-tag is a group-tag.
`boolean`	`isGroupValue(int... index)` Determines if the value at the current-position is a group-value.
`boolean`	`isHome()` Indicates whether the cursor is unpositioned.
`boolean`	`isRecast()` Indicates if automatic recast is in effect.
`boolean`	`isRepeating()` Determines if the current-object is a repeating value.
`boolean`	`isSimpleValue(int... index)` Determines if the value at the current-position is a simple value.
`boolean`	`isSubstitution()` Determines if the current-tag is a substitution-tag
`boolean`	`last()` Positions the cursor at the last tag-object-pair.
`boolean`	`last(XmlDataContentTag key)` Positions the cursor on the last occurrence of the last tag-object-pairg with the specified tag and return true.
`boolean`	`lastPartial(XmlDataContentTag key)` Positiosn the cursor on the last tag-object-pair with a tag that partially matches the specified tag.
`XmlDataCursor`	`newCursor(IData data)` Creates a new XmlDataCuror instances from an existing cursor factory.
`boolean`	`next()` Positions the cursor on the next tag-object-pair.
`boolean`	`next(XmlDataContentTag key)` Positiona the cursor on the next tag-object-pair that has the specified tag and returns true.
`boolean`	`nextPartial(XmlDataContentTag key)` Positions the cursor on the next tag-object-pair with a tag that partially matches the specified tag.
`boolean`	`previous()` Positions the cursor on the previous tag-object-pair.
`boolean`	`previous(XmlDataContentTag key)` Positions the cursor on the previous tag-object-pair with the specified tag and return true.
`boolean`	`previousPartial(XmlDataContentTag key)` Positions the cursor on the previous tag-object-pair with a tag that partially matches the specified tag.
`void`	`recast(boolean mode)` Indicates whether existing String[] or IData[] arrays for repeating values should be automatically recreated as an Object[] when the inserted or set value type doesn't match the type of the repeating item array that is already present.
`boolean`	`removeAttribute(XmlDataAttributeTag attribute, int... optionalIndex)` Removes the specified attribute from an item value stored at the current cursor position.
`void`	`setAnyTag(XmlDataContentTag tag, int... index)` Sets the ncName and namespace fields of an any-item.
`void`	`setAttributes(IData attributes, int... index)` Sets the attribute-set for the current element
`void`	`setAttributeValue(XmlDataAttributeTag attribute, java.lang.String value, int... optionalIndex)` Sets the value for the specified attribute.
`void`	`setComplexValueContent(java.lang.Object content, int... index)` Replaces the content of a complex-value at the current-position while preserving any original associated attributes.
`void`	`setContent(java.lang.Object content, int... optionalIndex)` Replaces the content of the value at the current-position.
`void`	`setInstanceProp(java.lang.String name, java.lang.String value, int... index)` Sets an XML instance property (xsi attribute) on the current item.
`void`	`setItem(java.lang.Object value, int... optionalIndex)` Stores a value or an indirect-item at the current cursor position.
`void`	`setNamespaceDecl(java.lang.String prefix, java.lang.String uri, int... index)` Sets a namespace declaration for the current item.
`void`	`setNamespaceDecls(IData nsDecls, int... optionalIndex)` Sets the namespace declarations for the current item.
`void`	`setObject(java.lang.Object object)` Sets the object stored at the current cursor position ( a value or array of repeating values).
`void`	`setTag(XmlDataContentTag tag)` Sets the tag of the current tag-object pair.
`void`	`setValue(java.lang.Object value, int... optionalIndex)` Sets the value at the current cursor position (and index if repeating values are present).
`void`	`setValueTag(XmlDataContentTag key, int... index)` Sets the tag of the value stored at the current cursor.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - INSTANCE
```
public static final java.lang.String INSTANCE
```
  - NAMESPACE
```
public static final java.lang.String NAMESPACE
```
- Method Detail
  - count
```
public int count()
```
    Description copied from interface: XmlDataCursor
    
    Returns the number of items stored at the current cursor position. Items are either values or indirect-items. For a tag with repeating values (an array), the length of the array is returned. For a non-repeating value, 1 is returned. if the cursor is unpositioned, 0 is returned.
    
    Specified by:
    
    count in interface XmlDataCursor
    
    Returns:
    
    number of values held by the current item.
  - data
```
public IData data()
```
    Description copied from interface: XmlDataCursor
    
    Returns the IData for which this cursor is defined.
    
    Specified by:
    
    data in interface XmlDataCursor
    
    Returns:
    
    the IData instance for which this cursor was obtained.
  - deleteItem
```
public boolean deleteItem(int... optionalIndex)
```
    Description copied from interface: XmlDataCursor
    
    Removes a single item from the array of items stored at the current cursor position. If only one item is stored at the current position, then the entire current entry is deleted (both tag and object). If only one item is present, the index must be zero, or omitted. This is true whether the current item is a single item or an array containing one item. If an index is specified, it must be less than the number of repeating values present (zero is the index of the first item). An index of -1 is interpreted as the index of the last item (i.e. count() - 1). It is an error if the cursor is unpositioned, or the index is outside of the range of items, of if repeating values are present and an index is not specified. If one or more items remain after the specified item is deleted, false is returned and the cursor remains unpositioned. If the last or only remaining item at the current position is deleted, the entire entry (tag and object) is deleted. When this happens, the cursor is positioned on the next tag, and true is returned. If there is no next tag, the cursor is positioned on the previous tag and false is returned. If there are no reaming tags, the cursor is unpositioned. In other words, true is only returned when the cursor is moved forward to the next tag because all items have been removed from the current item array. This behavior is similar to legacy IDataCursor delete() behavior.
    
    Specified by:
    
    deleteItem in interface XmlDataCursor
    
    Parameters:
    
    optionalIndex - optional offset (starting at zero) into the array if repeating values present
    
    Returns:
    
    true if cursor is positioned on the next item after deletion
  - deleteObject
```
public boolean deleteObject()
```
    Description copied from interface: XmlDataCursor
    
    Removes the tag-object-pair (single value or array of repeating values) from the current position. If there are tags following the current position, the cursor is positioned on the next tag and true is returned. If there is no next tag, the cursor is positioned on the previous tag and false is returned. If there are no remaining tags, the cursor is unpositioned and false is returned. This behavior is similar to legacy IDataCursor delete() behavior.
    
    Specified by:
    
    deleteObject in interface XmlDataCursor
    
    Returns:
    
    true if cursor is positioned on the next item after deletion
  - destroy
```
public void destroy()
```
    Description copied from interface: XmlDataCursor
    
    Release any resources associated with the current cursor. The cursor becomes unpositioned and no longer has any content.
    
    Specified by:
    
    destroy in interface XmlDataCursor
  - first
```
public boolean first()
```
    Description copied from interface: XmlDataCursor
    
    Positions the cursor at the first tag-object-pair. Objects are either values paired with element-tags, group-values paired with group-tags, any-items paired with any-tags, or substitution-items paired with substitution-tags. If there is no first tag-object-pair, the cursor remains unpositioned.
    
    Specified by:
    
    first in interface XmlDataCursor
    
    Returns:
    
    true if there is a first item
  - first
```
public boolean first(XmlDataContentTag key)
```
    Description copied from interface: XmlDataCursor
    
    Positions the cursor on the first tag-object-pair with the specified tag and returns true. Otherwise return false and leaves the cursor unchanged.
    
    Specified by:
    
    first in interface XmlDataCursor
    
    Parameters:
    
    key - the searched content-tag
    
    Returns:
    
    true if item is found
  - firstPartial
```
public boolean firstPartial(XmlDataContentTag key)
```
    Description copied from interface: XmlDataCursor
    
    Positions the cursor on the first tag-object-pair with a tag that partially matches the specified tag. Otherwise returns false and leave the cursor unchanged. For purposes of comparison, the particle-ids of the tags are ignored during comparison in order to find the first occurrence regardless of its particle-id. It is as if the home() method is invoked and then the next() method is invoked until the condition tag.getPartialName().equals(cursor.getTag().getPartialName()) is satisfied.
    
    Specified by:
    
    firstPartial in interface XmlDataCursor
    
    Parameters:
    
    key - the searched content-tag
    
    Returns:
    
    true if item is found
  - getContent
```
public java.lang.Object getContent(int... index)
```
    Description copied from interface: XmlDataCursor
    
    Returns the content of the current value. The content does not include attributes. For non-complex-values, the current value itself is returned. For complex-values, the result obtained by XmlDataCursor.getComplexValueContent(int...) is returned. If the complex-value has no content, null is returned; but if the complex-value can be interpreted as an empty group-value, the empty group is returned (rather than null). If the content is a repeating group, an IData[] is returned.
    
    Specified by:
    
    getContent in interface XmlDataCursor
    
    Parameters:
    
    index - offset into repeating values
    
    Returns:
    
    the content of the current value.
  - getItem
```
public java.lang.Object getItem(int... optionalIndex)
```
    Description copied from interface: XmlDataCursor
    
    Returns an item from the current-object. If repeating values are present, an index must be specified. If the current-tag is an element-tag, a value is returned. If the current-tag is a group-tag, a group-value is returned. If the current-tag is an indirect-tag, an indirect-item is returned (either an any-item or substitution-item). It is an error if the cursor is not positioned. It is an error if an array with more than one value is present and no index is specified. If a scalar is present, the index may be specified as zero or omitted. If an index is specified, the item 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 current-object is a scalar and an 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 are always be represented as empty Strings or empty IDatas, never as Java nulls.
    
    Specified by:
    
    getItem in interface XmlDataCursor
    
    Parameters:
    
    optionalIndex - offset into the repeating values array (if repeating values are present)
    
    Returns:
    
    the requested value
  - getAnyTag
```
public XmlDataContentTag getAnyTag(int... optionalIndex)
```
    Description copied from interface: XmlDataCursor
    
    Returns a parsed-tag constructed from the *ncName and *namespace fields in the any-item. It will be be an instance of XmlDataElementTag or XmlDataSubstitutionTag. This is a very specialized method. More typically, XmlDataCursor.getValueTag(int...) is used to return the tag associated with the item. However, if the any-item references a substitution group, the getValueTag() method returns the element tag present in the substitution group. This specialized method returns the tag created from fields in the any-item which will be either be an element-tag or a substitution-tag. This method is used only when it is necessary to distinguish between substitution tags and element tags in a any-item document. Normally, XmlDataCursor.getValueTag(int...) will be sufficient, and more general.
    
    Specified by:
    
    getAnyTag in interface XmlDataCursor
    
    Parameters:
    
    optionalIndex - offset into the repeating item array (if repeating values are present)
    
    Returns:
    
    The tag present in the any-item Document.
  - getAttributeNames
```
public XmlDataAttributeTag[] getAttributeNames(int... optionalIndex)
```
    Description copied from interface: XmlDataCursor
    
    Returns a list of attribute-tags for a complex-value stored at the current cursor position. If the value is repeating, it is necessary to specify an index to select a specific member of the array. The value of the item is as if XmlDataCursor.getValue(int...) was invoked, and then attribute-tags extracted from the result.
    
    Specified by:
    
    getAttributeNames in interface XmlDataCursor
    
    Parameters:
    
    optionalIndex - offset into the repeating value array (if repeating values are present)
    
    Returns:
    
    An array of XmlDataAttributeTags, null if no attributes present
  - getAttributes
```
public IData getAttributes(int... optionalIndex)
```
    Description copied from interface: XmlDataCursor
    
    Returns an IData list of attributes and values for the complex-value stored at the current cursor position. If repeating values are present, it is necessary to specify an index to select a specific member of the array. This is the attribute-set paired with the *attributes field of a complex-value. If the current value is not complex or does not have a *attributes field. a null is returned. The value is obtained as if XmlDataCursor.getValue(int...) was invoked, and then attribute-set is retrieved from the value.
    
    Specified by:
    
    getAttributes in interface XmlDataCursor
    
    Parameters:
    
    optionalIndex - the offset of the item of repeating values are present
    
    Returns:
    
    An IData object containing the attributes.
  - getAttributeValue
```
public java.lang.String getAttributeValue(XmlDataAttributeTag attribute,
                                          int... optionalIndex)
```
    Description copied from interface: XmlDataCursor
    
    Returns the value of an attribute for the complex-value at the current cursor position. 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.
    
    Specified by:
    
    getAttributeValue in interface XmlDataCursor
    
    Parameters:
    
    attribute - the tag of the attribute XmlDataAttributeTag)
    
    optionalIndex - 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.
  - getComplexValueContent
```
public java.lang.Object getComplexValueContent(int... optionalIndex)
```
    Description copied from interface: XmlDataCursor
    
    Returns the value paired with the *simple field or the solitary top-level group-tag. Content will always be either simple-value (a String), a group-value (an IData of tag/value pairs), or an array of group-values. A null is returned if the current value is in complex-value format but has no *simple or group-tag content.
    
    Specified by:
    
    getComplexValueContent in interface XmlDataCursor
    
    Parameters:
    
    optionalIndex - the index of the repeating value that is a complex-value
    
    Returns:
    
    the content of the current element (this is the highest-level parent that does not include the attributes container)
  - copyCursor
```
public XmlDataCursor copyCursor()
```
    Specified by:
    
    copyCursor in interface XmlDataCursor
    
    Returns:
    
    a copy of this cursor
  - newCursor
```
public XmlDataCursor newCursor(IData data)
```
    Description copied from interface: XmlDataCursor
    
    Creates a new XmlDataCuror instances from an existing cursor factory.
    
    Specified by:
    
    newCursor in interface XmlDataCursor
    
    Parameters:
    
    data - an existing IData who's cursor factory is used to create a new XmlDataCursor instance.
    
    Returns:
    
    a new cursor using the same factory that create this cursor.
  - getInstanceProp
```
public java.lang.String getInstanceProp(java.lang.String name,
                                        int... optionalIndex)
```
    Description copied from interface: XmlDataCursor
    
    Retrieves the value of an instance (xsi) attribute specified for the current value. If repeating values are present, an index must be specified.
    
    Specified by:
    
    getInstanceProp in interface XmlDataCursor
    
    Parameters:
    
    name - the name of the xsi property (e.g. nil, type)
    
    optionalIndex - offset into the repeating values
    
    Returns:
    
    the value of the property. Null if the property is not present
  - getNamespaceDecl
```
public java.lang.String getNamespaceDecl(java.lang.String prefix,
                                         int... optionalIndex)
```
    Description copied from interface: XmlDataCursor
    
    Returns the the namespace URI associated with the specified prefix.
    
    Specified by:
    
    getNamespaceDecl in interface XmlDataCursor
    
    Parameters:
    
    prefix - the prefix
    
    optionalIndex - the namespace URI associated with the prefix
    
    Returns:
    
    the namespace URI associated with the prefix
  - getNamespaceDecls
```
public IData getNamespaceDecls(int... optionalIndex)
```
    Description copied from interface: XmlDataCursor
    
    Gets all of the namespace-prefix associations for the current value.
    
    Specified by:
    
    getNamespaceDecls in interface XmlDataCursor
    
    Parameters:
    
    optionalIndex - the index of the repeating value for which prefixes are returned
    
    Returns:
    
    an IData containing prefix/namespace URI pairs
  - getObject
```
public java.lang.Object getObject()
```
    Description copied from interface: XmlDataCursor
    
    Returns the current-object, the object stored at the current-position. If repeating values are present, then the entire array is returned. It is an error if the cursor is unpositioned. Normally, getObject will return a String, String[], IData, IData[], or Object[]. If the current-tag is an element-tag, a value or array of values is returned; if the the current-tag is a group-tag, a group-value or array of group-values is returned; if the current-tag is an any-tag, an any-item or array of any-items is returned; if the current-tag is a substitution-tag, a substitution-item or an array of substitution-items is returned.
    
    Specified by:
    
    getObject in interface XmlDataCursor
    
    Returns:
    
    object stored at current cursor position
  - getTag
```
public XmlDataContentTag getTag()
```
    Description copied from interface: XmlDataCursor
    
    Returns the current-tag as a parsed-tag. The tag will be either an XmlDataElementTag, an XmlDataAnyTag, an XmlDataGroupTag, or an XmlDataSubstitutionTag. An exception is thrown if the cursor is not positioned.
    
    Specified by:
    
    getTag in interface XmlDataCursor
    
    Returns:
    
    One of the XmlDataContentTags mentioned above.
  - getValue
```
public java.lang.Object getValue(int... optionalIndex)
```
    Description copied from interface: XmlDataCursor
    
    Returns a value from the current-object. If repeating values are present, an index must be specified. For indirect-items (items paired with any-tags or substitution-tags), the value of the indirect-item is returned. For items paired with element-tags or group-tags, the item is returned directly as the value.
    
    Specified by:
    
    getValue in interface XmlDataCursor
    
    Parameters:
    
    optionalIndex - the offset into repeating values
    
    Returns:
    
    The value stored at the current-position. It will be either complex-value, group-value, simple-value.
    
    See Also:
    
    XmlData.getAnyItemValueTag(IData), XmlData.getSubstitutionItemValueTag(IData)
  - getValueCursor
```
public XmlDataCursor getValueCursor(int... optionalIndex)
```
    Description copied from interface: XmlDataCursor
    
    Returns an XmlDataCursor positioned on the first child of the specified value in the current-object. If the current value is not a group-value or a complex-value with non-repeating top-level group content, a null is returned. If the value is an empty XmlData, the returned cursor is in home state.
    
    Specified by:
    
    getValueCursor in interface XmlDataCursor
    
    Parameters:
    
    optionalIndex - the index of the repeating value
    
    Returns:
    
    an XmlDataCursor positioned on the first child of the current value.
  - getValueTag
```
public XmlDataContentTag getValueTag(int... optionalIndex)
```
    Description copied from interface: XmlDataCursor
    
    Returns the value-tag associated with the value at the current-position. If repeating values are present, an index must be specified. The tag is returned as a parsed-tag (in this case as an instance of XmlDataElementTag or XmlDataGroupTag). If the current-tag is an element-tag or a group-tag, the current-tag is simply returned. The behavior is the same as that of XmlDataCursor.getTag(). If the current-tag is an any-tag or a substitution-tag, an XmlDataElementTag is constructed from the associated indirect-item.
    
    Specified by:
    
    getValueTag in interface XmlDataCursor
    
    Parameters:
    
    optionalIndex - the index of the repeating value
    
    Returns:
    
    an instance of an appropriate subclass of XmlDataTag (either XmlDataElementTag or XmlDataGroupTag)
    
    See Also:
    
    XmlData.getAnyItemValueTag(IData), XmlData.getSubstitutionItemValueTag(IData)
  - hasAttributes
```
public boolean hasAttributes(int... index)
```
    Description copied from interface: XmlDataCursor
    
    Determines if the value at the specified index 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.
    
    Specified by:
    
    hasAttributes in interface XmlDataCursor
    
    Parameters:
    
    index - the index offset into repeating values
    
    Returns:
    
    true if any member of the value has attributes, or the specified index member has attributes.
  - home
```
public void home()
```
    Description copied from interface: XmlDataCursor
    
    The cursor becomes unpositioned as if newly created.
    
    Specified by:
    
    home in interface XmlDataCursor
  - insertItemAfter
```
public void insertItemAfter(java.lang.Object value,
                            int index)
```
    Description copied from interface: XmlDataCursor
    
    Inserts an item after the specified index into the array of repeating values at the current-position. 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. An item may be either a value or an indirect-item. When the current-tag is a substitution-tag, the value must be a substitution-item. When the current-tag is an any-tag, the value must be an an any-item. These items may be created, for example, using XmlData.createSubstitutionItem(XmlDataElementTag, Object) or XmlData.createAnyItem(XmlDataContentTag, Object). If the current-object is a scalar, it is promoted to an array prior to insertion of the new item. If the cursor has recast set to true, the new array is an Object[].
    
    Specified by:
    
    insertItemAfter in interface XmlDataCursor
    
    Parameters:
    
    value - the scalar value inserted (must be simple-value, group-value, complex-value, or indirect-item)
    
    index - The insert position after which the value is inserted
  - insertItemBefore
```
public void insertItemBefore(java.lang.Object value,
                             int index)
```
    Description copied from interface: XmlDataCursor
    
    Inserts an item before the specified index into the array of repeating values at the current-position. An index == array.length adds to end. An index of -1 inserted the values before the last value. An item may be either a value or an indirect-item. When the current-tag is a substitution-tag, the value must be a substitution-item. When the current current-tag is an any-tag, the value must be an an any-item. These item may be created, for example, using XmlData.createSubstitutionItem(XmlDataElementTag, Object) or XmlData.createAnyItem(XmlDataContentTag, Object). If the current-object is a scalar, it is promoted to an array prior to insertion of the new item. If the cursor has recast set to true, the new array is an Object[].
    
    Specified by:
    
    insertItemBefore in interface XmlDataCursor
    
    Parameters:
    
    value - the scalar value inserted (must be simple-value, group-value, complex-value, or indirect-item)
    
    index - the index position before which the value is inserted
  - insertObjectAfter
```
public void insertObjectAfter(XmlDataContentTag key,
                              java.lang.Object value)
```
    Description copied from interface: XmlDataCursor
    
    Inserts a tag-object-pair after the current-position. The object may be a value, an indirect-item, or a list of values or indirect-items. The tag and values must be compatible. For example, a group-tag may only have a group-value or an array of group-values, a substitution-tag must have a substitution-item or array of substitution-items, etc.
    
    Specified by:
    
    insertObjectAfter in interface XmlDataCursor
    
    Parameters:
    
    key - the tag of the tag/object pair to be inserted before the current cursor position
    
    value - the item or array of repeating values that is inserted (must be String, String[], IData, IData[], or Object[])
  - insertObjectBefore
```
public void insertObjectBefore(XmlDataContentTag key,
                               java.lang.Object value)
```
    Description copied from interface: XmlDataCursor
    
    Inserts a tag-object-pair before the current-position. The object may be a value, an indirect-item, or a list of values or indirect-items. The tag and values must be compatible. For example, a group-tag may only have a group-value or an array of group-values, a substitution-tag must have a substitution-item or array of substitution-items, etc.
    
    Specified by:
    
    insertObjectBefore in interface XmlDataCursor
    
    Parameters:
    
    key - the tag of the tag/object pair to be inserted before the current cursor position
    
    value - the item or array of repeating values that is inserted (must be String, String[], IData, IData[], or Object[])
  - insertValueAfter
```
public void insertValueAfter(XmlDataContentTag tag,
                             java.lang.Object value,
                             int index)
```
    Description copied from interface: XmlDataCursor
    
    Inserts a value into an array of repeating values at the current-position, 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. If the current-tag is an element-tag or group-tag, the value is inserted directly into the repeating value array at the specified offset. The content-tag is irrelevant (for groups and elements) and may be null. If not null, it must match the current tag. If the current-tag is a substitution-tag or an any-tag, a substitution-item or any-item is created from the content-tag and value, and inserted into the repeating values at the specified index offset. If the current Object is a scalar, it is promoted to an array prior to insertion of the new item. If the cursor has recast set to true, the new array is an Object[].
    
    Specified by:
    
    insertValueAfter in interface XmlDataCursor
    
    Parameters:
    
    tag - the name of the repeating value for indirect-items (may be null if current tag is an element and group)
    
    value - the value to insert (if the current tag is an any tag and the content tag is a substitution tag, value must be a substitution value).
    
    index - the index of the repeating item
  - insertValueBefore
```
public void insertValueBefore(XmlDataContentTag tag,
                              java.lang.Object value,
                              int index)
```
    Description copied from interface: XmlDataCursor
    
    Inserts a value into an array of repeating values at the current-position, before the specified index. If the current-tag is an element-tag or group-tag, the value is inserted directly into the repeating value array at the specified offset. The content-tag is irrelevant (for groups and elements) and may be null. If not null, it must match the current tag. If the current-tag is a substitution-tag or an any-tag, a substitution-item or any-item is created from the content-tag tag and value, and inserted into the repeating values before the specified index offset. If the current Object is a scalar it is promoted to an array prior to insertion of the new item. If the cursor has recast set to true, the new array is an Object[].
    
    Specified by:
    
    insertValueBefore in interface XmlDataCursor
    
    Parameters:
    
    tag - the tag of the value for indirect-items (may be null if current tag is an element and group tag)
    
    value - the value to insert (if the current tag is an any tag and the content tag is a substitution tag, value must be a substitution value).
    
    index - the index of the repeating item
  - isAny
```
public boolean isAny()
```
    Description copied from interface: XmlDataCursor
    
    Determines if the current-tag is an any-tag.
    
    Specified by:
    
    isAny in interface XmlDataCursor
    
    Returns:
    
    true if the current item has an XmlDataAnyTag tag
  - isComplexValue
```
public boolean isComplexValue(int... index)
```
    Description copied from interface: XmlDataCursor
    
    Determines if the value at the current-position is an IData with a single group tag, an *attribute tga, or a *simple tag. If repeating values are present, an index must be specified.
    
    Specified by:
    
    isComplexValue in interface XmlDataCursor
    
    Parameters:
    
    index - offset into repeating values.
    
    Returns:
    
    true if the current value is complex.
  - isEmpty
```
public boolean isEmpty(int... index)
```
    Description copied from interface: XmlDataCursor
    
    Determines if the value at the current-position is empty (or non-existent complex content for complex-values). If repeating values are present, an index must be specified.
    
    Specified by:
    
    isEmpty in interface XmlDataCursor
    
    Parameters:
    
    index - offset into repeating values
    
    Returns:
    
    true if the current value is an empty String, an empty IData, or a complex-value with empty content, or a complex-value with no content.
  - isGroup
```
public boolean isGroup()
```
    Description copied from interface: XmlDataCursor
    
    Determines if the current-tag is a group-tag.
    
    Specified by:
    
    isGroup in interface XmlDataCursor
    
    Returns:
    
    true if the current item has an XmlDataGroupTag tag
    
    See Also:
    
    XmlDataContentTag.isGroup()
  - isGroupValue
```
public boolean isGroupValue(int... index)
```
    Description copied from interface: XmlDataCursor
    
    Determines if the value at the current-position is a group-value. A group-value is an IData that does not have a *attributes field, a *simple field, or solitary top-level group-tag. If repeating values are present, an index must be specified.
    
    Specified by:
    
    isGroupValue in interface XmlDataCursor
    
    Parameters:
    
    index - the offset into the repeating values array
    
    Returns:
    
    true if the value is an IData that cannot be interpreted as a complex-value.
    
    See Also:
    
    XmlData.isGroupValue(Object)
  - isHome
```
public boolean isHome()
```
    Description copied from interface: XmlDataCursor
    
    Indicates whether the cursor is unpositioned.
    
    Specified by:
    
    isHome in interface XmlDataCursor
    
    Returns:
    
    true if the cursor is unpositioned
  - isRecast
```
public boolean isRecast()
```
    Description copied from interface: XmlDataCursor
    
    Indicates if automatic recast is in effect.
    
    Specified by:
    
    isRecast in interface XmlDataCursor
    
    Returns:
    
    true if it is in effect
  - isRepeating
```
public boolean isRepeating()
```
    Description copied from interface: XmlDataCursor
    
    Determines if the current-object is a repeating value. True is returned in the current-object is array (by convention, zero-length arrays are not allowed). False is returned if the current-object is not an array.
    
    Specified by:
    
    isRepeating in interface XmlDataCursor
    
    Returns:
    
    true if current-object contains a repeating value
  - isSimpleValue
```
public boolean isSimpleValue(int... index)
```
    Description copied from interface: XmlDataCursor
    
    Determines if the value at the current-position is a simple value. If repeating values are present, an index must be specified.
    
    Specified by:
    
    isSimpleValue in interface XmlDataCursor
    
    Parameters:
    
    index - the offset into the repeating values array
    
    Returns:
    
    true if the specified value an instance of String
  - isSubstitution
```
public boolean isSubstitution()
```
    Description copied from interface: XmlDataCursor
    
    Determines if the current-tag is a substitution-tag
    
    Specified by:
    
    isSubstitution in interface XmlDataCursor
    
    Returns:
    
    true if the current-object has an substitution-tag
  - last
```
public boolean last()
```
    Description copied from interface: XmlDataCursor
    
    Positions the cursor at the last tag-object-pair. Objects are either values paired with element-tags, group-values paired with group-tags, any-items paired with any-tags, or substitution-items paired with substitution-tags. If there is no last tag-object-pair, the cursor remains unpositioned.
    
    Specified by:
    
    last in interface XmlDataCursor
    
    Returns:
    
    true if there is a last value
  - last
```
public boolean last(XmlDataContentTag key)
```
    Description copied from interface: XmlDataCursor
    
    Positions the cursor on the last occurrence of the last tag-object-pairg with the specified tag and return true. Otherwise return false and leave the cursor unchanged.
    
    Specified by:
    
    last in interface XmlDataCursor
    
    Parameters:
    
    key - the searched content-tag
    
    Returns:
    
    true if tag is found
  - lastPartial
```
public boolean lastPartial(XmlDataContentTag key)
```
    Description copied from interface: XmlDataCursor
    
    Positiosn the cursor on the last tag-object-pair with a tag that partially matches the specified tag. Otherwise return false and leave the cursor unchanged. For purposes of comparison, the particle-ids of the tags are ignored during comparison in order to find the last occurrence regardless of its particle-id. It is as if the last() method is invoked and then the previous() method is invoked until the condition tag.getPartialName().equals(cursor.getTag().getPartialName()) is satisfied.
    
    Specified by:
    
    lastPartial in interface XmlDataCursor
    
    Parameters:
    
    key - the XmlDataContentTag to be searched
    
    Returns:
    
    true if tag is found
  - next
```
public boolean next()
```
    Description copied from interface: XmlDataCursor
    
    Positions the cursor on the next tag-object-pair. Returns false if there is no next pair and the cursor remains unchanged.
    
    Specified by:
    
    next in interface XmlDataCursor
    
    Returns:
    
    true if there is a next tag-object pair.
  - next
```
public boolean next(XmlDataContentTag key)
```
    Description copied from interface: XmlDataCursor
    
    Positiona the cursor on the next tag-object-pair that has the specified tag and returns true. Otherwise returns false and leaves the cursor unchanged.
    
    Specified by:
    
    next in interface XmlDataCursor
    
    Parameters:
    
    key - the searched content-tag
    
    Returns:
    
    true if tag is found
  - nextPartial
```
public boolean nextPartial(XmlDataContentTag key)
```
    Description copied from interface: XmlDataCursor
    
    Positions the cursor on the next tag-object-pair with a tag that partially matches the specified tag. Otherwise returns false and leavse the cursor unchanged. For purposes of comparison, the particle-ids of the tags are ignored during comparison in order to find the next occurrence regardless of its particle-id. It is as if the next() method is invoked until the condition tag.getPartialName().equals(cursor.getTag().getPartialName()) is satisfied.
    
    Specified by:
    
    nextPartial in interface XmlDataCursor
    
    Parameters:
    
    key - the searched content-tag
    
    Returns:
    
    true if item is found
  - previous
```
public boolean previous()
```
    Description copied from interface: XmlDataCursor
    
    Positions the cursor on the previous tag-object-pair. Returns false if there is no previous item and the cursor remains unchanged.
    
    Specified by:
    
    previous in interface XmlDataCursor
    
    Returns:
    
    true if there is a previous item
  - previous
```
public boolean previous(XmlDataContentTag key)
```
    Description copied from interface: XmlDataCursor
    
    Positions the cursor on the previous tag-object-pair with the specified tag and return true. Otherwise returns false and leaves the cursor unchanged.
    
    Specified by:
    
    previous in interface XmlDataCursor
    
    Parameters:
    
    key - the searched content-tag
    
    Returns:
    
    true if item is found
  - previousPartial
```
public boolean previousPartial(XmlDataContentTag key)
```
    Description copied from interface: XmlDataCursor
    
    Positions the cursor on the previous tag-object-pair with a tag that partially matches the specified tag. Otherwise returns false and leave the cursor unchanged. For purposes of comparison, the particle-ids of the tags are ignored during comparison in order to find the previous occurrence regardless of its particle-id. It is as if the previous() method is invoked until the condition tag.getPartialName().equals(cursor.getTag().getPartialName()) is satisfied.
    
    Specified by:
    
    previousPartial in interface XmlDataCursor
    
    Parameters:
    
    key - the searched content-tag
    
    Returns:
    
    true if item is found
  - recast
```
public void recast(boolean mode)
```
    Description copied from interface: XmlDataCursor
    
    Indicates whether existing String[] or IData[] arrays for repeating values should be automatically recreated as an Object[] when the inserted or set value type doesn't match the type of the repeating item array that is already present. This is typically set true when inserting values into an infoset that was created without a document type template and therefore contains Object[]s rather than String[] and IData[]s.
    
    Specified by:
    
    recast in interface XmlDataCursor
    
    Parameters:
    
    mode - true causes automatic recast; default is false
  - removeAttribute
```
public boolean removeAttribute(XmlDataAttributeTag attribute,
                               int... optionalIndex)
```
    Description copied from interface: XmlDataCursor
    
    Removes the specified attribute from an item value stored at the current cursor position. It is an error if the cursor is not positioned on an element, or indirect-item. It is an error if repeating values are present and an index is not provided.
    
    Specified by:
    
    removeAttribute in interface XmlDataCursor
    
    Parameters:
    
    attribute - an XmlDataAttributeTag naming the attribute
    
    optionalIndex - the offset if the element is a repeating value
    
    Returns:
    
    true if the attribute was found and removed
  - setAnyTag
```
public void setAnyTag(XmlDataContentTag tag,
                      int... index)
```
    Description copied from interface: XmlDataCursor
    
    Sets the *ncName and *namespace fields of an any-item. This is a specialized method. More typically XmlDataCursor.setValueTag(XmlDataContentTag, int...) is used. This method sets the any-item tag directly even if the value of the any-item is a substitution-item. This method is typically used in conjunction with XmlDataCursor.getAnyTag(int...)
    
    Specified by:
    
    setAnyTag in interface XmlDataCursor
    
    Parameters:
    
    tag - the tag used to set ncName and namespace in the any-item.
    
    index - offset into list of repeating values
  - setAttributes
```
public void setAttributes(IData attributes,
                          int... index)
```
    Description copied from interface: XmlDataCursor
    
    Sets the attribute-set for the current element
    
    Specified by:
    
    setAttributes in interface XmlDataCursor
    
    Parameters:
    
    attributes - IData list of attributes
    
    index - position in repeating value
  - setAttributeValue
```
public void setAttributeValue(XmlDataAttributeTag attribute,
                              java.lang.String value,
                              int... optionalIndex)
```
    Description copied from interface: XmlDataCursor
    
    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.
    
    Specified by:
    
    setAttributeValue in interface XmlDataCursor
    
    Parameters:
    
    attribute - an XmlDataAttributeTag naming the attribute
    
    value - the value to set (must be a String)
    
    optionalIndex - optional offset into array of repeating values
  - setComplexValueContent
```
public void setComplexValueContent(java.lang.Object content,
                                   int... index)
```
    Description copied from interface: XmlDataCursor
    
    Replaces the content of a complex-value at the current-position while preserving any original associated attributes. If repeating values are present, an index must be provided. 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.
    
    Specified by:
    
    setComplexValueContent in interface XmlDataCursor
    
    Parameters:
    
    content - the value that replaces the current content
    
    index - optional offset when repeating values are present; a second index is required when repeating content is present
  - setContent
```
public void setContent(java.lang.Object content,
                       int... optionalIndex)
```
    Description copied from interface: XmlDataCursor
    
    Replaces the content of the value at the current-position. For simple-values it must be a String. For group-values, it must be an IData. For complex-values it may be a String, IData, or IData[]. A null child causes the content of complex-values to be removed completely. setContent is a convenience method. Essentially, if the accessed value is simple or group, setContent() behaves like XmlDataCursor.setValue(Object, int...). When the accessed value is complex, this method behaves like XmlDataCursor.setComplexValueContent(Object, int...).
    
    Specified by:
    
    setContent in interface XmlDataCursor
    
    Parameters:
    
    content - the content of the current value
    
    optionalIndex - the offset into a list of repeating values
  - setInstanceProp
```
public void setInstanceProp(java.lang.String name,
                            java.lang.String value,
                            int... index)
```
    Description copied from interface: XmlDataCursor
    
    Sets an XML instance property (xsi attribute) on the current item. If the current item has repeating values, an index is required.
    
    Specified by:
    
    setInstanceProp in interface XmlDataCursor
    
    Parameters:
    
    name - the name of the property(e.g. 'nil')
    
    value - the value of the property (e.g. 'true')
    
    index - the offset index into repeating values
  - setItem
```
public void setItem(java.lang.Object value,
                    int... optionalIndex)
```
    Description copied from interface: XmlDataCursor
    
    Stores a value or an indirect-item at the current cursor position. If the current cursor is positioned on a repeating value, an index must be specified. It is an error if the cursor is unpositioned. The value stored must be a simple-value, a group-value, a complex-value, or an indirect-item. Empty values should be represented by empty Strings or empty IData. For document-type-directed conversion, a repeating value is always represented as either a String[] or an IData[], or Object[]s, as appropriate. For non-directed conversion, repeating values are always stored as Object[]s.
    It is always preferable to use one of the XmlData methods to construct the value if it is not a String or String[]. For example, use XmlData.createGroupValue(Object...) if the content does not contain attributes and the top-level group does not contain repeating values. Otherwise use XmlData.createComplexValue(). When creating an indirect-item, use a methods such as XmlData.createAnyItem(XmlDataContentTag, Object) to create an any-item or a method such as XmlData.createSubstitutionItem(XmlDataElementTag, Object) to create a substitution-item.
    If an index is specified, the specified value in the array of repeating values is set and any associated attributes cleared. When no 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-tag. For example, substitution-tags, group-tags, and any-tags only accept an IData as value. If tag and content are not compatible, the TagAndContentConflict exception is thrown.
    
    Specified by:
    
    setItem in interface XmlDataCursor
    
    Parameters:
    
    value - the value to be replaced.
    
    optionalIndex - the position in the list of repeating values to be set. When index is specified, the value may not be an array.
  - setNamespaceDecl
```
public void setNamespaceDecl(java.lang.String prefix,
                             java.lang.String uri,
                             int... index)
```
    Description copied from interface: XmlDataCursor
    
    Sets a namespace declaration for the current item. If the current item has repeating values, the index is used to indicate the specific value.
    
    Specified by:
    
    setNamespaceDecl in interface XmlDataCursor
    
    Parameters:
    
    prefix - the prefix
    
    uri - the namespace URI.
    
    index - the offset index into repeating values
  - setNamespaceDecls
```
public void setNamespaceDecls(IData nsDecls,
                              int... optionalIndex)
```
    Description copied from interface: XmlDataCursor
    
    Sets the namespace declarations for the current item.
    
    Specified by:
    
    setNamespaceDecls in interface XmlDataCursor
    
    Parameters:
    
    nsDecls - IData list of prefix/namespace pairs
    
    optionalIndex - the index of the repeating item
  - setObject
```
public void setObject(java.lang.Object object)
```
    Description copied from interface: XmlDataCursor
    
    Sets the object stored at the current cursor position ( a value or array of repeating values). It is an error if the cursor is unpositioned. The Object must be a String, an IData, a String[], an IData[], or an Object[].
    
    Specified by:
    
    setObject in interface XmlDataCursor
    
    Parameters:
    
    object - the offset to be stored at the current element.
  - setTag
```
public void setTag(XmlDataContentTag tag)
```
    Description copied from interface: XmlDataCursor
    
    Sets the tag of the current tag-object pair. The tag must be either an XmlDataElementTag, an XmlDataAnyTag, an XmlDataGroupTag, or an XmlDataSubstitutionTag. The tag must be compatible with the current value. 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.
    
    Specified by:
    
    setTag in interface XmlDataCursor
    
    Parameters:
    
    tag - is one of the XmlDataContentTags mentioned above.
  - setValue
```
public void setValue(java.lang.Object value,
                     int... optionalIndex)
```
    Description copied from interface: XmlDataCursor
    
    Sets the value at the current cursor position (and index if repeating values are present). For element and group tags, the value (simple, group, or complex) is stored directly at the current position (and index). For any and substitution tags, the value tag is stored in the indirect-item value. (substitution-item or any-item). For XmlDataElementTags, the item must be a String or IData object. For XmlDataGroupTags, it must be an IData. If there is an existing object and it is an array, an index must be specified. For an XmlDataAnyTag, the object is stored indirectly; it is stored in the *value field of the any-item Document object. For an XmlDataSubstitutionTag, the item is stored indirectly; it is stored as the object of a single child which contains group content representing the substituted tag/object.
    
    Specified by:
    
    setValue in interface XmlDataCursor
    
    Parameters:
    
    value - the IData or String object that ia assigned as the value of the current cursor position.
    
    optionalIndex - the offset into the repeating values if the current item is an array.
  - setValueTag
```
public void setValueTag(XmlDataContentTag key,
                        int... index)
```
    Description copied from interface: XmlDataCursor
    
    Sets the tag of the value stored at the current cursor. If the current tag is an element or a group tag, the new tag is stored directly in the tag/value pair. In this case, setValueTag() behaves exactly like XmlDataCursor.setTag(XmlDataContentTag). However, if the current value is an indirect-item, the tag is stored in the indirect-item. If the indirect-item is an any-item, the tag is decomposed and stored in the *ncName and *namespace fields of the any-item. The current tag remains unchanged. If the current tag is a substitution-tag, the value tag is stored as the tag of the first and only child in the substitution-item. The index parameter only has meaning for substitution and any objects (names of repeated elements and groups are identical for all entries).
    
    Specified by:
    
    setValueTag in interface XmlDataCursor
    
    Parameters:
    
    key - the tag assigned to the current value
    
    index - the offset into the repeating value array.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class XmlDataCursorImpl

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INSTANCE

NAMESPACE

Method Detail

count

data

deleteItem

deleteObject

destroy

first

first

firstPartial

getContent

getItem

getAnyTag

getAttributeNames

getAttributes

getAttributeValue

getComplexValueContent

copyCursor

newCursor

getInstanceProp

getNamespaceDecl

getNamespaceDecls

getObject

getTag

getValue

getValueCursor

getValueTag

hasAttributes

home

insertItemAfter

insertItemBefore

insertObjectAfter

insertObjectBefore

insertValueAfter

insertValueBefore

isAny

isComplexValue

isEmpty

isGroup

isGroupValue

isHome

isRecast

isRepeating

isSimpleValue

isSubstitution

last

last

lastPartial

next

next

nextPartial

previous

previous

previousPartial

recast

removeAttribute

setAnyTag

setAttributes

setAttributeValue

setComplexValueContent

setContent

setInstanceProp

setItem

setNamespaceDecl

setNamespaceDecls

setObject

setTag

setValue

setValueTag

toString