uk.org.ogsadai.client.toolkit.activity.delivery
Class DeliverToFile

java.lang.Object
  |
  +--uk.org.ogsadai.client.toolkit.activity.RequestComponent
        |
        +--uk.org.ogsadai.client.toolkit.activity.Activity
              |
              +--uk.org.ogsadai.client.toolkit.activity.delivery.DeliverToFile

public class DeliverToFile

extends Activity

This activity delivers data to a file within a data service's file system.

It has one input - the data to be delivered - and no output.

Author:

The OGSA-DAI Project Team

Field Summary

private static java.lang.String	COPYRIGHT_NOTICE Copyright statement
private java.lang.String	mFile Destination File.

Fields inherited from class uk.org.ogsadai.client.toolkit.activity.Activity

Fields inherited from class uk.org.ogsadai.client.toolkit.activity.RequestComponent

Constructor Summary

DeliverToFile()
Constructs a request to deliver data to a file within the service's filesystem.

DeliverToFile(java.lang.String file)
Constructs a request to deliver data to a file within the service's filesystem.

Method Summary

protected java.lang.String	generateXML() Generates the XML representing the activity.
void	setFile(java.lang.String file) Sets the file.
void	setInput(ActivityOutput input) Sets the input of this activity to be the output from another activity that will provide the data to be stored.

Methods inherited from class uk.org.ogsadai.client.toolkit.activity.Activity

addInput, addOutput, addOutputs, getDataResourceID, getInputParameters, getOutputParameters, getOutputs, replaceSpecialCharacters, setDataResourceID, setInput

Methods inherited from class uk.org.ogsadai.client.toolkit.activity.RequestComponent

getDataService, getName, getSession, setDataService, setSession

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT_NOTICE

private static final java.lang.String COPYRIGHT_NOTICE

Copyright statement

See Also:

Constant Field Values

mFile

private java.lang.String mFile

Destination File.

Constructor Detail

DeliverToFile

public DeliverToFile()

Constructs a request to deliver data to a file within the service's filesystem.

The file name must be set using setFile. The activity providing the input data must be set using setInput.

DeliverToFile

public DeliverToFile(java.lang.String file)

Constructs a request to deliver data to a file within the service's filesystem. The activity providing the input data must be set using setInput.

Parameters:

file - The file.

Throws:

java.lang.IllegalArgumentException - If file is null or the empty string.

Method Detail

setInput

public final void setInput(ActivityOutput input)

Sets the input of this activity to be the output from another activity that will provide the data to be stored.

Parameters:

input - Output from another activity.

Throws:

java.lang.IllegalArgumentException - If input is null.

setFile

public void setFile(java.lang.String file)

Sets the file.

Parameters:

file - The file.

Throws:

java.lang.IllegalArgumentException - If file is null or the empty string.

generateXML

protected java.lang.String generateXML()

Description copied from class: RequestComponent

Generates the XML representing the activity. This XML can then be inserted into a perform document that is sent to a data service.

Specified by:

generateXML in class Activity

Returns:

the XML for the activity

See Also:

Activity.generateXML()