public interface

IXmlUnit

implements IAddressableUnit
com.pnfsoftware.jeb.core.units.IXmlUnit

Class Overview

Units providing XML documents are encouraged to implement this interface.

Summary

Public Methods
abstract Document getDocument()
Retrieve the XML document.
abstract Object getItemObject(long id)
Optionally provide an object associated with the given item.
[Expand]
Inherited Methods
From interface com.pnfsoftware.jeb.core.IUnitCreator
From interface com.pnfsoftware.jeb.core.IUserDataSupport
From interface com.pnfsoftware.jeb.core.units.IAddressableUnit
From interface com.pnfsoftware.jeb.core.units.IUnit
From interface com.pnfsoftware.jeb.util.events.IEventSource

Public Methods

public abstract Document getDocument ()

Retrieve the XML document.

public abstract Object getItemObject (long id)

Optionally provide an object associated with the given item. This method may return null, an opaque object, or an object defined by the contract of the implementing object or sub-interface. The SPI of sub-interfaces should specify the item id formats, if any, as well as types and semantics associated with the objects returned by this method.

Parameters
id the item id
Returns
  • if the item id refers to a non-attribute value node, the return value is an org.w3c.dom.Node object; if the item id refers to an attribute value, the return value is a 2-element array containing: the org.w3c.dom.Attr node object; the attribute value as a String object