|
||||||||||
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
es.unex.sextante.parameters.ParameterRasterLayer
public class ParameterRasterLayer
A parameter representing a raster layer
Constructor Summary | |
---|---|
ParameterRasterLayer()
|
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 |
IRasterLayer |
getParameterValueAsRasterLayer()
Returns the value of the parameter as a raster layer |
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(java.lang.Object value)
Sets the value of the parameter |
Methods inherited from class es.unex.sextante.parameters.ParameterDataObject |
---|
getParameterValueAsBoolean, getParameterValueAsDouble, getParameterValueAsInt, getParameterValueAsPoint, getParameterValueAsString |
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 ParameterRasterLayer()
Method Detail |
---|
public java.lang.String getParameterTypeName()
Parameter
getParameterTypeName
in class ParameterDataObject
public IRasterLayer getParameterValueAsRasterLayer() throws NullParameterValueException
Parameter
getParameterValueAsRasterLayer
in class Parameter
NullParameterValueException
- if the value is null and it is
a mandatory 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 boolean setParameterAdditionalInfo(AdditionalInfo additionalInfo)
Parameter
setParameterAdditionalInfo
in class ParameterDataObject
additionalInfo
- the additional info for this parameter
AdditionalInfo
public boolean setParameterValue(java.lang.Object value)
Parameter
setParameterValue
in class ParameterDataObject
value
- the new value of the parameter
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 |