Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

uk.org.ogsadai.client.toolkit.activity.files
Class CopyFile

java.lang.Object
  |
  +--uk.org.ogsadai.client.toolkit.activity.RequestComponent
        |
        +--uk.org.ogsadai.client.toolkit.activity.Activity
              |
              +--uk.org.ogsadai.client.toolkit.activity.files.CopyFile
public class CopyFile
extends Activity

Copies a file.

Author:
The OGSA-DAI Team.

Field Summary
private static java.lang.String COPYRIGHT_NOTICE
          Copyright statement
private  java.lang.String mDestination
          path of the copy
private  java.lang.String mSource
          relative path of file to be copied
 
Fields inherited from class uk.org.ogsadai.client.toolkit.activity.Activity
 
Fields inherited from class uk.org.ogsadai.client.toolkit.activity.RequestComponent
 
Constructor Summary
CopyFile()
          Construct a new activity instance which copies a file.
CopyFile(java.lang.String fromPath, java.lang.String toPath)
          Construct a new activity instance which copies the given file to the specified destination.
 
Method Summary
protected  java.lang.String generateXML()
          Generates the XML representing the activity.
 java.lang.String getDestination()
          Returns the destination path of the copy.
 java.lang.String getSource()
          Returns the path of the file to be copied.
 void setDestination(java.lang.String path)
           
 void setSource(java.lang.String path)
          Set the relative path of the file to delete.
 
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

mSource

private java.lang.String mSource
relative path of file to be copied

mDestination

private java.lang.String mDestination
path of the copy

Constructor Detail

CopyFile

public CopyFile()
Construct a new activity instance which copies a file.

CopyFile

public CopyFile(java.lang.String fromPath,
                java.lang.String toPath)
Construct a new activity instance which copies the given file to the specified destination.

Parameters:
fromPath - origin of the file to be copies
toPath - destination of the file to be copied
Method Detail

setSource

public void setSource(java.lang.String path)
Set the relative path of the file to delete.

Parameters:
path - file to delete

setDestination

public void setDestination(java.lang.String path)

getSource

public java.lang.String getSource()
Returns the path of the file to be copied.

Returns:
file path

getDestination

public java.lang.String getDestination()
Returns the destination path of the copy.

Returns:
destination path

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
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD