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

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

All Implemented Interfaces:

GPTool

public class TiledLabelsToAnnotation
extends AbstractGPTool

Converts labels to annotation for layers in a map document based on a polygon index layer. The Tiled Labels To Annotation tool is contained in the Cartography Tools tool box.

Usage tips:

• Label class scale ranges are respected. When the tool generates annotation for a specific reference scale it will only convert label classes that are turned on and visible at that scale.
• Once you have configured your label properties, save the map document before running this tool.
• If you select tiles prior to running the tool, annotation will only be created for the selected tiles.
• To update annotation for only some tiles in the polygon index layer, first select the annotation features with that specific TileID value and delete them. Then select the polygon features and re-run the tool.
• One output of this tool is a series of group layers. One group layer will contain a group layer for each reference scale for which annotation was created.
• When working in ArcCatalog or ModelBuilder, you can use the tool to write the output group layer to a layer file. When using ArcMap, the tool adds the group layer to the display if this option is checked in the geoprocessing options. The group layer that is created is temporary and will not persist after the session ends unless the document is saved.
• Group layers created in ArcCatalog cannot be used in ArcMap unless they are saved to a layer file using the tool.
• An existing group layer will be overwritten if the same layer name is specified and if you explicitly state that overwriting outputs is allowed.
• If duplicate feature class names are found in the data frame, a number will be added to the annotation following the feature class name (e.g., Cities01Anno10000, Cities02Anno10000, and so on).
• Annotation feature classes will not be overwritten if a suffix is specified that already exists. In this case a number will be added to the annotation feature class suffix (e.g., CitiesAnno10000, CitiesAnno10000_1, and so on).
• The reference scale for the annotation feature classes can be specified in one of two ways. The first option is to use a field from the polygon index layer to determine the reference scale of the output annotation feature classes. Use this option if you will create annotation for a variety of scale levels. The second option is to explicitly state a reference scale value. All annotation feature classes will use this reference scale. If a reference scale is set in the map document, this will be the default value input into the tool. When using ArcMap, if no reference scale is set the current scale will provide the default value.
• If you are using a polygon index layer that was created by the the tool use the Tile_Scale field for the Reference Scale Field. A new anotation feature class will be created for each layer/Tile_Scale combination.
• If you are producing annotation at a variety of reference scales, design your map for each of those scales and avoid setting a reference scale in the data frame.
• If a coordinate system field from the polygon index layer is provided the annotation for each tile will be projected into that coordinate system for the purpose of drawing and placement.
• Annotation that is feature linked is associated with a specific feature in another feature class in the geodatabase. If checked, when you create the output annotation feature class, a relationship class will be automatically generated as well.
• When creating feature-linked annotation the output workspace must be the same as that of the feature classes they are linked to.
• Some labels may not currently display on the map because there is no room for them. To convert these labels, check the Generate Unplaced Annotation box. This saves the unplaced labels in the annotation feature class, allowing you to position them later in an ArcMap edit session.

Field Summary

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

vals

Constructor Summary

TiledLabelsToAnnotation()
Creates the Tiled Labels To Annotation tool with defaults.

TiledLabelsToAnnotation(Object mapDocument, String dataFrame, Object polygonIndexLayer, Object outGeodatabase, Object outLayer, String annoSuffix)
Creates the Tiled Labels To Annotation tool with the required parameters.

Method Summary

String	getAnnoSuffix() Returns the Annotation Suffix parameter of this tool .
Object	getCoordinateSysField() Returns the Coordinate System Field parameter of this tool .
String	getDataFrame() Returns the Data Frame parameter of this tool .
String	getFeatureLinked() Returns the Generate Feature Linked Annotation parameter of this tool .
String	getGenerateUnplacedAnnotation() Returns the Generate Unplaced Annotation parameter of this tool .
Object	getMapDocument() Returns the Map Document parameter of this tool .
Object	getMapRotationField() Returns the Map Rotation Field parameter of this tool .
Object	getOutGeodatabase() Returns the Output Geodatabase parameter of this tool .
Object	getOutLayer() Returns the Output Layer parameter of this tool .
Object	getOutWorkspace() Returns the Output Geodatabase parameter of this tool (Read only).
Object	getPolygonIndexLayer() Returns the Polygon Index Layer parameter of this tool .
Object	getReferenceScaleField() Returns the Reference Scale Field parameter of this tool .
double	getReferenceScaleValue() Returns the Reference Scale Value parameter of this tool .
Object	getTileIdField() Returns the Tile ID Field 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.
void	setAnnoSuffix(String annoSuffix) Sets the Annotation Suffix parameter of this tool .
void	setCoordinateSysField(Object coordinateSysField) Sets the Coordinate System Field parameter of this tool .
void	setDataFrame(String dataFrame) Sets the Data Frame parameter of this tool .
void	setFeatureLinked(String featureLinked) Sets the Generate Feature Linked Annotation parameter of this tool .
void	setGenerateUnplacedAnnotation(String generateUnplacedAnnotation) Sets the Generate Unplaced Annotation parameter of this tool .
void	setMapDocument(Object mapDocument) Sets the Map Document parameter of this tool .
void	setMapRotationField(Object mapRotationField) Sets the Map Rotation Field parameter of this tool .
void	setOutGeodatabase(Object outGeodatabase) Sets the Output Geodatabase parameter of this tool .
void	setOutLayer(Object outLayer) Sets the Output Layer parameter of this tool .
void	setPolygonIndexLayer(Object polygonIndexLayer) Sets the Polygon Index Layer parameter of this tool .
void	setReferenceScaleField(Object referenceScaleField) Sets the Reference Scale Field parameter of this tool .
void	setReferenceScaleValue(double referenceScaleValue) Sets the Reference Scale Value parameter of this tool .
void	setTileIdField(Object tileIdField) Sets the Tile ID Field 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

TiledLabelsToAnnotation

public TiledLabelsToAnnotation()

Creates the Tiled Labels To Annotation tool with defaults.

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

TiledLabelsToAnnotation

public TiledLabelsToAnnotation(Object mapDocument,
                               String dataFrame,
                               Object polygonIndexLayer,
                               Object outGeodatabase,
                               Object outLayer,
                               String annoSuffix)

Creates the Tiled Labels To Annotation 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:

mapDocument - the source map document that contains the labels to convert to annotation.

dataFrame - the data frame from the map document that contains the labels to convert to annotation.

polygonIndexLayer - the polygon layer that contains tile features.

outGeodatabase - the workspace where the output feature classes will be saved. The workspace can be an existing geodatabase or an existing feature dataset.

outLayer - the group layer that will contain the generated annotation. When working in ArcCatalog, you can use the Save To Layer File tool to write the output group layer to a layer file. When using ArcMap, the tool adds the group layer to the display if this option is checked in the geoprocessing options. The group layer that is created is temporary and will not persist after the session ends unless the document is saved.

annoSuffix - the suffix that will be added to each new annotation feature class. This suffix will be appended to the name of the source feature class for each new annotation feature class. The reference scale for the annotation will follow this suffix.

Method Detail

getMapDocument

public Object getMapDocument()

Returns the Map Document parameter of this tool . This parameter is the source map document that contains the labels to convert to annotation. This is a required parameter.

Returns:

the Map Document

setMapDocument

public void setMapDocument(Object mapDocument)

Sets the Map Document parameter of this tool . This parameter is the source map document that contains the labels to convert to annotation. This is a required parameter.

Parameters:

mapDocument - the source map document that contains the labels to convert to annotation.

getDataFrame

public String getDataFrame()

Returns the Data Frame parameter of this tool . This parameter is the data frame from the map document that contains the labels to convert to annotation. This is a required parameter.

Returns:

the Data Frame

setDataFrame

public void setDataFrame(String dataFrame)

Sets the Data Frame parameter of this tool . This parameter is the data frame from the map document that contains the labels to convert to annotation. This is a required parameter.

Parameters:

dataFrame - the data frame from the map document that contains the labels to convert to annotation.

getPolygonIndexLayer

public Object getPolygonIndexLayer()

Returns the Polygon Index Layer parameter of this tool . This parameter is the polygon layer that contains tile features. This is a required parameter.

Returns:

the Polygon Index Layer

setPolygonIndexLayer

public void setPolygonIndexLayer(Object polygonIndexLayer)

Sets the Polygon Index Layer parameter of this tool . This parameter is the polygon layer that contains tile features. This is a required parameter.

Parameters:

polygonIndexLayer - the polygon layer that contains tile features.

getOutGeodatabase

public Object getOutGeodatabase()

Returns the Output Geodatabase parameter of this tool . This parameter is the workspace where the output feature classes will be saved. The workspace can be an existing geodatabase or an existing feature dataset. This is a required parameter.

Returns:

the Output Geodatabase

setOutGeodatabase

public void setOutGeodatabase(Object outGeodatabase)

Sets the Output Geodatabase parameter of this tool . This parameter is the workspace where the output feature classes will be saved. The workspace can be an existing geodatabase or an existing feature dataset. This is a required parameter.

Parameters:

outGeodatabase - the workspace where the output feature classes will be saved. The workspace can be an existing geodatabase or an existing feature dataset.

getOutLayer

public Object getOutLayer()

Returns the Output Layer parameter of this tool . This parameter is the group layer that will contain the generated annotation. When working in ArcCatalog, you can use the Save To Layer File tool to write the output group layer to a layer file. When using ArcMap, the tool adds the group layer to the display if this option is checked in the geoprocessing options. The group layer that is created is temporary and will not persist after the session ends unless the document is saved. This is a required parameter.

Returns:

the Output Layer

setOutLayer

public void setOutLayer(Object outLayer)

Sets the Output Layer parameter of this tool . This parameter is the group layer that will contain the generated annotation. When working in ArcCatalog, you can use the Save To Layer File tool to write the output group layer to a layer file. When using ArcMap, the tool adds the group layer to the display if this option is checked in the geoprocessing options. The group layer that is created is temporary and will not persist after the session ends unless the document is saved. This is a required parameter.

Parameters:

outLayer - the group layer that will contain the generated annotation. When working in ArcCatalog, you can use the Save To Layer File tool to write the output group layer to a layer file. When using ArcMap, the tool adds the group layer to the display if this option is checked in the geoprocessing options. The group layer that is created is temporary and will not persist after the session ends unless the document is saved.

getAnnoSuffix

public String getAnnoSuffix()

Returns the Annotation Suffix parameter of this tool . This parameter is the suffix that will be added to each new annotation feature class. This suffix will be appended to the name of the source feature class for each new annotation feature class. The reference scale for the annotation will follow this suffix. This is a required parameter.

Returns:

the Annotation Suffix

setAnnoSuffix

public void setAnnoSuffix(String annoSuffix)

Sets the Annotation Suffix parameter of this tool . This parameter is the suffix that will be added to each new annotation feature class. This suffix will be appended to the name of the source feature class for each new annotation feature class. The reference scale for the annotation will follow this suffix. This is a required parameter.

Parameters:

annoSuffix - the suffix that will be added to each new annotation feature class. This suffix will be appended to the name of the source feature class for each new annotation feature class. The reference scale for the annotation will follow this suffix.

getReferenceScaleValue

public double getReferenceScaleValue()

Returns the Reference Scale Value parameter of this tool . This parameter is enter the scale to use as a reference for the annotation. This sets the scale to which all symbol and text sizes in the annotation will be based. This is an optional parameter.

Returns:

the Reference Scale Value

setReferenceScaleValue

public void setReferenceScaleValue(double referenceScaleValue)

Sets the Reference Scale Value parameter of this tool . This parameter is enter the scale to use as a reference for the annotation. This sets the scale to which all symbol and text sizes in the annotation will be based. This is an optional parameter.

Parameters:

referenceScaleValue - enter the scale to use as a reference for the annotation. This sets the scale to which all symbol and text sizes in the annotation will be based.

getReferenceScaleField

public Object getReferenceScaleField()

Returns the Reference Scale Field parameter of this tool . This parameter is the field in the polygon index layer that will determine the reference scale of the annotation. This sets the scale to which all symbol and text sizes in the annotation will be based. This is an optional parameter.

Returns:

the Reference Scale Field

setReferenceScaleField

public void setReferenceScaleField(Object referenceScaleField)

Sets the Reference Scale Field parameter of this tool . This parameter is the field in the polygon index layer that will determine the reference scale of the annotation. This sets the scale to which all symbol and text sizes in the annotation will be based. This is an optional parameter.

Parameters:

referenceScaleField - the field in the polygon index layer that will determine the reference scale of the annotation. This sets the scale to which all symbol and text sizes in the annotation will be based.

getTileIdField

public Object getTileIdField()

Returns the Tile ID Field parameter of this tool . This parameter is a field in the polygon index layer that uniquely identifies the tiled area. These values will populate the TileID field in the annotation feature class attribute table. This is an optional parameter.

Returns:

the Tile ID Field

setTileIdField

public void setTileIdField(Object tileIdField)

Sets the Tile ID Field parameter of this tool . This parameter is a field in the polygon index layer that uniquely identifies the tiled area. These values will populate the TileID field in the annotation feature class attribute table. This is an optional parameter.

Parameters:

tileIdField - a field in the polygon index layer that uniquely identifies the tiled area. These values will populate the TileID field in the annotation feature class attribute table.

getCoordinateSysField

public Object getCoordinateSysField()

Returns the Coordinate System Field parameter of this tool . This parameter is a field in the polygon index layer that contains the coordinate system information for each tile. Due to the length required for a field to store coordinate system information, a polygon index layer that contains a coordinate system field must be a geodatabase feature class. This is an optional parameter.

Returns:

the Coordinate System Field

setCoordinateSysField

public void setCoordinateSysField(Object coordinateSysField)

Sets the Coordinate System Field parameter of this tool . This parameter is a field in the polygon index layer that contains the coordinate system information for each tile. Due to the length required for a field to store coordinate system information, a polygon index layer that contains a coordinate system field must be a geodatabase feature class. This is an optional parameter.

Parameters:

coordinateSysField - a field in the polygon index layer that contains the coordinate system information for each tile. Due to the length required for a field to store coordinate system information, a polygon index layer that contains a coordinate system field must be a geodatabase feature class.

getMapRotationField

public Object getMapRotationField()

Returns the Map Rotation Field parameter of this tool . This parameter is a field in the polygon index layer that contains an angle by which the data frame is to be rotated. This is an optional parameter.

Returns:

the Map Rotation Field

setMapRotationField

public void setMapRotationField(Object mapRotationField)

Sets the Map Rotation Field parameter of this tool . This parameter is a field in the polygon index layer that contains an angle by which the data frame is to be rotated. This is an optional parameter.

Parameters:

mapRotationField - a field in the polygon index layer that contains an angle by which the data frame is to be rotated.

getFeatureLinked

public String getFeatureLinked()

Returns the Generate Feature Linked Annotation parameter of this tool . This parameter is choose whether the output annotation feature class will be linked to the features in another feature class. This is an optional parameter.

Returns:

the Generate Feature Linked Annotation

setFeatureLinked

public void setFeatureLinked(String featureLinked)

Sets the Generate Feature Linked Annotation parameter of this tool . This parameter is choose whether the output annotation feature class will be linked to the features in another feature class. This is an optional parameter.

Parameters:

featureLinked - choose whether the output annotation feature class will be linked to the features in another feature class.

getGenerateUnplacedAnnotation

public String getGenerateUnplacedAnnotation()

Returns the Generate Unplaced Annotation parameter of this tool . This parameter is choose whether to create unplaced annotation from unplaced labels. This is an optional parameter.

Returns:

the Generate Unplaced Annotation

setGenerateUnplacedAnnotation

public void setGenerateUnplacedAnnotation(String generateUnplacedAnnotation)

Sets the Generate Unplaced Annotation parameter of this tool . This parameter is choose whether to create unplaced annotation from unplaced labels. This is an optional parameter.

Parameters:

generateUnplacedAnnotation - choose whether to create unplaced annotation from unplaced labels.

getOutWorkspace

public Object getOutWorkspace()

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

Returns:

the Output Geodatabase

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