org.dlese.dpc.ndr.apiproxy

Class InputXMLComponent

java.lang.Object

org.dlese.dpc.ndr.apiproxy.InputXMLComponent

Direct Known Subclasses:

DataComponent

public class InputXMLComponent
extends java.lang.Object

Wrapper for the three main components of the InputXML Object (Data, Properties, and Relationships). For the specification of InputXML and it's components, see API Basics in the NDR API Documentation.

InputXMLComponents consist of "commands", which specify criteria that is used for selection of, or assignment to NDR Objects. For example, the commands in the "find" request are used to select objects from the NDR, while the commands in the "addMetadata" request assign values to the Metadata object to be created.

The Component is represented as a dom4j.Element, with individual commands as subelements.

Version:

$Id: InputXMLComponent.java,v 1.3 2007/07/13 22:18:43 ostwald Exp $

Author:

ostwald

$Id $

Field Summary

Fields

Modifier and Type	Field and Description
org.dom4j.Element	component NOT YET DOCUMENTED
java.lang.String	name NOT YET DOCUMENTED

Constructor Summary

Constructors

Constructor and Description
InputXMLComponent(java.lang.String name) Constructor for the InputXMLComponent object of specified type ("relationship"

Method Summary

Modifier and Type	Method and Description
void	addCommand(org.dom4j.Element e, java.lang.String action) Adds a feature to the Command attribute of the InputXMLComponent object
void	addCommand(java.lang.String prop, java.lang.String value) Adds a feature to the Command attribute of the InputXMLComponent object
void	addCommand(java.lang.String prop, java.lang.String value, java.lang.String action) Adds a feature to the Command attribute of the InputXMLComponent object.
org.dom4j.Element	asElement() NOT YET DOCUMENTED
protected org.dom4j.Element	getCommandParent(java.lang.String cmd) Gets the commandParent attribute of the InputXMLComponent object
protected static void	pp(org.dom4j.Node n) NOT YET DOCUMENTED
protected static void	prtln(java.lang.String s) Description of the Method

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

NOT YET DOCUMENTED

component

public org.dom4j.Element component

NOT YET DOCUMENTED

Constructor Detail

InputXMLComponent

public InputXMLComponent(java.lang.String name)

Constructor for the InputXMLComponent object of specified type ("relationship"

Parameters:

name - NOT YET DOCUMENTED

Method Detail

addCommand

public void addCommand(java.lang.String prop,
                       java.lang.String value)

Adds a feature to the Command attribute of the InputXMLComponent object

Parameters:

prop - The feature to be added to the Command attribute

value - The feature to be added to the Command attribute

addCommand

public void addCommand(java.lang.String prop,
                       java.lang.String value,
                       java.lang.String action)

Adds a feature to the Command attribute of the InputXMLComponent object.

NOTE: Attempting to set a null value will cause the command to fail silently ...

Parameters:

prop - The feature to be added to the Command attribute

value - The feature to be added to the Command attribute

action - The feature to be added to the Command attribute

addCommand

public void addCommand(org.dom4j.Element e,
                       java.lang.String action)

Adds a feature to the Command attribute of the InputXMLComponent object

Parameters:

e - The feature to be added to the Command attribute

action - The feature to be added to the Command attribute

getCommandParent

protected org.dom4j.Element getCommandParent(java.lang.String cmd)

Gets the commandParent attribute of the InputXMLComponent object

Parameters:

cmd - NOT YET DOCUMENTED

Returns:

The commandParent value

asElement

public org.dom4j.Element asElement()

NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

pp

protected static void pp(org.dom4j.Node n)

NOT YET DOCUMENTED

Parameters:

n - NOT YET DOCUMENTED

prtln

protected static void prtln(java.lang.String s)

Description of the Method

Parameters:

s - Description of the Parameter