es.unex.sextante.outputs
Class Output

java.lang.Object
  extended by es.unex.sextante.outputs.Output
Direct Known Subclasses:
OutputChart, OutputRasterLayer, OutputTable, OutputText, OutputVectorLayer

public abstract class Output
extends java.lang.Object

This class defines a generic output object Output objects are contained in an OutputObjectsSet and used to define the outputs generated by a geoalgorithm, and also to hold them once the algorithm has created them

Author:
Victor Olaya volaya@unex.es

Constructor Summary
Output()
           
 
Method Summary
abstract  java.lang.String getCommandLineParameter()
          Returns the output as a command-line parameter
 java.lang.String getDescription()
          Returns the description of the output object
 java.lang.String getName()
          Returns the name of the object
 Output getNewInstance()
           
 IOutputChannel getOutputChannel()
          Returns the output channel associated with the output object
 java.lang.Object getOutputObject()
          Returns the value of the output object
abstract  java.lang.String getTypeDescription()
          returns a human-readable description of the type of output
 void setDescription(java.lang.String description)
          Sets a new description for the output object
 void setName(java.lang.String name)
          Sets a new name for the output object
 void setObjectData(Output output)
          Sets the data objects (output channel, name, output object, etc) of this objects from another Output object
 void setOutputChannel(IOutputChannel channel)
          Sets a new output channel associated with this output object
abstract  void setOutputObject(java.lang.Object object)
          Sets a new value for the output object
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Output

public Output()
Method Detail

getNewInstance

public Output getNewInstance()
Returns:
a new instance of the output object

getName

public java.lang.String getName()
Returns the name of the object

Returns:
the name of the object

setName

public void setName(java.lang.String name)
Sets a new name for the output object

Parameters:
name - the new name for the output object

getDescription

public java.lang.String getDescription()
Returns the description of the output object

Returns:
the description of the output object

setDescription

public void setDescription(java.lang.String description)
Sets a new description for the output object

Parameters:
description - the new description for the output object

getOutputObject

public java.lang.Object getOutputObject()
Returns the value of the output object

Returns:
the value of the output object

setOutputObject

public abstract void setOutputObject(java.lang.Object object)
Sets a new value for the output object

Parameters:
object - the new value for the output object

getOutputChannel

public IOutputChannel getOutputChannel()
Returns the output channel associated with the output object

Returns:
the output channel associated with the output object

setOutputChannel

public void setOutputChannel(IOutputChannel channel)
Sets a new output channel associated with this output object

Parameters:
channel - the new output channel associated with this output object

getCommandLineParameter

public abstract java.lang.String getCommandLineParameter()
Returns the output as a command-line parameter

Returns:
the output as a string, to save it as a command-line parameter

setObjectData

public void setObjectData(Output output)
Sets the data objects (output channel, name, output object, etc) of this objects from another Output object

Parameters:
output - the Output object to take data from

getTypeDescription

public abstract java.lang.String getTypeDescription()
returns a human-readable description of the type of output

Returns:
a human-readable description of the type of output