com.ibm.mm.sdk.xml

Class DKXMLDOMItem

  1. java.lang.Object
  2. extended bycom.ibm.mm.sdk.xml.DKXMLItem
  3. extended bycom.ibm.mm.sdk.xml.DKXMLDOMItem
  1. public class DKXMLDOMItem
  2. extends DKXMLItem
This class extends DKXMLItem and is a container class for XML documents in DOM format. This class inherits implementation to manipulate resource objects from the super class, DKXMLItem. On a call to extract() in DKXMLDataInstanceService, you can pass in the DK_CM_XML_DOM_FORMAT option to indicate that you want the XML item in DOM format. On a call to ingest() in DKXMLDataInstanceService, you can create an instance of this and set the XML document, system properties, links information and resource objects, and pass as input to ingest().

The system properties, links information and/or resource objects can be specified in a separate XML document for ingest() using the setItemProperties() method. Similarly, a different option can be specified (such as DK_CM_XML_SYSTEM_PROPERTY_REFERENCE) to export the properties in a separate XML document in extract(). A user can retrieve such information using the getItemProperties() method.
Since:
Version 8.3

Constructor Summary

Constructor and Description
DKXMLDOMItem()
constructor - create a DKXMLDOMItem object
DKXMLDOMItem(org.w3c.dom.Document xmlDOM)
constructor - create a DKXMLDOMItem object and set the XML document in DOM format.
DKXMLDOMItem(org.w3c.dom.Document xmlDOM,org.w3c.dom.Document sysProp)
constructor - create a DKXMLDOMItem object and sets the XML document and system properties in the DOM format.

Method Summary

Modifier and Type Method and Description
  1. void
 convertToStream(org.w3c.dom.Document domObj,java.io.OutputStream outStream)
Convert a DOM object to an output stream object.
  1. org.w3c.dom.Document
 getItemProperties()
Return an XML document which contains system, resource and/or links properties of item in DOM format.
  1. org.w3c.dom.Document
 getXMLItem()
Return XMLized item in DOM format.
  1. void
 setItemProperties(org.w3c.dom.Document sysProp)
Set the XML document which contains system, resource and/or links properties of item in DOM format
  1. void
 setXMLItem(org.w3c.dom.Document xmlDOM)
Set the XML item in DOM format
Methods inherited from class com.ibm.mm.sdk.xml.DKXMLItem
getContentAsStream, getContentLabels, getContentLength, setContentAsStream, setContentAsStream
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DKXMLDOMItem

  1. public DKXMLDOMItem()
  2. throws DKXMLException
constructor - create a DKXMLDOMItem object
Throws:
DKXMLException

DKXMLDOMItem

  1. public DKXMLDOMItem(org.w3c.dom.Document xmlDOM)
  2. throws DKXMLException
constructor - create a DKXMLDOMItem object and set the XML document in DOM format.
Parameters:
xmlDOM - a DOM object representing an XML item).
Throws:
DKXMLException

DKXMLDOMItem

  1. public DKXMLDOMItem(org.w3c.dom.Document xmlDOM,
  2. org.w3c.dom.Document sysProp)
  3. throws DKXMLException
constructor - create a DKXMLDOMItem object and sets the XML document and system properties in the DOM format.
Parameters:
xmlDOM - DOM object representing an XML item.
sysProp - DOM object representing system properties of the XML item.
Throws:
DKXMLException

Method Detail

getXMLItem

  1. public org.w3c.dom.Document getXMLItem( )
  2. throws DKXMLException
Return XMLized item in DOM format.
Returns:
xmlSource - XMLized item in DOM format.
Throws:
DKXMLException

getItemProperties

  1. public org.w3c.dom.Document getItemProperties( )
  2. throws DKXMLException
Return an XML document which contains system, resource and/or links properties of item in DOM format.
Returns:
sysProperty - XMLized properties of item in DOM format.
Throws:
DKXMLException

setXMLItem

  1. public void setXMLItem(org.w3c.dom.Document xmlDOM)
  2. throws DKXMLException
Set the XML item in DOM format
Parameters:
xmlDOM - an XML item
Throws:
DKXMLException

setItemProperties

  1. public void setItemProperties(org.w3c.dom.Document sysProp)
  2. throws DKXMLException
Set the XML document which contains system, resource and/or links properties of item in DOM format
Parameters:
sysProp - an XML document containing the properties
Throws:
DKXMLException

convertToStream

  1. public void convertToStream(org.w3c.dom.Document domObj,
  2. java.io.OutputStream outStream)
  3. throws DKXMLException
Convert a DOM object to an output stream object. The output stream is created and passed in as one of the input parameters.
Parameters:
domObj - DOM object to be converted into output stream
outStream - output stream into which DOM object is to be written.
Throws:
DKXMLException