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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.ApplySymbologyFromLayer

All Implemented Interfaces:

GPTool

public class ApplySymbologyFromLayer
extends AbstractGPTool

This tool applies the symbology from a layer to the Input Layer. It can be applied to feature, raster, network analysis, and TIN layer files or layers in the ArcMap table of contents. This tool is primarily for use in scripts or ModelBuilder. The Apply Symbology From Layer tool is contained in the Data Management Tools tool box.

Usage tips:

• In model or script use, the Symbology Layer most often comes from a layer file. The tool or the tool can be used to create a layer to apply symbology. Feature, raster, and TIN layers can also be created by right-clicking the layer in the ArcMap table of contents and clicking Save As Layer File. The layer is then saved in the desired location.
• The Symbology Layer must match the data type of the Input Layer; for example, a feature layer cannot be applied to a raster layer and vice versa.
• The Symbology Layer can only be applied to features of the same geometry; for example, a point layer cannot be applied to a polygon layer.
• The field in the Input Layer that will be displayed must have the same name as that of the corresponding Symbology Layer field. If this field is missing, the output data is drawn with default symbology.
• 3D properties such as extrusion and offset are not supported with this tool.
• Symbology methods can be dynamic; for example, the symbology is updated to reflect the characteristics of the Input Layer as shown in the illustration below. In this example, the five class Natural Breaks classification method from the Symbology Layer is applied to the Input Layer and the range values are updated to reflect the Shape_Area values of the Input Layer.The following methods are dynamic:
  • Unique values symbology to a feature
  • Graduated color symbology to a feature
  • Classified value rendering to a raster

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 - the layer to which the symbology will be applied.

inSymbologyLayer - 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 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 the layer to which the symbology will be applied. This is a required parameter.

Parameters:

inLayer - the layer to which the symbology will be applied.

getInSymbologyLayer

public Object getInSymbologyLayer()

Returns the Symbology Layer parameter of this tool . This parameter is 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 the symbology of this layer is applied to the Input Layer. This is a required parameter.

Parameters:

inSymbologyLayer - 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