org.dlese.dpc.ndr.apiproxy

Class InputXML

java.lang.Object

org.dlese.dpc.ndr.apiproxy.InputXML

public class InputXML
extends java.lang.Object

Class representing the payload for most NdrRequests. See NDR APIBasics for more information about the InputXML parameter.

Author:

ostwald

Constructor Summary

Constructors

Constructor and Description
InputXML(NDRConstants.NDRObjectType objectType) Constructor for the InputXML object for the specified NDR object type.

Method Summary

Modifier and Type	Method and Description
org.dom4j.Document	asDocument() Get an org.dom4j.Document representation of the inputXML.
java.lang.String	asXML() Returns a String representation of the InputXML instance for use as a NdrRequest parameter.
DataComponent	getData() Gets the data component of the InputXML object.
InputXMLComponent	getProperties() Gets the properties component of the InputXML object.
InputXMLComponent	getRelationships() Gets the relationships component of the InputXML object
static void	main(java.lang.String[] args) The main program for the InputXML class

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InputXML

public InputXML(NDRConstants.NDRObjectType objectType)

Constructor for the InputXML object for the specified NDR object type.

Parameters:

objectType - NOT YET DOCUMENTED

Method Detail

getProperties

public InputXMLComponent getProperties()

Gets the properties component of the InputXML object.

Returns:

The properties component.

getRelationships

public InputXMLComponent getRelationships()

Gets the relationships component of the InputXML object

Returns:

the Relationships component.

getData

public DataComponent getData()

Gets the data component of the InputXML object. This is where the data streams & serviceDescriptions are located.

Returns:

The data component.

asDocument

public org.dom4j.Document asDocument()

Get an org.dom4j.Document representation of the inputXML.

Returns:

NOT YET DOCUMENTED

asXML

public java.lang.String asXML()

Returns a String representation of the InputXML instance for use as a NdrRequest parameter.

Returns:

inputXML as XML string

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

The main program for the InputXML class

Parameters:

args - The command line arguments

Throws:

java.lang.Exception - NOT YET DOCUMENTED