es.unex.sextante.parameters
Class ParameterDataObject

java.lang.Object
  extended by es.unex.sextante.parameters.Parameter
      extended by es.unex.sextante.parameters.ParameterDataObject
Direct Known Subclasses:
ParameterRasterLayer, ParameterTable, ParameterVectorLayer

public abstract class ParameterDataObject
extends Parameter


Constructor Summary
ParameterDataObject()
           
 
Method Summary
abstract  java.lang.String getParameterTypeName()
          Returns the name used to identify the parameter in the parameters set
 boolean getParameterValueAsBoolean()
          Returns the value of the parameter as a boolean value
 double getParameterValueAsDouble()
          Returns the value of the parameter as a double
 int getParameterValueAsInt()
          Returns the value of the parameter as an integer
 java.awt.geom.Point2D getParameterValueAsPoint()
          Returns the value of the parameter as a point
 java.lang.String getParameterValueAsString()
          Returns the value of the parameter as a string
abstract  boolean setParameterAdditionalInfo(AdditionalInfo additionalInfo)
          Set the additional information for this parameter
abstract  boolean setParameterValue(java.lang.Object value)
          Sets the value of the parameter
 
Methods inherited from class es.unex.sextante.parameters.Parameter
deserialize, getCommandLineParameter, getNewInstance, getParameterAdditionalInfo, getParameterClass, getParameterDescription, getParameterName, getParameterValueAsArrayList, getParameterValueAsObject, getParameterValueAsRasterLayer, getParameterValueAsTable, getParameterValueAsVectorLayer, isParameterValueCorrect, serialize, setParameterDescription, setParameterName, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ParameterDataObject

public ParameterDataObject()
Method Detail

getParameterTypeName

public abstract java.lang.String getParameterTypeName()
Description copied from class: Parameter
Returns the name used to identify the parameter in the parameters set

Specified by:
getParameterTypeName in class Parameter
Returns:
the name of the parameter

setParameterValue

public abstract boolean setParameterValue(java.lang.Object value)
Description copied from class: Parameter
Sets the value of the parameter

Specified by:
setParameterValue in class Parameter
Parameters:
value - the new value of the parameter
Returns:
true if the value is a correct one and could be assigned

setParameterAdditionalInfo

public abstract boolean setParameterAdditionalInfo(AdditionalInfo additionalInfo)
Description copied from class: Parameter
Set the additional information for this parameter

Specified by:
setParameterAdditionalInfo in class Parameter
Parameters:
additionalInfo - the additional info for this parameter
Returns:
true it the passed additional info can be assigned to this parameter
See Also:
AdditionalInfo

getParameterValueAsInt

public int getParameterValueAsInt()
                           throws WrongParameterTypeException
Description copied from class: Parameter
Returns the value of the parameter as an integer

Specified by:
getParameterValueAsInt in class Parameter
Returns:
the value of the parameter as an integer
Throws:
WrongParameterTypeException - if the value cannot be returned as an integer

getParameterValueAsDouble

public double getParameterValueAsDouble()
                                 throws WrongParameterTypeException
Description copied from class: Parameter
Returns the value of the parameter as a double

Specified by:
getParameterValueAsDouble in class Parameter
Returns:
the value of the parameter as a double
Throws:
WrongParameterTypeException - if the parameter cannot be returned as an double

getParameterValueAsBoolean

public boolean getParameterValueAsBoolean()
                                   throws WrongParameterTypeException
Description copied from class: Parameter
Returns the value of the parameter as a boolean value

Specified by:
getParameterValueAsBoolean in class Parameter
Returns:
the value of the parameter as a boolean value
Throws:
WrongParameterTypeException - if the value cannot be returned as a boolean value

getParameterValueAsString

public java.lang.String getParameterValueAsString()
                                           throws WrongParameterTypeException
Description copied from class: Parameter
Returns the value of the parameter as a string

Specified by:
getParameterValueAsString in class Parameter
Returns:
the value of the parameter as a string
Throws:
WrongParameterTypeException - if the parameter cannot be returned as a string

getParameterValueAsPoint

public java.awt.geom.Point2D getParameterValueAsPoint()
                                               throws WrongParameterTypeException
Description copied from class: Parameter
Returns the value of the parameter as a point

Specified by:
getParameterValueAsPoint in class Parameter
Returns:
the value of the parameter as a point
Throws:
WrongParameterTypeException - if the parameter cannot be returned as a point