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

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

All Implemented Interfaces:

GPTool

public class StripMapIndexFeatures
extends AbstractGPTool

Creates a series of rectangular polygons, or index features, that follow a single linear feature or a group of linear features. These index features can be used with Data Driven Pages to define pages within a strip map, or set of maps that follow a linear feature. The resulting index features contain attributes that can be used to rotate and orient the map on the page and determine which index features, or pages, are next to the current page (to the left and right or to the top and bottom). The Strip Map Index Features tool is contained in the Cartography Tools tool box.

Usage tips:

• Line features are the only valid input.
• When you select Use Page Unit and Scale Map, Map Scale becomes a required parameter. If ArcMap is open the map scale of the active data frame will be used; otherwise, the default value is 1. If you are specifying the size of index features in map space and Use Page Unit and Scale is not selected Map Scale is not needed.
• Resulting index features are created with a number of attributes. These attributes include: PageNumber, GroupId, SeqId, PrevPage, NextPage, LeftPage, RightPage, TopPage, BottomPage and Angle.
  • Angle is a numeric value expressing the rotation angle needed by the map (data frame) to align the edges of the index feature with the edges of a layout page. In order to keep within cartographic conventions, these angles are calculated to keep North oriented toward the top of the page as much as possible. Angles are calculated against the default orientation of a map where 0 degrees is due North, 90 degrees is due East, 180 degrees is due South and -90 degrees is due West.
  • PageNumber is an incremental number assigned to each index feature.
  • GroupId is an integer assigned to all the index features in a connecting chain or group of line features. Strip Map Index Features results can include multiple groups. Usually, a single group will originate from a connected set of line features or from a single line with multiple, unconnected parts. Index features created from Individual, unconnected line features will be assigned to separate groups. GroupId values are unique and are derived from the OID of the first line feature in the given chain.
  • SeqId is an incremental number assigned to each index feature based on the creation order for the feature within each group.
  • PrevPage is the PageNumber value for the previously created index feature. This field is used in analyzing the creation order of index features. Do not use this field to run dynamic text for a Data Driven Page. Use LeftPage, RightPage, TopPage and BottomPage fields for dynamic text.
  • NextPage is the PageNumber value for the next index feature created. This field is used in analyzing the creation order of index features. Do not use this field to run dynamic text for a Data Driven Page. Use LeftPage, RightPage, TopPage, and BottomPage fields for dynamic text.
  • LeftPage, RightPage, TopPage, and BottomPage are useful when incorporating the results into Data Driven Pages. LeftPage is the PageNumber value of the index feature that appears to the left of the current index feature after the rotation has been applied. RightPage is the PageNmuber of the index feature to the right. TopPage and BottomPage are the values for the index features to the top and bottom, respectively.
• When Use Page Unit and Scale is selected the units for Length Along the Line and Length Perpendicular to the Line automatically changes to the page units set in the active map document (if ArcMap is open) or to inches if you are using the tool outside of an ArcMap session. For best results these units should be specified in page units such as inches or centimeters. If Use Page Units and Scale is not selected, units should be specified in map units such as meters, feet, kilometers, miles, or decimal degrees.

Field Summary

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

vals

Constructor Summary

StripMapIndexFeatures()
Creates the Strip Map Index Features tool with defaults.

StripMapIndexFeatures(Object inFeatures, Object outFeatureClass)
Creates the Strip Map Index Features tool with the required parameters.

Method Summary

String	getDirectionType() Returns the Strip Map Direction parameter of this tool .
Object	getInFeatures() Returns the Input Line Features parameter of this tool .
Object	getLengthAlongLine() Returns the Length Along the Line parameter of this tool .
Object	getLengthPerpendicularToLine() Returns the Length Perpendicular to the Line parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
double	getOverlapPercentage() Returns the Percentage of Overlap parameter of this tool .
String	getPageOrientation() Returns the Page Orientation 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	setDirectionType(String directionType) Sets the Strip Map Direction parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Line Features parameter of this tool .
void	setLengthAlongLine(Object lengthAlongLine) Sets the Length Along the Line parameter of this tool .
void	setLengthPerpendicularToLine(Object lengthPerpendicularToLine) Sets the Length Perpendicular to the Line parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setOverlapPercentage(double overlapPercentage) Sets the Percentage of Overlap parameter of this tool .
void	setPageOrientation(String pageOrientation) Sets the Page Orientation 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

StripMapIndexFeatures

public StripMapIndexFeatures()

Creates the Strip Map Index Features tool with defaults.

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

StripMapIndexFeatures

public StripMapIndexFeatures(Object inFeatures,
                             Object outFeatureClass)

Creates the Strip Map 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:

inFeatures - input polyline or polylines defining the path of the strip map index features.

outFeatureClass - resulting feature class of polygon index features.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Line Features parameter of this tool . This parameter is input polyline or polylines defining the path of the strip map index features. This is a required parameter.

Returns:

the Input Line Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Line Features parameter of this tool . This parameter is input polyline or polylines defining the path of the strip map index features. This is a required parameter.

Parameters:

inFeatures - input polyline or polylines defining the path of the strip map index features.

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.

getUsePageUnit

public String getUsePageUnit()

Returns the Use Page Unit and Scale parameter of this tool . This parameter is indicates whether index feature size input is in page space. The default value is NO_USEPAGEUNIT. 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 feature size input is in page space. The default value is NO_USEPAGEUNIT. This is an optional parameter.

Parameters:

usePageUnit - indicates whether index feature size input is in page space. The default value is NO_USEPAGEUNIT.

getScale

public int getScale()

Returns the Map Scale parameter of this tool . This parameter is map scale must be specified if index feature lengths (along the line and perpendicular to the line) are to be calculated in page space. If ArcMap is open the default value will be the scale of the active data frame. If ArcMap is not open the default will be 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 map scale must be specified if index feature lengths (along the line and perpendicular to the line) are to be calculated in page space. If ArcMap is open the default value will be the scale of the active data frame. If ArcMap is not open the default will be 1. This is an optional parameter.

Parameters:

scale - map scale must be specified if index feature lengths (along the line and perpendicular to the line) are to be calculated in page space. If ArcMap is open the default value will be the scale of the active data frame. If ArcMap is not open the default will be 1.

getLengthAlongLine

public Object getLengthAlongLine()

Returns the Length Along the Line parameter of this tool . This parameter is length of the polygon index feature along the input line feature specifed in either map or page units. The default value is determined by the spatial reference of the input line feature or features. This value will be 1/100 of the input feature class extent along the X axis. This is an optional parameter.

Returns:

the Length Along the Line

setLengthAlongLine

public void setLengthAlongLine(Object lengthAlongLine)

Sets the Length Along the Line parameter of this tool . This parameter is length of the polygon index feature along the input line feature specifed in either map or page units. The default value is determined by the spatial reference of the input line feature or features. This value will be 1/100 of the input feature class extent along the X axis. This is an optional parameter.

Parameters:

lengthAlongLine - length of the polygon index feature along the input line feature specifed in either map or page units. The default value is determined by the spatial reference of the input line feature or features. This value will be 1/100 of the input feature class extent along the X axis.

getLengthPerpendicularToLine

public Object getLengthPerpendicularToLine()

Returns the Length Perpendicular to the Line parameter of this tool . This parameter is length of the polygon index feature perpendicular to the input line feature specifed in either map or page units. The default value is determined by the spatial reference of the input line feature or features. This value will be 1/2 the number used for the length along the line. This is an optional parameter.

Returns:

the Length Perpendicular to the Line

setLengthPerpendicularToLine

public void setLengthPerpendicularToLine(Object lengthPerpendicularToLine)

Sets the Length Perpendicular to the Line parameter of this tool . This parameter is length of the polygon index feature perpendicular to the input line feature specifed in either map or page units. The default value is determined by the spatial reference of the input line feature or features. This value will be 1/2 the number used for the length along the line. This is an optional parameter.

Parameters:

lengthPerpendicularToLine - length of the polygon index feature perpendicular to the input line feature specifed in either map or page units. The default value is determined by the spatial reference of the input line feature or features. This value will be 1/2 the number used for the length along the line.

getPageOrientation

public String getPageOrientation()

Returns the Page Orientation parameter of this tool . This parameter is used to determine the orientation of the input line features on the layout page. The default is HORIZONTAL. This is an optional parameter.

Returns:

the Page Orientation

setPageOrientation

public void setPageOrientation(String pageOrientation)

Sets the Page Orientation parameter of this tool . This parameter is used to determine the orientation of the input line features on the layout page. The default is HORIZONTAL. This is an optional parameter.

Parameters:

pageOrientation - used to determine the orientation of the input line features on the layout page. The default is HORIZONTAL.

getOverlapPercentage

public double getOverlapPercentage()

Returns the Percentage of Overlap parameter of this tool . This parameter is the approximate percentage of geographic overlap between an individual map page and its adjoining pages in the series. The default is 10. This is an optional parameter.

Returns:

the Percentage of Overlap

setOverlapPercentage

public void setOverlapPercentage(double overlapPercentage)

Sets the Percentage of Overlap parameter of this tool . This parameter is the approximate percentage of geographic overlap between an individual map page and its adjoining pages in the series. The default is 10. This is an optional parameter.

Parameters:

overlapPercentage - the approximate percentage of geographic overlap between an individual map page and its adjoining pages in the series. 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 value 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 value 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 value is 1.

getDirectionType

public String getDirectionType()

Returns the Strip Map Direction parameter of this tool . This parameter is index features are created in a sequential order and require a starting point. Setting the direction type for the strip map provides a starting point. The default is WE_NS. This means that the starting point for the strip map is either at the western end of the line feature if the line feature's directional trend is West to East/East to West or, if the directional trend is North to South/South to North, the starting point would be the northern most point of the line feature. The direction type is also applied to secondary line features. This is an optional parameter.

Returns:

the Strip Map Direction

setDirectionType

public void setDirectionType(String directionType)

Sets the Strip Map Direction parameter of this tool . This parameter is index features are created in a sequential order and require a starting point. Setting the direction type for the strip map provides a starting point. The default is WE_NS. This means that the starting point for the strip map is either at the western end of the line feature if the line feature's directional trend is West to East/East to West or, if the directional trend is North to South/South to North, the starting point would be the northern most point of the line feature. The direction type is also applied to secondary line features. This is an optional parameter.

Parameters:

directionType - index features are created in a sequential order and require a starting point. Setting the direction type for the strip map provides a starting point. The default is WE_NS. This means that the starting point for the strip map is either at the western end of the line feature if the line feature's directional trend is West to East/East to West or, if the directional trend is North to South/South to North, the starting point would be the northern most point of the line feature. The direction type is also applied to secondary line 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