org.dlese.dpc.ndr.apiproxy

Class DataComponent

java.lang.Object

org.dlese.dpc.ndr.apiproxy.InputXMLComponent

org.dlese.dpc.ndr.apiproxy.DataComponent

public class DataComponent
extends InputXMLComponent

Version:

$Id: DataComponent.java,v 1.2 2009/03/20 23:33:53 jweather Exp $

Author:

ostwald

$Id $

Field Summary

Fields inherited from class org.dlese.dpc.ndr.apiproxy.InputXMLComponent

component, name

Constructor Summary

Constructors

Constructor and Description
DataComponent() Constructor for the DataComponent object

Method Summary

Modifier and Type	Method and Description
void	addDataStreamCmd(java.lang.String format, org.dom4j.Element content) Adds a DataStream command to the DataComponent with default action.
void	addDataStreamCmd(java.lang.String format, org.dom4j.Element content, java.lang.String action) Adds a DataStream command to the DataComponent with specified action.
void	setInfoStream(java.lang.String format, org.dom4j.Element info) Inserts the provided info stream element into the datastream designated by "format".

Methods inherited from class org.dlese.dpc.ndr.apiproxy.InputXMLComponent

addCommand, addCommand, addCommand, asElement, getCommandParent, pp, prtln

Methods inherited from class java.lang.Object

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

Constructor Detail

DataComponent

public DataComponent()

Constructor for the DataComponent object

Method Detail

addDataStreamCmd

public void addDataStreamCmd(java.lang.String format,
                             org.dom4j.Element content)
                      throws java.lang.Exception

Adds a DataStream command to the DataComponent with default action.

Parameters:

format - The feature to be added to the DataStreamCmd attribute

content - The feature to be added to the DataStreamCmd attribute

Throws:

java.lang.Exception - NOT YET DOCUMENTED

setInfoStream

public void setInfoStream(java.lang.String format,
                          org.dom4j.Element info)
                   throws java.lang.Exception

Inserts the provided info stream element into the datastream designated by "format".

Parameters:

format - data stream in which to insert info

info - the info stream Element

Throws:

java.lang.Exception - if datastream does not exist for "format"

addDataStreamCmd

public void addDataStreamCmd(java.lang.String format,
                             org.dom4j.Element content,
                             java.lang.String action)
                      throws java.lang.Exception

Adds a DataStream command to the DataComponent with specified action.

Parameters:

format - datastream format (e.g., "nsdl_dc")

content - the datastream content

action - the command action (e.g., "add", "delete") or null (the default).

Throws:

java.lang.Exception - If datastream element is null.