public class XMLHandler extends java.lang.Object implements FormatDataHandler
XMLHandler
class XML data formats. XML handler can extract
data from an XML data stream.
Since the way XSDHandler
class handles the leaf element, we
handle it in the corresponding way:
Example 1:
Modifier and Type | Class and Description |
---|---|
class |
XMLHandler.XMLDataEvent
Event that the CSV handler sends during processing csv data.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EV_EOD
End of data event.
|
static java.lang.String |
REFERENCE_ROOT |
static java.lang.String |
STRUCTURE_V2
client key to provide if the result map should contain result map or not.
|
Constructor and Description |
---|
XMLHandler(java.io.InputStream is,
boolean supportStreaming)
Creates a data handler for XML data type.
|
XMLHandler(java.io.InputStream is,
java.io.InputStream xsltStream,
boolean supportStreaming)
Creates a data handler for XML data type.
|
XMLHandler(java.io.InputStream is,
java.io.InputStream xsltStream,
boolean supportStreaming,
boolean normalize)
Creates a data handler for XML data type.
|
XMLHandler(org.w3c.dom.Node root)
Creates an XML data handler for a DOM node.
|
XMLHandler(org.w3c.dom.Node root,
java.io.Reader xslTransform)
Instantiate this XMLHandler for the root node and an optional
transformation to be applied on the root node.
|
Modifier and Type | Method and Description |
---|---|
java.util.List |
getResult(java.util.Map params)
Returns the resulting data extracted from the input.
|
java.lang.Object |
getResult(java.util.Map params,
java.lang.String returnType)
Returns the resulting data extracted from the input.
|
java.lang.Object |
getResultObject(java.util.Map params)
Deprecated.
|
void |
setDataEventListener(FormatDataEventListener listener)
Sets the data event listener.
|
public static final java.lang.String EV_EOD
public static final java.lang.String REFERENCE_ROOT
public static final java.lang.String STRUCTURE_V2
public XMLHandler(java.io.InputStream is, boolean supportStreaming)
is
- input stream of the data.supportStreaming
- if to support the streaming fetch of the data.
If this value is false, the XML data is loaded as a DOM tree.AdapterException
- if falis to load the DOM tree from the
input stream.public XMLHandler(java.io.InputStream is, java.io.InputStream xsltStream, boolean supportStreaming)
is
- input stream of the data.xsltStream
- stream of the xslt definitionsupportStreaming
- if to support the streaming fetch of the data.
If this value is false, the XML data is loaded as a DOM tree.AdapterException
- if falis to load the DOM tree from the
input stream.public XMLHandler(java.io.InputStream is, java.io.InputStream xsltStream, boolean supportStreaming, boolean normalize)
is
- input stream of the data.xsltStream
- stream of the xslt definitionsupportStreaming
- if to support the streaming fetch of the data.
If this value is false, the XML data is loaded as a DOM tree.normalize
- if node names are to be noramlized as per JSR227 standardAdapterException
- if falis to load the DOM tree from the
input stream.public XMLHandler(org.w3c.dom.Node root)
root
- the root node of the data.public XMLHandler(org.w3c.dom.Node root, java.io.Reader xslTransform) throws AdapterException
root
- The root data node for this format handler instancexslTransform
- The Transformation Reader that references the
XSL transformation to be applied on this root
node.{@link
- AdapterException} if the transformation cannot be
applied on the root node.AdapterException
public void setDataEventListener(FormatDataEventListener listener)
public java.lang.Object getResult(java.util.Map params, java.lang.String returnType)
getResult
in interface FormatDataHandler
params
- parameters passed containig the context information.returnType
- data type of the returned value. This can be passed as null.
If no return type is specified, an Iterator of Map will be returned.returnType
parameter.
If the type is available, an instance of that object is created. If no
type is specified an Iterator
of Map
objects
for the result will be created.
If no data found it can return null. The Map
contains the value of attributes as defined in the data structure.
For complex data, Map
s can contain other
Map
s as well.public java.util.List getResult(java.util.Map params)
params
- parameters passed containig the context information.List
objects for the result. .
If no data found it can return null. The Map
contains the value of attributes as defined in the data structure.
For complex data, Map
s can contain other iterator of
Map
s as well.@Deprecated public java.lang.Object getResultObject(java.util.Map params)
params
- parameters passed containig the context information.Map
objects for the result. If result is scalar, returns just the scalar.
If no data found it can return null. The Map
contains the value of attributes as defined in the data structure.
For complex data, Map
s can contain other iterator of
Map
s as well.