com.esri.arcgis.geoprocessing.tools.coveragetools
Class CreateLabels

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.coveragetools.CreateLabels

All Implemented Interfaces:

GPTool

public class CreateLabels
extends AbstractGPTool

Creates label points for polygons that have no labels and assigns each a User-ID. The Create Labels tool is contained in the Coverage Tools tool box.

Usage tips:

• After Create Labels, the polygon User-IDs stored in the Input Coverage PAT are not equal to the new label point User-IDs generated by Create Labels. You must use or to make them equal.
• The ID Base value provides the starting point for creating the label point User-IDs. The specified value will be the User-ID for the first polygon encountered that has no label point. User-IDs are then incremented by one for each subsequent polygon having no label point. Specifying a value of zero will create new labels for all polygons, where each User-ID will equal the polygon's internal number minus one.
• The Input Coverage must contain polygon topology.
• If the specified ID Base value is negative, all new User-IDs will start with the specified value and be decremented by one for each new label point. Negative ID values will not be generated.
• If a coverage contains polygons and only some of the polygons have label points, Create Labels will only generate labels in those polygons for which no labels exist if you specify an ID Base.
• The coordinate precision of the coverage is not changed by Create Labels.

Field Summary

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

vals

Constructor Summary

CreateLabels()
Creates the Create Labels tool with defaults.

CreateLabels(Object inCover)
Creates the Create Labels tool with the required parameters.

Method Summary

int	getIdBase() Returns the ID Base parameter of this tool .
Object	getInCover() Returns the Input Coverage parameter of this tool .
Object	getOutCover() Returns the Output Coverage 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	setIdBase(int idBase) Sets the ID Base parameter of this tool .
void	setInCover(Object inCover) Sets the Input Coverage 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

CreateLabels

public CreateLabels()

Creates the Create Labels tool with defaults.

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

CreateLabels

public CreateLabels(Object inCover)

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

inCover - the coverage to which label points are to be added.

Method Detail

getInCover

public Object getInCover()

Returns the Input Coverage parameter of this tool . This parameter is the coverage to which label points are to be added. This is a required parameter.

Returns:

the Input Coverage

setInCover

public void setInCover(Object inCover)

Sets the Input Coverage parameter of this tool . This parameter is the coverage to which label points are to be added. This is a required parameter.

Parameters:

inCover - the coverage to which label points are to be added.

getIdBase

public int getIdBase()

Returns the ID Base parameter of this tool . This parameter is the minimum User-ID value to be assigned to new label points. the specified value will be the User-ID for the first polygon encountered that has no label point. User-IDs are then incremented by one for each subsequent polygon having no label point. Specifying an ID Base of zero will create new labels for all polygons, where each User-ID will equal the polygon's internal number minus one. This is the default value. This is an optional parameter.

Returns:

the ID Base

setIdBase

public void setIdBase(int idBase)

Sets the ID Base parameter of this tool . This parameter is the minimum User-ID value to be assigned to new label points. the specified value will be the User-ID for the first polygon encountered that has no label point. User-IDs are then incremented by one for each subsequent polygon having no label point. Specifying an ID Base of zero will create new labels for all polygons, where each User-ID will equal the polygon's internal number minus one. This is the default value. This is an optional parameter.

Parameters:

idBase - the minimum User-ID value to be assigned to new label points. the specified value will be the User-ID for the first polygon encountered that has no label point. User-IDs are then incremented by one for each subsequent polygon having no label point. Specifying an ID Base of zero will create new labels for all polygons, where each User-ID will equal the polygon's internal number minus one. This is the default value.

getOutCover

public Object getOutCover()

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

Returns:

the Output Coverage

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