|
||||||||||
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.ParameterBand
public class ParameterBand
A parameter representing a band in a raster layer
Constructor Summary | |
---|---|
ParameterBand()
|
Method Summary | |
---|---|
static Parameter |
deserialize(org.kxml2.io.KXmlParser parser)
|
java.lang.String |
getCommandLineParameter()
Returns the value of the parameter as a command-line parameter |
java.lang.Class |
getParameterClass()
Returns the class of the value represented by this parameter |
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.util.ArrayList |
getParameterValueAsMultipleRasterLayer()
|
java.util.ArrayList |
getParameterValueAsMultipleTable()
|
java.util.ArrayList |
getParameterValueAsMultipleVectorLayer()
|
java.awt.geom.Point2D |
getParameterValueAsPoint()
Returns the value of the parameter as a point |
IRasterLayer |
getParameterValueAsRasterLayer()
Returns the value of the parameter as a raster layer |
java.lang.String |
getParameterValueAsString()
Returns the value of the parameter as a string |
ITable |
getParameterValueAsTable()
Returns the value of the parameter as a table |
IVectorLayer |
getParameterValueAsVectorLayer()
Returns the value of the parameter as a vector layer |
boolean |
isParameterValueCorrect()
Returns true if the value assigned to this parameter is valid |
boolean |
setParameterAdditionalInfo(AdditionalInfo additionalInfo)
Set the additional information for this parameter |
boolean |
setParameterValue(int iValue)
|
boolean |
setParameterValue(java.lang.Object value)
Sets the value of the parameter |
Methods inherited from class es.unex.sextante.parameters.Parameter |
---|
getNewInstance, getParameterAdditionalInfo, getParameterDescription, getParameterName, getParameterValueAsArrayList, getParameterValueAsObject, serialize, setParameterDescription, setParameterName, toString |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ParameterBand()
Method Detail |
---|
public java.lang.String getParameterTypeName()
Parameter
getParameterTypeName
in class Parameter
public IRasterLayer getParameterValueAsRasterLayer() throws WrongParameterTypeException
Parameter
getParameterValueAsRasterLayer
in class Parameter
WrongParameterTypeException
- if the parameter cannot be
returned as a raster layerpublic ITable getParameterValueAsTable() throws WrongParameterTypeException
Parameter
getParameterValueAsTable
in class Parameter
WrongParameterTypeException
- if the parameter cannot be
returned as a tablepublic IVectorLayer getParameterValueAsVectorLayer() throws WrongParameterTypeException
Parameter
getParameterValueAsVectorLayer
in class Parameter
WrongParameterTypeException
- if the parameter cannot be
returned as a vector layerpublic java.util.ArrayList getParameterValueAsMultipleRasterLayer() throws WrongParameterTypeException
WrongParameterTypeException
public java.util.ArrayList getParameterValueAsMultipleVectorLayer() throws WrongParameterTypeException
WrongParameterTypeException
public java.util.ArrayList getParameterValueAsMultipleTable() throws WrongParameterTypeException
WrongParameterTypeException
public int getParameterValueAsInt() throws WrongParameterTypeException, NullParameterValueException
Parameter
getParameterValueAsInt
in class Parameter
WrongParameterTypeException
- if the value cannot be
returned as an integer
NullParameterValueException
- if the parameter is nullpublic 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, NullParameterValueException
Parameter
getParameterValueAsString
in class Parameter
WrongParameterTypeException
- if the parameter cannot be
returned as a string
NullParameterValueException
- if the value is nullpublic java.awt.geom.Point2D getParameterValueAsPoint() throws WrongParameterTypeException
Parameter
getParameterValueAsPoint
in class Parameter
WrongParameterTypeException
- if the parameter cannot be
returned as a pointpublic boolean setParameterAdditionalInfo(AdditionalInfo additionalInfo)
Parameter
setParameterAdditionalInfo
in class Parameter
additionalInfo
- the additional info for this parameter
AdditionalInfo
public boolean setParameterValue(java.lang.Object value)
Parameter
setParameterValue
in class Parameter
value
- the new value of the parameter
public boolean setParameterValue(int iValue)
public java.lang.Class getParameterClass()
Parameter
getParameterClass
in class Parameter
public static Parameter deserialize(org.kxml2.io.KXmlParser parser) throws org.xmlpull.v1.XmlPullParserException, java.io.IOException
org.xmlpull.v1.XmlPullParserException
java.io.IOException
public java.lang.String getCommandLineParameter()
Parameter
getCommandLineParameter
in class Parameter
public boolean isParameterValueCorrect()
Parameter
isParameterValueCorrect
in class Parameter
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |