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

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

public class CreateSpatialReference
extends AbstractGPTool

Creates a spatial reference object for use in ModelBuilder and scripting. The Create Spatial Reference tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CreateSpatialReference()
          Creates the Create Spatial Reference tool with defaults.
 
Method Summary
 double getExpandRatio()
          Returns the Grow XYDomain By Percentage parameter of this tool .
 String getMDomain()
          Returns the M Domain (min max) parameter of this tool .
 Object getOutSpatialReference()
          Returns the Output Spatial Reference parameter of this tool (Read only).
 Object getSpatialReference()
          Returns the Spatial Reference parameter of this tool .
 Object getSpatialReferenceTemplate()
          Returns the Spatial Reference Template parameter of this tool .
 Object getTemplate()
          Returns the Template XYDomains 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.
 Object getXyDomain()
          Returns the XY Domain parameter of this tool .
 String getZDomain()
          Returns the Z Domain (min max) parameter of this tool .
 void setExpandRatio(double expandRatio)
          Sets the Grow XYDomain By Percentage parameter of this tool .
 void setMDomain(String mDomain)
          Sets the M Domain (min max) parameter of this tool .
 void setSpatialReference(Object spatialReference)
          Sets the Spatial Reference parameter of this tool .
 void setSpatialReferenceTemplate(Object spatialReferenceTemplate)
          Sets the Spatial Reference Template parameter of this tool .
 void setTemplate(Object template)
          Sets the Template XYDomains parameter of this tool .
 void setXyDomain(Object xyDomain)
          Sets the XY Domain parameter of this tool .
 void setZDomain(String zDomain)
          Sets the Z Domain (min max) 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

CreateSpatialReference

public CreateSpatialReference()
Creates the Create Spatial Reference tool with defaults.

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

Method Detail

getSpatialReference

public Object getSpatialReference()
Returns the Spatial Reference parameter of this tool . This parameter is Spatial Reference, sets the Spatial Reference. This is an optional parameter.

Returns:
the Spatial Reference

setSpatialReference

public void setSpatialReference(Object spatialReference)
Sets the Spatial Reference parameter of this tool . This parameter is Spatial Reference, sets the Spatial Reference. This is an optional parameter.

Parameters:
spatialReference - Spatial Reference, sets the Spatial Reference.

getSpatialReferenceTemplate

public Object getSpatialReferenceTemplate()
Returns the Spatial Reference Template parameter of this tool . This parameter is Feature Layer, uses a feature class as a template for the spatial reference. Will set the value for Spatial Reference. This is an optional parameter.

Returns:
the Spatial Reference Template

setSpatialReferenceTemplate

public void setSpatialReferenceTemplate(Object spatialReferenceTemplate)
Sets the Spatial Reference Template parameter of this tool . This parameter is Feature Layer, uses a feature class as a template for the spatial reference. Will set the value for Spatial Reference. This is an optional parameter.

Parameters:
spatialReferenceTemplate - Feature Layer, uses a feature class as a template for the spatial reference. Will set the value for Spatial Reference.

getXyDomain

public Object getXyDomain()
Returns the XY Domain parameter of this tool . This parameter is Envelope, allowable coordinate range for x,y coordinates. This is an optional parameter.

Returns:
the XY Domain

setXyDomain

public void setXyDomain(Object xyDomain)
Sets the XY Domain parameter of this tool . This parameter is Envelope, allowable coordinate range for x,y coordinates. This is an optional parameter.

Parameters:
xyDomain - Envelope, allowable coordinate range for x,y coordinates.

getZDomain

public String getZDomain()
Returns the Z Domain (min max) parameter of this tool . This parameter is String, allowable coordinate range for z-values. This is an optional parameter.

Returns:
the Z Domain (min max)

setZDomain

public void setZDomain(String zDomain)
Sets the Z Domain (min max) parameter of this tool . This parameter is String, allowable coordinate range for z-values. This is an optional parameter.

Parameters:
zDomain - String, allowable coordinate range for z-values.

getMDomain

public String getMDomain()
Returns the M Domain (min max) parameter of this tool . This parameter is String, allowable coordinate range for m-values. This is an optional parameter.

Returns:
the M Domain (min max)

setMDomain

public void setMDomain(String mDomain)
Sets the M Domain (min max) parameter of this tool . This parameter is String, allowable coordinate range for m-values. This is an optional parameter.

Parameters:
mDomain - String, allowable coordinate range for m-values.

getTemplate

public Object getTemplate()
Returns the Template XYDomains parameter of this tool . This parameter is Feature Layer, feature classes that can be used to define the XY Domain. This is an optional parameter.

Returns:
the Template XYDomains

setTemplate

public void setTemplate(Object template)
Sets the Template XYDomains parameter of this tool . This parameter is Feature Layer, feature classes that can be used to define the XY Domain. This is an optional parameter.

Parameters:
template - Feature Layer, feature classes that can be used to define the XY Domain.

getExpandRatio

public double getExpandRatio()
Returns the Grow XYDomain By Percentage parameter of this tool . This parameter is Double, percentage increase that XY Domain will be expanded. This is an optional parameter.

Returns:
the Grow XYDomain By Percentage

setExpandRatio

public void setExpandRatio(double expandRatio)
Sets the Grow XYDomain By Percentage parameter of this tool . This parameter is Double, percentage increase that XY Domain will be expanded. This is an optional parameter.

Parameters:
expandRatio - Double, percentage increase that XY Domain will be expanded.

getOutSpatialReference

public Object getOutSpatialReference()
Returns the Output Spatial Reference parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Spatial Reference

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