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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      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.

Usage tips:

• You can create a spatial reference object with set coordinate system, spatial domains, and precision. The spatial domains and precision of the output spatial reference can be further modified using XY Domain, Z Domain, M Domain, Template XYDomains, and Grow XYDomain By Percentage parameters.
• Template XYDomains does not have to be in the same coordinate system as that specified in Spatial Reference or Spatial Reference Template. If they are different, the extents will be projected to match.
• If the Spatial Reference and Spatial Reference Template parameters are both set, spatial reference parameter will take priority.
• All the parameters of the tool are optional. If no parameters are specified, the spatial reference will be defined as 'Unknown' and the XYDomain will assume standard defaults.
• In ModelBuilder, the output of this tool can be used as input to tools with a spatial reference parameter (e.g., , , ).

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 .
java.lang.String	getMDomain() Returns the M Domain (min max) parameter of this tool .
java.lang.Object	getOutSpatialReference() Returns the Output Spatial Reference parameter of this tool (Read only).
java.lang.Object	getSpatialReference() Returns the Spatial Reference parameter of this tool .
java.lang.Object	getSpatialReferenceTemplate() Returns the Spatial Reference Template parameter of this tool .
java.lang.Object	getTemplate() Returns the Template XYDomains parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
java.lang.Object	getXyDomain() Returns the XY Domain parameter of this tool .
java.lang.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(java.lang.String mDomain) Sets the M Domain (min max) parameter of this tool .
void	setSpatialReference(java.lang.Object spatialReference) Sets the Spatial Reference parameter of this tool .
void	setSpatialReferenceTemplate(java.lang.Object spatialReferenceTemplate) Sets the Spatial Reference Template parameter of this tool .
void	setTemplate(java.lang.Object template) Sets the Template XYDomains parameter of this tool .
void	setXyDomain(java.lang.Object xyDomain) Sets the XY Domain parameter of this tool .
void	setZDomain(java.lang.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 java.lang.Object getSpatialReference()

Returns the Spatial Reference parameter of this tool . This parameter is name of the the spatial reference object to be created. This is an optional parameter.

Returns:

the Spatial Reference

setSpatialReference

public void setSpatialReference(java.lang.Object spatialReference)

Sets the Spatial Reference parameter of this tool . This parameter is name of the the spatial reference object to be created. This is an optional parameter.

Parameters:

spatialReference - name of the the spatial reference object to be created.

getSpatialReferenceTemplate

public java.lang.Object getSpatialReferenceTemplate()

Returns the Spatial Reference Template parameter of this tool . This parameter is the feature class or layer to be used as a template to set the value for the spatial reference. This is an optional parameter.

Returns:

the Spatial Reference Template

setSpatialReferenceTemplate

public void setSpatialReferenceTemplate(java.lang.Object spatialReferenceTemplate)

Sets the Spatial Reference Template parameter of this tool . This parameter is the feature class or layer to be used as a template to set the value for the spatial reference. This is an optional parameter.

Parameters:

spatialReferenceTemplate - the feature class or layer to be used as a template to set the value for the spatial reference.

getXyDomain

public java.lang.Object getXyDomain()

Returns the XY Domain parameter of this tool . This parameter is allowable coordinate range for x,y coordinates. This is an optional parameter.

Returns:

the XY Domain

setXyDomain

public void setXyDomain(java.lang.Object xyDomain)

Sets the XY Domain parameter of this tool . This parameter is allowable coordinate range for x,y coordinates. This is an optional parameter.

Parameters:

xyDomain - allowable coordinate range for x,y coordinates.

getZDomain

public java.lang.String getZDomain()

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

Returns:

the Z Domain (min max)

setZDomain

public void setZDomain(java.lang.String zDomain)

Sets the Z Domain (min max) parameter of this tool . This parameter is allowable coordinate range for z values. This is an optional parameter.

Parameters:

zDomain - allowable coordinate range for z values.

getMDomain

public java.lang.String getMDomain()

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

Returns:

the M Domain (min max)

setMDomain

public void setMDomain(java.lang.String mDomain)

Sets the M Domain (min max) parameter of this tool . This parameter is allowable coordinate range for m values. This is an optional parameter.

Parameters:

mDomain - allowable coordinate range for m values.

getTemplate

public java.lang.Object getTemplate()

Returns the Template XYDomains parameter of this tool . This parameter is feature classes or layers that can be used to define the XY Domain. This is an optional parameter.

Returns:

the Template XYDomains

setTemplate

public void setTemplate(java.lang.Object template)

Sets the Template XYDomains parameter of this tool . This parameter is feature classes or layers that can be used to define the XY Domain. This is an optional parameter.

Parameters:

template - feature classes or layers 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 percentage by which the 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 percentage by which the XY Domain will be expanded. This is an optional parameter.

Parameters:

expandRatio - percentage by which the XY Domain will be expanded.

getOutSpatialReference

public java.lang.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 java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias