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

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

All Implemented Interfaces:

GPTool

public class ContourAnnotation
extends AbstractGPTool

Creates annotation for contour features. The Contour Annotation tool is contained in the Cartography Tools tool box.

Usage tips:

• The output of this tool is a group layer. The group layer will contain the input contour features, the annotation layer, and the mask polygons.
• An existing group layer will be overwritten if the same layer name is specified and if you explicitly state that overwriting outputs is allowed.
• 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.
• Annotation feature classes will not be overwritten if the tool is run multiple times on a single contour feature class. In this case, a number will be added to the annotation feature class (e.g., ContourAnno, ContourAnno_1, and so on).
• Each mask will be created with a two-point margin around the annotation feature and a mask type of exact simplified, meaning that the mask will be a generalized polygon representing the exact shape of the annotation.
• There are three choices for the color of the contour layer and output annotation: black, brown, and blue.
• Contours that have been created using the tool contain a Type field. The Type field contains one or more of the following values: 1 for contours 2 for indexed contours 3 for explicit contoursThis Type field can be used as input for the Contour Type Field parameter. A separate annotation class will be created for annotation of each type.

Field Summary

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

vals

Constructor Summary

ContourAnnotation()
Creates the Contour Annotation tool with defaults.

ContourAnnotation(Object inFeatures, Object outGeodatabase, Object contourLabelField, double referenceScaleValue, Object outLayer, String contourColor)
Creates the Contour Annotation tool with the required parameters.

Method Summary

String	getContourAlignment() Returns the Contour Alignment parameter of this tool .
String	getContourColor() Returns the Contour and Label Color parameter of this tool .
Object	getContourLabelField() Returns the Contour Label Field parameter of this tool .
Object	getContourTypeField() Returns the Contour Type Field parameter of this tool .
String	getEnableLaddering() Returns the Enable Laddering parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutGeodatabase() Returns the Output Geodatabase parameter of this tool .
Object	getOutGeodatabase2() Returns the Output Workspace parameter of this tool (Read only).
Object	getOutLayer() Returns the Output Layer Name parameter of this tool .
double	getReferenceScaleValue() Returns the Reference Scale 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	setContourAlignment(String contourAlignment) Sets the Contour Alignment parameter of this tool .
void	setContourColor(String contourColor) Sets the Contour and Label Color parameter of this tool .
void	setContourLabelField(Object contourLabelField) Sets the Contour Label Field parameter of this tool .
void	setContourTypeField(Object contourTypeField) Sets the Contour Type Field parameter of this tool .
void	setEnableLaddering(String enableLaddering) Sets the Enable Laddering parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setOutGeodatabase(Object outGeodatabase) Sets the Output Geodatabase parameter of this tool .
void	setOutLayer(Object outLayer) Sets the Output Layer Name parameter of this tool .
void	setReferenceScaleValue(double referenceScaleValue) Sets the Reference 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

ContourAnnotation

public ContourAnnotation()

Creates the Contour Annotation tool with defaults.

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

ContourAnnotation

public ContourAnnotation(Object inFeatures,
                         Object outGeodatabase,
                         Object contourLabelField,
                         double referenceScaleValue,
                         Object outLayer,
                         String contourColor)

Creates the Contour 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:

inFeatures - the contour line feature class for which the annotation will be created.

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

contourLabelField - the field in the input layer attribute table upon which the annotation text will be based.

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.

outLayer - the group layer that will contain the contour layer, the annotation, and the mask layer. 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.

contourColor - the color of the output contour layer and annotation features.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the contour line feature class for which the annotation will be created. 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 the contour line feature class for which the annotation will be created. This is a required parameter.

Parameters:

inFeatures - the contour line feature class for which the annotation will be created.

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.

getContourLabelField

public Object getContourLabelField()

Returns the Contour Label Field parameter of this tool . This parameter is the field in the input layer attribute table upon which the annotation text will be based. This is a required parameter.

Returns:

the Contour Label Field

setContourLabelField

public void setContourLabelField(Object contourLabelField)

Sets the Contour Label Field parameter of this tool . This parameter is the field in the input layer attribute table upon which the annotation text will be based. This is a required parameter.

Parameters:

contourLabelField - the field in the input layer attribute table upon which the annotation text will be based.

getReferenceScaleValue

public double getReferenceScaleValue()

Returns the Reference Scale 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 a required parameter.

Returns:

the Reference Scale

setReferenceScaleValue

public void setReferenceScaleValue(double referenceScaleValue)

Sets the Reference Scale 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 a required 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.

getOutLayer

public Object getOutLayer()

Returns the Output Layer Name parameter of this tool . This parameter is the group layer that will contain the contour layer, the annotation, and the mask layer. 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 Name

setOutLayer

public void setOutLayer(Object outLayer)

Sets the Output Layer Name parameter of this tool . This parameter is the group layer that will contain the contour layer, the annotation, and the mask layer. 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 contour layer, the annotation, and the mask layer. 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.

getContourColor

public String getContourColor()

Returns the Contour and Label Color parameter of this tool . This parameter is the color of the output contour layer and annotation features. This is a required parameter.

Returns:

the Contour and Label Color

setContourColor

public void setContourColor(String contourColor)

Sets the Contour and Label Color parameter of this tool . This parameter is the color of the output contour layer and annotation features. This is a required parameter.

Parameters:

contourColor - the color of the output contour layer and annotation features.

getContourTypeField

public Object getContourTypeField()

Returns the Contour Type Field parameter of this tool . This parameter is the field in the input layer attribute table containing a value for the type of contour feature. An annotation class will be created for each type value. This is an optional parameter.

Returns:

the Contour Type Field

setContourTypeField

public void setContourTypeField(Object contourTypeField)

Sets the Contour Type Field parameter of this tool . This parameter is the field in the input layer attribute table containing a value for the type of contour feature. An annotation class will be created for each type value. This is an optional parameter.

Parameters:

contourTypeField - the field in the input layer attribute table containing a value for the type of contour feature. An annotation class will be created for each type value.

getContourAlignment

public String getContourAlignment()

Returns the Contour Alignment parameter of this tool . This parameter is this parameter is only available with the Maplex extension. the annotation can be aligned to the contour elevations so that the top of the text is always placed uphill. This option allows the annotation to be placed upside down. The contour annotation can also be aligned to the page, ensuring that the text is never placed upside down. This is an optional parameter.

Returns:

the Contour Alignment

setContourAlignment

public void setContourAlignment(String contourAlignment)

Sets the Contour Alignment parameter of this tool . This parameter is this parameter is only available with the Maplex extension. the annotation can be aligned to the contour elevations so that the top of the text is always placed uphill. This option allows the annotation to be placed upside down. The contour annotation can also be aligned to the page, ensuring that the text is never placed upside down. This is an optional parameter.

Parameters:

contourAlignment - this parameter is only available with the Maplex extension. the annotation can be aligned to the contour elevations so that the top of the text is always placed uphill. This option allows the annotation to be placed upside down. The contour annotation can also be aligned to the page, ensuring that the text is never placed upside down.

getEnableLaddering

public String getEnableLaddering()

Returns the Enable Laddering parameter of this tool . This parameter is this parameter is only available with the Maplex extension. placing annotation in ladders will place the text so it appears to step up and step down the contours in a straight path. These ladders will run from the top of a hill to the bottom, will not cross each other, will belong to a single slope, and will not cross any other slope. This is an optional parameter.

Returns:

the Enable Laddering

setEnableLaddering

public void setEnableLaddering(String enableLaddering)

Sets the Enable Laddering parameter of this tool . This parameter is this parameter is only available with the Maplex extension. placing annotation in ladders will place the text so it appears to step up and step down the contours in a straight path. These ladders will run from the top of a hill to the bottom, will not cross each other, will belong to a single slope, and will not cross any other slope. This is an optional parameter.

Parameters:

enableLaddering - this parameter is only available with the Maplex extension. placing annotation in ladders will place the text so it appears to step up and step down the contours in a straight path. These ladders will run from the top of a hill to the bottom, will not cross each other, will belong to a single slope, and will not cross any other slope.

getOutGeodatabase2

public Object getOutGeodatabase2()

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

Returns:

the Output Workspace

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