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

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

All Implemented Interfaces:

GPTool

public class SaveToLayerFile
extends AbstractGPTool

Creates an output layer file (.lyr) that references geographic data stored on disk. The Save To Layer File tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool is used to save an in-memory layer, a layer file stored on disk, or a feature layer in ArcMap to a layer file (.lyr) that references geographic data stored on disk.
• This tool accepts as input feature layers created by tools such as or .
• If the input layer has a selection applied to it, the output layer file will maintain this selection.
• If the created layer file does not immediately show up in ArcCatalog, refresh the catalog tree.

Field Summary

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

vals

Constructor Summary

SaveToLayerFile()
Creates the Save To Layer File tool with defaults.

SaveToLayerFile(Object inLayer, Object outLayer)
Creates the Save To Layer File tool with the required parameters.

Method Summary

Object	getInLayer() Returns the Input Layer parameter of this tool .
String	getIsRelativePath() Returns the Store Relative Path parameter of this tool .
Object	getOutLayer() Returns the Output Layer 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	setIsRelativePath(String isRelativePath) Sets the Store Relative Path parameter of this tool .
void	setOutLayer(Object outLayer) Sets the Output 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

SaveToLayerFile

public SaveToLayerFile()

Creates the Save To Layer File tool with defaults.

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

SaveToLayerFile

public SaveToLayerFile(Object inLayer,
                       Object outLayer)

Creates the Save To Layer File 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 in-memory layer, layer file stored on disk, or feature layer in ArcMap to be saved to disk as a layer file (.lyr).

outLayer - the output layer file (.lyr) to be created.

Method Detail

getInLayer

public Object getInLayer()

Returns the Input Layer parameter of this tool . This parameter is the in-memory layer, layer file stored on disk, or feature layer in ArcMap to be saved to disk as a layer file (.lyr). 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 in-memory layer, layer file stored on disk, or feature layer in ArcMap to be saved to disk as a layer file (.lyr). This is a required parameter.

Parameters:

inLayer - the in-memory layer, layer file stored on disk, or feature layer in ArcMap to be saved to disk as a layer file (.lyr).

getOutLayer

public Object getOutLayer()

Returns the Output Layer parameter of this tool . This parameter is the output layer file (.lyr) to be created. This is a required parameter.

Returns:

the Output Layer

setOutLayer

public void setOutLayer(Object outLayer)

Sets the Output Layer parameter of this tool . This parameter is the output layer file (.lyr) to be created. This is a required parameter.

Parameters:

outLayer - the output layer file (.lyr) to be created.

getIsRelativePath

public String getIsRelativePath()

Returns the Store Relative Path parameter of this tool . This parameter is determines if the output layer file (.lyr) will store a relative path to the source data stored on disk, or an absolute path. This is an optional parameter.

Returns:

the Store Relative Path

setIsRelativePath

public void setIsRelativePath(String isRelativePath)

Sets the Store Relative Path parameter of this tool . This parameter is determines if the output layer file (.lyr) will store a relative path to the source data stored on disk, or an absolute path. This is an optional parameter.

Parameters:

isRelativePath - determines if the output layer file (.lyr) will store a relative path to the source data stored on disk, or an absolute path.

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