|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectes.unex.sextante.parameters.Parameter
es.unex.sextante.parameters.ParameterDataObject
public abstract class ParameterDataObject
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 |
---|
public ParameterDataObject()
Method Detail |
---|
public abstract java.lang.String getParameterTypeName()
Parameter
getParameterTypeName
in class Parameter
public abstract boolean setParameterValue(java.lang.Object value)
Parameter
setParameterValue
in class Parameter
value
- the new value of the parameter
public abstract boolean setParameterAdditionalInfo(AdditionalInfo additionalInfo)
Parameter
setParameterAdditionalInfo
in class Parameter
additionalInfo
- the additional info for this parameter
AdditionalInfo
public int getParameterValueAsInt() throws WrongParameterTypeException
Parameter
getParameterValueAsInt
in class Parameter
WrongParameterTypeException
- if the value cannot be
returned as an integerpublic double getParameterValueAsDouble() throws WrongParameterTypeException
Parameter
getParameterValueAsDouble
in class Parameter
WrongParameterTypeException
- if the parameter cannot be
returned as an doublepublic boolean getParameterValueAsBoolean() throws WrongParameterTypeException
Parameter
getParameterValueAsBoolean
in class Parameter
WrongParameterTypeException
- if the value cannot be
returned as a boolean valuepublic java.lang.String getParameterValueAsString() throws WrongParameterTypeException
Parameter
getParameterValueAsString
in class Parameter
WrongParameterTypeException
- if the parameter cannot be
returned as a stringpublic java.awt.geom.Point2D getParameterValueAsPoint() throws WrongParameterTypeException
Parameter
getParameterValueAsPoint
in class Parameter
WrongParameterTypeException
- if the parameter cannot be
returned as a point
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |