com.esri.arcgis.geoprocessing.tools.cartographytools
Class SetLayerRepresentation

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.cartographytools.SetLayerRepresentation

All Implemented Interfaces:

GPTool

public class SetLayerRepresentation
extends AbstractGPTool

Sets a representation for a feature layer. The layer is temporary and stored in memory during the ArcGIS session, available for use in models and scripts. The Set Layer Representation tool is contained in the Cartography Tools tool box.

Usage tips:

• The input must be a geodatabase feature class with at least one feature class representation.
• The resulting layer can be used as a valid input for cartographic tools that require a layer input in especially in models and scripts.
• The temporary feature layer can be saved as a layer file using the tool or saved as a new feature class using the tool. Layers created in ArcCatalog cannot be used in ArcMap unless they are saved to a layer file using the Save To Layer File tool.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

SetLayerRepresentation()
Creates the Set Layer Representation tool with defaults.

SetLayerRepresentation(Object inLayer, String representation)
Creates the Set Layer Representation tool with the required parameters.

Method Summary

Object	getInLayer() Returns the Input Layer parameter of this tool .
Object	getOutLayer() Returns the Output Layer parameter of this tool (Read only).
String	getRepresentation() Returns the Representation parameter of this tool .
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	setRepresentation(String representation) Sets the Representation 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

SetLayerRepresentation

public SetLayerRepresentation()

Creates the Set Layer Representation tool with defaults.

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

SetLayerRepresentation

public SetLayerRepresentation(Object inLayer,
                              String representation)

Creates the Set Layer Representation 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 input feature layer containing at least one representation.

representation - the representation to be set for the input feature layer.

Method Detail

getInLayer

public Object getInLayer()

Returns the Input Layer parameter of this tool . This parameter is the input feature layer containing at least one representation. 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 input feature layer containing at least one representation. This is a required parameter.

Parameters:

inLayer - the input feature layer containing at least one representation.

getRepresentation

public String getRepresentation()

Returns the Representation parameter of this tool . This parameter is the representation to be set for the input feature layer. This is a required parameter.

Returns:

the Representation

setRepresentation

public void setRepresentation(String representation)

Sets the Representation parameter of this tool . This parameter is the representation to be set for the input feature layer. This is a required parameter.

Parameters:

representation - the representation to be set for the input feature 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