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

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

All Implemented Interfaces:

GPTool

public class CreateFishnet
extends AbstractGPTool

Creates a fishnet of rectangular cells which can be polyline or polygon features. The Create Fishnet tool is contained in the Data Management Tools tool box.

Usage tips:

• The coordinate system of the output can be set either by entering a feature class or layer in the Template Extent parameter or by setting the Output Coordinate System environment variable.
• In addition to creating the output fishnet, a new point feature class is created with label points at the center of each fishnet cell if the Create Label Points parameter is set to LABELS (Checked). The name of this feature class is the same as the output feature class with a suffix of _Labels and is created in the same locaton.
• The Geometry Type parameter gives the option of creating output polyline (default) or polygon cells. Creating a polygon fishnet may be slow, depending on the number of rows and columns.
• The Cell Size Width and the Cell Size Height values are in the same units as defined by the output feature class.

Field Summary

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

vals

Constructor Summary

CreateFishnet()
Creates the Create Fishnet tool with defaults.

CreateFishnet(java.lang.Object outFeatureClass, java.lang.Object originCoord, java.lang.Object yAxisCoord, double cellWidth, double cellHeight, int numberRows, int numberColumns)
Creates the Create Fishnet tool with the required parameters.

Method Summary

double	getCellHeight() Returns the Cell Size Height parameter of this tool .
double	getCellWidth() Returns the Cell Size Width parameter of this tool .
java.lang.Object	getCornerCoord() Returns the Opposite corner of Fishnet parameter of this tool .
java.lang.String	getGeometryType() Returns the Geometry Type parameter of this tool .
java.lang.String	getLabels() Returns the Create Label Points parameter of this tool .
int	getNumberColumns() Returns the Number of Columns parameter of this tool .
int	getNumberRows() Returns the Number of Rows parameter of this tool .
java.lang.Object	getOriginCoord() Returns the Fishnet Origin Coordinate parameter of this tool .
java.lang.Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
java.lang.Object	getOutLabel() Returns the Output Labels parameter of this tool (Read only).
java.lang.Object	getTemplate() Returns the Template Extent 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	getYAxisCoord() Returns the Y-Axis Coordinate parameter of this tool .
void	setCellHeight(double cellHeight) Sets the Cell Size Height parameter of this tool .
void	setCellWidth(double cellWidth) Sets the Cell Size Width parameter of this tool .
void	setCornerCoord(java.lang.Object cornerCoord) Sets the Opposite corner of Fishnet parameter of this tool .
void	setGeometryType(java.lang.String geometryType) Sets the Geometry Type parameter of this tool .
void	setLabels(java.lang.String labels) Sets the Create Label Points parameter of this tool .
void	setNumberColumns(int numberColumns) Sets the Number of Columns parameter of this tool .
void	setNumberRows(int numberRows) Sets the Number of Rows parameter of this tool .
void	setOriginCoord(java.lang.Object originCoord) Sets the Fishnet Origin Coordinate parameter of this tool .
void	setOutFeatureClass(java.lang.Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setTemplate(java.lang.Object template) Sets the Template Extent parameter of this tool .
void	setYAxisCoord(java.lang.Object yAxisCoord) Sets the Y-Axis Coordinate 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

CreateFishnet

public CreateFishnet()

Creates the Create Fishnet tool with defaults.

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

CreateFishnet

public CreateFishnet(java.lang.Object outFeatureClass,
                     java.lang.Object originCoord,
                     java.lang.Object yAxisCoord,
                     double cellWidth,
                     double cellHeight,
                     int numberRows,
                     int numberColumns)

Creates the Create Fishnet 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:

outFeatureClass - the output feature class containing the fishnet of rectangular cells.

originCoord - the starting pivot point of the fishnet.

yAxisCoord - the Y-axis coordinate is used to orient the fishnet. The fishnet is rotated by the same angle as defined by the line connecting the origin and the y-axis coordiinate.

cellWidth - determines the width of each cell. If you want the width to be automatically calculated using the value in the Number of Rows parameter, set this value to zero葉he width will be calculated when the tool is run.

cellHeight - determines the height of each cell. If you want the height to be automatically calculated using the value in the Number of Columns parameter, set this value to zero葉he height will be calculated when the tool is run.

numberRows - determines the number of rows the fishnet will have. If you want the number of rows to be automatically calculated using the value in the Cell Size Width parameter, set this value to zero葉he number of rows will be calculated when the tool is run.

numberColumns - determines the number of columns the fishnet will have. If you want the number of columns to be automatically calculated using the value in the Cell Size Height parameter, set this value to zero葉he number of rows will be calculated when the tool is run.

Method Detail

getOutFeatureClass

public java.lang.Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the output feature class containing the fishnet of rectangular cells. This is a required parameter.

Returns:

the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(java.lang.Object outFeatureClass)

Sets the Output Feature Class parameter of this tool . This parameter is the output feature class containing the fishnet of rectangular cells. This is a required parameter.

Parameters:

outFeatureClass - the output feature class containing the fishnet of rectangular cells.

getOriginCoord

public java.lang.Object getOriginCoord()

Returns the Fishnet Origin Coordinate parameter of this tool . This parameter is the starting pivot point of the fishnet. This is a required parameter.

Returns:

the Fishnet Origin Coordinate

setOriginCoord

public void setOriginCoord(java.lang.Object originCoord)

Sets the Fishnet Origin Coordinate parameter of this tool . This parameter is the starting pivot point of the fishnet. This is a required parameter.

Parameters:

originCoord - the starting pivot point of the fishnet.

getYAxisCoord

public java.lang.Object getYAxisCoord()

Returns the Y-Axis Coordinate parameter of this tool . This parameter is the Y-axis coordinate is used to orient the fishnet. The fishnet is rotated by the same angle as defined by the line connecting the origin and the y-axis coordiinate. This is a required parameter.

Returns:

the Y-Axis Coordinate

setYAxisCoord

public void setYAxisCoord(java.lang.Object yAxisCoord)

Sets the Y-Axis Coordinate parameter of this tool . This parameter is the Y-axis coordinate is used to orient the fishnet. The fishnet is rotated by the same angle as defined by the line connecting the origin and the y-axis coordiinate. This is a required parameter.

Parameters:

yAxisCoord - the Y-axis coordinate is used to orient the fishnet. The fishnet is rotated by the same angle as defined by the line connecting the origin and the y-axis coordiinate.

getCellWidth

public double getCellWidth()

Returns the Cell Size Width parameter of this tool . This parameter is determines the width of each cell. If you want the width to be automatically calculated using the value in the Number of Rows parameter, set this value to zero葉he width will be calculated when the tool is run. This is a required parameter.

Returns:

the Cell Size Width

setCellWidth

public void setCellWidth(double cellWidth)

Sets the Cell Size Width parameter of this tool . This parameter is determines the width of each cell. If you want the width to be automatically calculated using the value in the Number of Rows parameter, set this value to zero葉he width will be calculated when the tool is run. This is a required parameter.

Parameters:

cellWidth - determines the width of each cell. If you want the width to be automatically calculated using the value in the Number of Rows parameter, set this value to zero葉he width will be calculated when the tool is run.

getCellHeight

public double getCellHeight()

Returns the Cell Size Height parameter of this tool . This parameter is determines the height of each cell. If you want the height to be automatically calculated using the value in the Number of Columns parameter, set this value to zero葉he height will be calculated when the tool is run. This is a required parameter.

Returns:

the Cell Size Height

setCellHeight

public void setCellHeight(double cellHeight)

Sets the Cell Size Height parameter of this tool . This parameter is determines the height of each cell. If you want the height to be automatically calculated using the value in the Number of Columns parameter, set this value to zero葉he height will be calculated when the tool is run. This is a required parameter.

Parameters:

cellHeight - determines the height of each cell. If you want the height to be automatically calculated using the value in the Number of Columns parameter, set this value to zero葉he height will be calculated when the tool is run.

getNumberRows

public int getNumberRows()

Returns the Number of Rows parameter of this tool . This parameter is determines the number of rows the fishnet will have. If you want the number of rows to be automatically calculated using the value in the Cell Size Width parameter, set this value to zero葉he number of rows will be calculated when the tool is run. This is a required parameter.

Returns:

the Number of Rows

setNumberRows

public void setNumberRows(int numberRows)

Sets the Number of Rows parameter of this tool . This parameter is determines the number of rows the fishnet will have. If you want the number of rows to be automatically calculated using the value in the Cell Size Width parameter, set this value to zero葉he number of rows will be calculated when the tool is run. This is a required parameter.

Parameters:

numberRows - determines the number of rows the fishnet will have. If you want the number of rows to be automatically calculated using the value in the Cell Size Width parameter, set this value to zero葉he number of rows will be calculated when the tool is run.

getNumberColumns

public int getNumberColumns()

Returns the Number of Columns parameter of this tool . This parameter is determines the number of columns the fishnet will have. If you want the number of columns to be automatically calculated using the value in the Cell Size Height parameter, set this value to zero葉he number of rows will be calculated when the tool is run. This is a required parameter.

Returns:

the Number of Columns

setNumberColumns

public void setNumberColumns(int numberColumns)

Sets the Number of Columns parameter of this tool . This parameter is determines the number of columns the fishnet will have. If you want the number of columns to be automatically calculated using the value in the Cell Size Height parameter, set this value to zero葉he number of rows will be calculated when the tool is run. This is a required parameter.

Parameters:

numberColumns - determines the number of columns the fishnet will have. If you want the number of columns to be automatically calculated using the value in the Cell Size Height parameter, set this value to zero葉he number of rows will be calculated when the tool is run.

getCornerCoord

public java.lang.Object getCornerCoord()

Returns the Opposite corner of Fishnet parameter of this tool . This parameter is the opposite corner of the fishnet set by X-Coordinate and Y-Coordinate values. This is an optional parameter.

Returns:

the Opposite corner of Fishnet

setCornerCoord

public void setCornerCoord(java.lang.Object cornerCoord)

Sets the Opposite corner of Fishnet parameter of this tool . This parameter is the opposite corner of the fishnet set by X-Coordinate and Y-Coordinate values. This is an optional parameter.

Parameters:

cornerCoord - the opposite corner of the fishnet set by X-Coordinate and Y-Coordinate values.

getLabels

public java.lang.String getLabels()

Returns the Create Label Points parameter of this tool . This parameter is specify whether or not a point feature class will be created containing label points at the center of each fishnet cell. This is an optional parameter.

Returns:

the Create Label Points

setLabels

public void setLabels(java.lang.String labels)

Sets the Create Label Points parameter of this tool . This parameter is specify whether or not a point feature class will be created containing label points at the center of each fishnet cell. This is an optional parameter.

Parameters:

labels - specify whether or not a point feature class will be created containing label points at the center of each fishnet cell.

getTemplate

public java.lang.Object getTemplate()

Returns the Template Extent parameter of this tool . This parameter is specify the extent of the fishnet. The extent can be entered by specifying the coordinates or using a template dataset. This is an optional parameter.

Returns:

the Template Extent

setTemplate

public void setTemplate(java.lang.Object template)

Sets the Template Extent parameter of this tool . This parameter is specify the extent of the fishnet. The extent can be entered by specifying the coordinates or using a template dataset. This is an optional parameter.

Parameters:

template - specify the extent of the fishnet. The extent can be entered by specifying the coordinates or using a template dataset.

getGeometryType

public java.lang.String getGeometryType()

Returns the Geometry Type parameter of this tool . This parameter is determines if the output fishnet cells will be polyline or polygon features. This is an optional parameter.

Returns:

the Geometry Type

setGeometryType

public void setGeometryType(java.lang.String geometryType)

Sets the Geometry Type parameter of this tool . This parameter is determines if the output fishnet cells will be polyline or polygon features. This is an optional parameter.

Parameters:

geometryType - determines if the output fishnet cells will be polyline or polygon features.

getOutLabel

public java.lang.Object getOutLabel()

Returns the Output Labels parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Labels

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