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

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

All Implemented Interfaces:

GPTool

public class CalculateAdjacentFields
extends AbstractGPTool

The most common use case for using this tool is to populate fields that can be used to label the adjacent pages in a map book. This tool appends eight new fields (each field representing one of the eight points of the compass: North, Northeast, East, Southeast, South, Southwest, West and Northwest) to the input feature class and calculates values that identify the adjacent (neighboring) polygons, in each cardinal direction, for each feature in the input feature class. The Calculate Adjacent Fields tool is contained in the Cartography Tools tool box.

Usage tips:

• This tool only works with rectangular polygons.
• This tool creates eight new fields whose names are a combination of the in_field name and direction. Direction is abbreviated. For example, if the in_field name is "PageName" the new field names created by the tool would include: "PageName_N", "PageName_NE", "PageName_E", "PageName_SE", "PageName_S", "PageName_SW", "PageName_W" and "PageName_NW". If the in_field name is "MyPoly" the new field names would include: "MyPoly_N", "MyPoly_NE", "MyPoly_E", "MyPoly_SE", "MyPoly_S", "MyPoly_SW", "MyPoly_W" and "MyPoly_NW".
• You cannot specify names for the new fields. The tool uses default names, though you can change field names after the tool has been run.
• You can use fields from a joined table.

Field Summary

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

vals

Constructor Summary

CalculateAdjacentFields()
Creates the Calculate Adjacent Fields tool with defaults.

CalculateAdjacentFields(Object inFeatures, Object inField)
Creates the Calculate Adjacent Fields tool with the required parameters.

Method Summary

Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getInField() Returns the Field Name parameter of this tool .
Object	getOutFeatures() Returns the Output Features parameter of this tool (Read only).
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	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setInField(Object inField) Sets the Field Name 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

CalculateAdjacentFields

public CalculateAdjacentFields()

Creates the Calculate Adjacent Fields tool with defaults.

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

CalculateAdjacentFields

public CalculateAdjacentFields(Object inFeatures,
                               Object inField)

Creates the Calculate Adjacent Fields 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:

inFeatures - polygon grid index features to be appended with adjacent field data.

inField - field whose values will be used to populate adjacent field data. Use actual field names. Do not use field aliases.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is polygon grid index features to be appended with adjacent field data. This is a required parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features parameter of this tool . This parameter is polygon grid index features to be appended with adjacent field data. This is a required parameter.

Parameters:

inFeatures - polygon grid index features to be appended with adjacent field data.

getInField

public Object getInField()

Returns the Field Name parameter of this tool . This parameter is field whose values will be used to populate adjacent field data. Use actual field names. Do not use field aliases. This is a required parameter.

Returns:

the Field Name

setInField

public void setInField(Object inField)

Sets the Field Name parameter of this tool . This parameter is field whose values will be used to populate adjacent field data. Use actual field names. Do not use field aliases. This is a required parameter.

Parameters:

inField - field whose values will be used to populate adjacent field data. Use actual field names. Do not use field aliases.

getOutFeatures

public Object getOutFeatures()

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

Returns:

the Output Features

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