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

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

All Implemented Interfaces:

GPTool

public class GridIndexFeatures
extends AbstractGPTool

Creates a grid of rectangular of polygon features that can be used as an index to specify pages for a map book using Data Driven Pages. A grid can be created that only includes polygon features that intersect another feature layer. The Grid Index Features tool is contained in the Cartography Tools tool box.

Usage tips:

• Input Features must be points, lines, or polygons.
• When you select Use Page Unit and Scale, Map Scale becomes a required parameter.
• When using the tool dialog, changing the polygon width or height values when Grid Origin Coordinates have been specified, the number of rows and columns change automatically.
• When you add Input Features, the Grid Origin Coordinates are automatically calculated.
• Consider saving your output feature class to a geodatabase. Though saving the output to a shapefile is supported, if you intend on calculating spatial references for index layer features using either the or the tools the generated coordinate string results may exceed the field character limits (255) of a shapefile.
• When Use Page Unit and Scale is selected, the Polygon Width and Polygon Height units automatically change to the page units set in the active map document. If you are using the tool outside of an ArcMap session the units default to inches. Though you have the option to specify map units, such as meters or miles, you should use units that are appropriate for your page.
• When Use Page Unit and Scale is selected the map scale defaults to the scale value of the active data frame on the page layout of the active ArcMap document. If you are using the tool outside of an ArcMap session the scale defaults to 1.
• For best results all input feature layers and feature classes should be in the same coordinate system as the data frame, or if you are using the tool outside of an ArcMap session, all input feature layers and feature classes should be in the same coordinate system as the first input feature layer or feature class in the list.

Field Summary

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

vals

Constructor Summary

GridIndexFeatures()
Creates the Grid Index Features tool with defaults.

GridIndexFeatures(Object outFeatureClass)
Creates the Grid Index Features tool with the required parameters.

Method Summary

Object	getInFeatures() Returns the Input Features parameter of this tool .
String	getIntersectFeature() Returns the Generate Polygon Grid that intersects input feature layers or datasets parameter of this tool .
String	getLabelFromOrigin() Returns the Start labeling from the Origin 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 .
Object	getOriginCoord() Returns the Polygon Grid Origin Coordinate parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
Object	getPolygonHeight() Returns the Polygon Height parameter of this tool .
Object	getPolygonWidth() Returns the Polygon Width parameter of this tool .
int	getScale() Returns the Map Scale parameter of this tool .
int	getStartingPageNumber() Returns the Starting Page Number 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.
String	getUsePageUnit() Returns the Use Page Unit and Scale parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setIntersectFeature(String intersectFeature) Sets the Generate Polygon Grid that intersects input feature layers or datasets parameter of this tool .
void	setLabelFromOrigin(String labelFromOrigin) Sets the Start labeling from the Origin 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(Object originCoord) Sets the Polygon Grid Origin Coordinate parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setPolygonHeight(Object polygonHeight) Sets the Polygon Height parameter of this tool .
void	setPolygonWidth(Object polygonWidth) Sets the Polygon Width parameter of this tool .
void	setScale(int scale) Sets the Map Scale parameter of this tool .
void	setStartingPageNumber(int startingPageNumber) Sets the Starting Page Number parameter of this tool .
void	setUsePageUnit(String usePageUnit) Sets the Use Page Unit and Scale 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

GridIndexFeatures

public GridIndexFeatures()

Creates the Grid Index Features tool with defaults.

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

GridIndexFeatures

public GridIndexFeatures(Object outFeatureClass)

Creates the Grid Index Features 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 - resulting feature class of polygon index features.

Method Detail

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is resulting feature class of polygon index features. This is a required parameter.

Returns:

the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

Sets the Output Feature Class parameter of this tool . This parameter is resulting feature class of polygon index features. This is a required parameter.

Parameters:

outFeatureClass - resulting feature class of polygon index features.

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is input features can be used to define the extent of the polygon grid that is created. This is an optional parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features parameter of this tool . This parameter is input features can be used to define the extent of the polygon grid that is created. This is an optional parameter.

Parameters:

inFeatures - input features can be used to define the extent of the polygon grid that is created.

getIntersectFeature

public String getIntersectFeature()

Returns the Generate Polygon Grid that intersects input feature layers or datasets parameter of this tool . This parameter is limits the output grid feature class to only areas that intersect input feature layers or datasets. When input features are specified, the default value is INTERSECTFEATURE. The intersection of input features will be used to create index features. This is an optional parameter.

Returns:

the Generate Polygon Grid that intersects input feature layers or datasets

setIntersectFeature

public void setIntersectFeature(String intersectFeature)

Sets the Generate Polygon Grid that intersects input feature layers or datasets parameter of this tool . This parameter is limits the output grid feature class to only areas that intersect input feature layers or datasets. When input features are specified, the default value is INTERSECTFEATURE. The intersection of input features will be used to create index features. This is an optional parameter.

Parameters:

intersectFeature - limits the output grid feature class to only areas that intersect input feature layers or datasets. When input features are specified, the default value is INTERSECTFEATURE. The intersection of input features will be used to create index features.

getUsePageUnit

public String getUsePageUnit()

Returns the Use Page Unit and Scale parameter of this tool . This parameter is indicates whether index polygon size input is in page units. The default is NO_USEPAGEUNIT. The tool uses map units by default. This is an optional parameter.

Returns:

the Use Page Unit and Scale

setUsePageUnit

public void setUsePageUnit(String usePageUnit)

Sets the Use Page Unit and Scale parameter of this tool . This parameter is indicates whether index polygon size input is in page units. The default is NO_USEPAGEUNIT. The tool uses map units by default. This is an optional parameter.

Parameters:

usePageUnit - indicates whether index polygon size input is in page units. The default is NO_USEPAGEUNIT. The tool uses map units by default.

getScale

public int getScale()

Returns the Map Scale parameter of this tool . This parameter is scale must be specified if the index polygon height and width are to be calculated in page units.. If the tool is being used outside of an active ArcMap session the default scale value is 1. This is an optional parameter.

Returns:

the Map Scale

setScale

public void setScale(int scale)

Sets the Map Scale parameter of this tool . This parameter is scale must be specified if the index polygon height and width are to be calculated in page units.. If the tool is being used outside of an active ArcMap session the default scale value is 1. This is an optional parameter.

Parameters:

scale - scale must be specified if the index polygon height and width are to be calculated in page units.. If the tool is being used outside of an active ArcMap session the default scale value is 1.

getPolygonWidth

public Object getPolygonWidth()

Returns the Polygon Width parameter of this tool . This parameter is width of the index polygon specifed in either map or page units. If page units are being used the default value is 1 inch. If map units are being used the default is 1 degree. This is an optional parameter.

Returns:

the Polygon Width

setPolygonWidth

public void setPolygonWidth(Object polygonWidth)

Sets the Polygon Width parameter of this tool . This parameter is width of the index polygon specifed in either map or page units. If page units are being used the default value is 1 inch. If map units are being used the default is 1 degree. This is an optional parameter.

Parameters:

polygonWidth - width of the index polygon specifed in either map or page units. If page units are being used the default value is 1 inch. If map units are being used the default is 1 degree.

getPolygonHeight

public Object getPolygonHeight()

Returns the Polygon Height parameter of this tool . This parameter is height of the index polygon specifed in either map or page units. If page units are being used the default value is 1 inch. If map units are being used the default is 1 degree. This is an optional parameter.

Returns:

the Polygon Height

setPolygonHeight

public void setPolygonHeight(Object polygonHeight)

Sets the Polygon Height parameter of this tool . This parameter is height of the index polygon specifed in either map or page units. If page units are being used the default value is 1 inch. If map units are being used the default is 1 degree. This is an optional parameter.

Parameters:

polygonHeight - height of the index polygon specifed in either map or page units. If page units are being used the default value is 1 inch. If map units are being used the default is 1 degree.

getOriginCoord

public Object getOriginCoord()

Returns the Polygon Grid Origin Coordinate parameter of this tool . This parameter is coordinate for the lower left origin of the output grid feature class. If input features are specified the default value is determined by the extent of the union of extents for these features. If there are no input features specified, the default coordinates are 0 and 0. This is an optional parameter.

Returns:

the Polygon Grid Origin Coordinate

setOriginCoord

public void setOriginCoord(Object originCoord)

Sets the Polygon Grid Origin Coordinate parameter of this tool . This parameter is coordinate for the lower left origin of the output grid feature class. If input features are specified the default value is determined by the extent of the union of extents for these features. If there are no input features specified, the default coordinates are 0 and 0. This is an optional parameter.

Parameters:

originCoord - coordinate for the lower left origin of the output grid feature class. If input features are specified the default value is determined by the extent of the union of extents for these features. If there are no input features specified, the default coordinates are 0 and 0.

getNumberRows

public int getNumberRows()

Returns the Number of Rows parameter of this tool . This parameter is number of rows to create in the y direction from the point of origin. The default is 10. This is an optional parameter.

Returns:

the Number of Rows

setNumberRows

public void setNumberRows(int numberRows)

Sets the Number of Rows parameter of this tool . This parameter is number of rows to create in the y direction from the point of origin. The default is 10. This is an optional parameter.

Parameters:

numberRows - number of rows to create in the y direction from the point of origin. The default is 10.

getNumberColumns

public int getNumberColumns()

Returns the Number of Columns parameter of this tool . This parameter is number of columns to create in the x direction from the point of origin. The default is 10. This is an optional parameter.

Returns:

the Number of Columns

setNumberColumns

public void setNumberColumns(int numberColumns)

Sets the Number of Columns parameter of this tool . This parameter is number of columns to create in the x direction from the point of origin. The default is 10. This is an optional parameter.

Parameters:

numberColumns - number of columns to create in the x direction from the point of origin. The default is 10.

getStartingPageNumber

public int getStartingPageNumber()

Returns the Starting Page Number parameter of this tool . This parameter is each grid index feature is assigned a sequential page number starting with a specified starting page number. The default is 1. This is an optional parameter.

Returns:

the Starting Page Number

setStartingPageNumber

public void setStartingPageNumber(int startingPageNumber)

Sets the Starting Page Number parameter of this tool . This parameter is each grid index feature is assigned a sequential page number starting with a specified starting page number. The default is 1. This is an optional parameter.

Parameters:

startingPageNumber - each grid index feature is assigned a sequential page number starting with a specified starting page number. The default is 1.

getLabelFromOrigin

public String getLabelFromOrigin()

Returns the Start labeling from the Origin parameter of this tool . This parameter is page numbers (labels) starting with the specified starting page number (default is 1) begins with the cell in the lower left corner of the output grid. The default is NO_LABELFROMORIGIN. This is an optional parameter.

Returns:

the Start labeling from the Origin

setLabelFromOrigin

public void setLabelFromOrigin(String labelFromOrigin)

Sets the Start labeling from the Origin parameter of this tool . This parameter is page numbers (labels) starting with the specified starting page number (default is 1) begins with the cell in the lower left corner of the output grid. The default is NO_LABELFROMORIGIN. This is an optional parameter.

Parameters:

labelFromOrigin - page numbers (labels) starting with the specified starting page number (default is 1) begins with the cell in the lower left corner of the output grid. The default is NO_LABELFROMORIGIN.

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