com.esri.core.map
Class RasterFunction

java.lang.Object
  extended by com.esri.core.map.RasterFunction
All Implemented Interfaces:
Serializable

public class RasterFunction
extends Object
implements Serializable

Specifies the processing to be done to the image service. There are different kinds of Raster Functions. Here is an example of how to construct the Shaded Relief rendering rule.

Java usage:


        String argument = " {\"Azimuth\" : 215.0,\"Altitude\" : 60.0,\"ZFactor\" : 5,\"Colormap\" : [[0, 1, 2, 3],  [2, 45, 52, 13]]}";                                 
        RasterFunction renderingRule = new RasterFunction();                            
        renderingRule.setFunctionName("ShadedRelief");
        renderingRule.setArguments(argument);
        renderingRule.setVariableName("Raster");
        imageServiceLayer.setRenderingRule(renderingRule);
        imageServiceLayer.refresh();

See Also:
Serialized Form

Constructor Summary
RasterFunction()
          Instantiates an object of RasterFunction.
RasterFunction(RasterFunction params)
          Copies the properties from the given RasterFunction to the current instance.
 
Method Summary
 boolean equals(Object obj)
           
 String getArguments()
          Gets the input arguments to the raster function.
 String getFunctionName()
          Gets the functionName of the RasterFunction.
 String getVariableName()
          Gets the variableName of the RasterFunction.
 int hashCode()
           
 void setArguments(String arguments)
          Sets the input arguments to the raster function.
 void setFunctionName(String functionName)
          Sets the functionName of the RasterFunction.
 void setVariableName(String variableName)
          Sets the variableName of the RasterFunction.
 String toJson()
          Converts the instance to a Json string.
 String toString()
          Returns a string containing function name, arguments and variable name.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RasterFunction

public RasterFunction()
Instantiates an object of RasterFunction.


RasterFunction

public RasterFunction(RasterFunction params)
Copies the properties from the given RasterFunction to the current instance.

Parameters:
params - the RasterFunction to copy from.
Method Detail

getFunctionName

public String getFunctionName()
Gets the functionName of the RasterFunction.

Returns:
Returns the functionName.

setFunctionName

public void setFunctionName(String functionName)
Sets the functionName of the RasterFunction.

Parameters:
functionName - The functionName to set.

getArguments

public String getArguments()
Gets the input arguments to the raster function. For example, clipping geometry for the ClipFunction. The arguments is a Json string representing the argument object.

Returns:
Returns the arguments as a Json string representing the argument object.

setArguments

public void setArguments(String arguments)
Sets the input arguments to the raster function. For example, clipping geometry for the ClipFunction.

Parameters:
arguments - The arguments to set, which is a Json string representing the argument object.

getVariableName

public String getVariableName()
Gets the variableName of the RasterFunction.

Returns:
Returns the variableName.

setVariableName

public void setVariableName(String variableName)
Sets the variableName of the RasterFunction.

Parameters:
variableName - The variableName to set.

toJson

public String toJson()
              throws org.codehaus.jackson.JsonGenerationException,
                     IOException
Converts the instance to a Json string.

Returns:
the Json string.
Throws:
org.codehaus.jackson.JsonGenerationException
IOException

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

toString

public String toString()
Returns a string containing function name, arguments and variable name.

Overrides:
toString in class Object


Copyright © 2012. All Rights Reserved.