com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class ApplySymbologyFromLayer

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.datamanagementtools.ApplySymbologyFromLayer
All Implemented Interfaces:
GPTool

public class ApplySymbologyFromLayer
extends AbstractGPTool

This tool applies the The Apply Symbology From Layer tool is contained in the Data Management Tools tool box.

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
ApplySymbologyFromLayer()
          Creates the Apply Symbology From Layer tool with defaults.
ApplySymbologyFromLayer(Object inLayer, Object inSymbologyLayer)
          Creates the Apply Symbology From Layer tool with the required parameters.
 
Method Summary
 Object getInLayer()
          Returns the Input Layer parameter of this tool .
 Object getInSymbologyLayer()
          Returns the Symbology Layer parameter of this tool .
 Object getOutLayer()
          Returns the Output Layer parameter of this tool (Read only).
 String getToolboxAlias()
          Returns the alias of the tool box containing this tool.
 String getToolboxName()
          Returns the name of the tool box containing this tool.
 String getToolName()
          Returns the name of this tool.
 void setInLayer(Object inLayer)
          Sets the Input Layer parameter of this tool .
 void setInSymbologyLayer(Object inSymbologyLayer)
          Sets the Symbology Layer parameter of this tool .
 
Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
getParameterValues, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ApplySymbologyFromLayer

public ApplySymbologyFromLayer()
Creates the Apply Symbology From Layer tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.


ApplySymbologyFromLayer

public ApplySymbologyFromLayer(Object inLayer,
                               Object inSymbologyLayer)
Creates the Apply Symbology From Layer tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:
inLayer - Feature Layer | Raster Layer | TIN Layer | Network Analysis Layer, the layer to which the symbology will be applied.
inSymbologyLayer - Feature Layer | Raster Layer | TIN Layer | Network Analysis Layer, the symbology of this layer is applied to the Input Layer.
Method Detail

getInLayer

public Object getInLayer()
Returns the Input Layer parameter of this tool . This parameter is Feature Layer | Raster Layer | TIN Layer | Network Analysis Layer, the layer to which the symbology will be applied. This is a required parameter.

Returns:
the Input Layer

setInLayer

public void setInLayer(Object inLayer)
Sets the Input Layer parameter of this tool . This parameter is Feature Layer | Raster Layer | TIN Layer | Network Analysis Layer, the layer to which the symbology will be applied. This is a required parameter.

Parameters:
inLayer - Feature Layer | Raster Layer | TIN Layer | Network Analysis Layer, the layer to which the symbology will be applied.

getInSymbologyLayer

public Object getInSymbologyLayer()
Returns the Symbology Layer parameter of this tool . This parameter is Feature Layer | Raster Layer | TIN Layer | Network Analysis Layer, the symbology of this layer is applied to the Input Layer. This is a required parameter.

Returns:
the Symbology Layer

setInSymbologyLayer

public void setInSymbologyLayer(Object inSymbologyLayer)
Sets the Symbology Layer parameter of this tool . This parameter is Feature Layer | Raster Layer | TIN Layer | Network Analysis Layer, the symbology of this layer is applied to the Input Layer. This is a required parameter.

Parameters:
inSymbologyLayer - Feature Layer | Raster Layer | TIN Layer | Network Analysis Layer, the symbology of this layer is applied to the Input Layer.

getOutLayer

public Object getOutLayer()
Returns the Output Layer parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Layer

getToolName

public String getToolName()
Returns the name of this tool.

Returns:
the tool name

getToolboxName

public String getToolboxName()
Returns the name of the tool box containing this tool.

Returns:
the tool box name

getToolboxAlias

public String getToolboxAlias()
Returns the alias of the tool box containing this tool.

Returns:
the tool box alias