com.esri.arcgis.geoprocessing.tools.conversiontools
Class ImportCoverageAnnotation

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.conversiontools.ImportCoverageAnnotation

All Implemented Interfaces:

GPTool

public class ImportCoverageAnnotation
extends AbstractGPTool

Converts a collection of coverage annotation features to geodatabase annotation. You can convert each level to individual annotation classes or merge them into a single class. Also, if you choose map layers as input, the level and font overrides will be honored. The Import Coverage Annotation tool is contained in the Conversion Tools tool box.

Usage tips:

• The conversion requires an so it may not be opened by another application. Output written to ArcSDE geodatabases will not be versioned.
• You can link annotation features to features in a point, line, or polygon feature class. If converting annotation to ArcSDE, the link feature class must not be registered as versioned.
• You can convert each coverage annotation level to individual annotation classes or merge them into a single class.
• If you select coverage annotation features and/or use a definition query, only those features that are selected and visible will be converted.
• You can create a selection set of coverage features and create a new layer from the selection. If you use that new layer as input to the conversion, only those features in the layer will be converted.
• If you override the font symbol or color for coverage annotation features, those settings will be honored during the conversion. If you want to convert more than one annotation feature class using the symbol overrides that you applied to one layer, make sure that layer is the first input, and check the option to Match symbols from first input.
• Choose a reference scale that is roughly equal to the scale at which the annotation will normally be displayed. You can think of the reference scale as "freezing" the symbol and text sizes to a particular map scale. When viewing the map, the symbol and text sizes change depending on the viewing scale. Symbols and text will appear larger as you zoom in (the current map scale is larger than the reference scale) and smaller when you zoom out (the current map scale is smaller than the reference scale).
• 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. This relationship class defines the relationship between the annotation and the features and enables you to define and customize this relationship. It will not establish the links between features and annotation. That will have to be done within the ArcMap Editor.

Field Summary

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

vals

Constructor Summary

ImportCoverageAnnotation()
Creates the Import Coverage Annotation tool with defaults.

ImportCoverageAnnotation(Object inputFeatures, Object outputFeatureclass, double referenceScale)
Creates the Import Coverage Annotation tool with the required parameters.

Method Summary

String	getCreateAnnotationWhenFeatureAdded() Returns the Create annotation when new features are added (Feature-linked only) parameter of this tool .
String	getFeatureLinked() Returns the Feature-linked parameter of this tool .
Object	getInputFeatures() Returns the Input features parameter of this tool .
Object	getLinkedFeatureClass() Returns the Linked feature class parameter of this tool .
String	getMatchSymbolsFromFirstInput() Returns the Match symbols from first input parameter of this tool .
Object	getOutputFeatureclass() Returns the Output feature class parameter of this tool .
double	getReferenceScale() Returns the Reference scale parameter of this tool .
String	getRequireSymbolFromTable() Returns the Require symbols to be selected from the symbol table 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	getUpdateAnnotationWhenFeatureModified() Returns the Update annotation when the shape of the linked feature is modified (Feature-linked only) parameter of this tool .
String	getUseLevels() Returns the Create annotation classes from levels parameter of this tool .
void	setCreateAnnotationWhenFeatureAdded(String createAnnotationWhenFeatureAdded) Sets the Create annotation when new features are added (Feature-linked only) parameter of this tool .
void	setFeatureLinked(String featureLinked) Sets the Feature-linked parameter of this tool .
void	setInputFeatures(Object inputFeatures) Sets the Input features parameter of this tool .
void	setLinkedFeatureClass(Object linkedFeatureClass) Sets the Linked feature class parameter of this tool .
void	setMatchSymbolsFromFirstInput(String matchSymbolsFromFirstInput) Sets the Match symbols from first input parameter of this tool .
void	setOutputFeatureclass(Object outputFeatureclass) Sets the Output feature class parameter of this tool .
void	setReferenceScale(double referenceScale) Sets the Reference scale parameter of this tool .
void	setRequireSymbolFromTable(String requireSymbolFromTable) Sets the Require symbols to be selected from the symbol table parameter of this tool .
void	setUpdateAnnotationWhenFeatureModified(String updateAnnotationWhenFeatureModified) Sets the Update annotation when the shape of the linked feature is modified (Feature-linked only) parameter of this tool .
void	setUseLevels(String useLevels) Sets the Create annotation classes from levels 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

ImportCoverageAnnotation

public ImportCoverageAnnotation()

Creates the Import Coverage Annotation tool with defaults.

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

ImportCoverageAnnotation

public ImportCoverageAnnotation(Object inputFeatures,
                                Object outputFeatureclass,
                                double referenceScale)

Creates the Import Coverage 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:

inputFeatures - the coverage annotation features that you want to convert to geodatabase annotation. If you choose a coverage annotation layer in ArcMap, the following properties of that layer will be honored during the conversion:

outputFeatureclass - browse into an existing geodatabase and type in the name of the new annotation feature class to create.

referenceScale - 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.

Method Detail

getInputFeatures

public Object getInputFeatures()

Returns the Input features parameter of this tool . This parameter is the coverage annotation features that you want to convert to geodatabase annotation. If you choose a coverage annotation layer in ArcMap, the following properties of that layer will be honored during the conversion: This is a required parameter.

Returns:

the Input features

setInputFeatures

public void setInputFeatures(Object inputFeatures)

Sets the Input features parameter of this tool . This parameter is the coverage annotation features that you want to convert to geodatabase annotation. If you choose a coverage annotation layer in ArcMap, the following properties of that layer will be honored during the conversion: This is a required parameter.

Parameters:

inputFeatures - the coverage annotation features that you want to convert to geodatabase annotation. If you choose a coverage annotation layer in ArcMap, the following properties of that layer will be honored during the conversion:

getOutputFeatureclass

public Object getOutputFeatureclass()

Returns the Output feature class parameter of this tool . This parameter is browse into an existing geodatabase and type in the name of the new annotation feature class to create. This is a required parameter.

Returns:

the Output feature class

setOutputFeatureclass

public void setOutputFeatureclass(Object outputFeatureclass)

Sets the Output feature class parameter of this tool . This parameter is browse into an existing geodatabase and type in the name of the new annotation feature class to create. This is a required parameter.

Parameters:

outputFeatureclass - browse into an existing geodatabase and type in the name of the new annotation feature class to create.

getReferenceScale

public double getReferenceScale()

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

setReferenceScale

public void setReferenceScale(double referenceScale)

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:

referenceScale - 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.

getUseLevels

public String getUseLevels()

Returns the Create annotation classes from levels parameter of this tool . This parameter is this parameter is only available with Standard and Advanced licenses. specify whether all coverage annotation drawing levels will be converted to annotation classes within the feature class. This is an optional parameter.

Returns:

the Create annotation classes from levels

setUseLevels

public void setUseLevels(String useLevels)

Sets the Create annotation classes from levels parameter of this tool . This parameter is this parameter is only available with Standard and Advanced licenses. specify whether all coverage annotation drawing levels will be converted to annotation classes within the feature class. This is an optional parameter.

Parameters:

useLevels - this parameter is only available with Standard and Advanced licenses. specify whether all coverage annotation drawing levels will be converted to annotation classes within the feature class.

getMatchSymbolsFromFirstInput

public String getMatchSymbolsFromFirstInput()

Returns the Match symbols from first input parameter of this tool . This parameter is if you are converting coverage annotation from more than one coverage or annotation subclass and need to substitute the font properties for a symbol and apply them to all the input features, you can use this option. This is an optional parameter.

Returns:

the Match symbols from first input

setMatchSymbolsFromFirstInput

public void setMatchSymbolsFromFirstInput(String matchSymbolsFromFirstInput)

Sets the Match symbols from first input parameter of this tool . This parameter is if you are converting coverage annotation from more than one coverage or annotation subclass and need to substitute the font properties for a symbol and apply them to all the input features, you can use this option. This is an optional parameter.

Parameters:

matchSymbolsFromFirstInput - if you are converting coverage annotation from more than one coverage or annotation subclass and need to substitute the font properties for a symbol and apply them to all the input features, you can use this option.

getRequireSymbolFromTable

public String getRequireSymbolFromTable()

Returns the Require symbols to be selected from the symbol table parameter of this tool . This parameter is specify whether the output annotation features must reference a symbol stored in the symbol collection for the feature class. This is an optional parameter.

Returns:

the Require symbols to be selected from the symbol table

setRequireSymbolFromTable

public void setRequireSymbolFromTable(String requireSymbolFromTable)

Sets the Require symbols to be selected from the symbol table parameter of this tool . This parameter is specify whether the output annotation features must reference a symbol stored in the symbol collection for the feature class. This is an optional parameter.

Parameters:

requireSymbolFromTable - specify whether the output annotation features must reference a symbol stored in the symbol collection for the feature class.

getFeatureLinked

public String getFeatureLinked()

Returns the Feature-linked parameter of this tool . This parameter is this parameter is only available with Standard and Advanced licenses. choose whether the output annotation feature class will be linked to the features in another feature class. This is an optional parameter.

Returns:

the Feature-linked

setFeatureLinked

public void setFeatureLinked(String featureLinked)

Sets the Feature-linked parameter of this tool . This parameter is this parameter is only available with Standard and Advanced licenses. choose whether the output annotation feature class will be linked to the features in another feature class. This is an optional parameter.

Parameters:

featureLinked - this parameter is only available with Standard and Advanced licenses. choose whether the output annotation feature class will be linked to the features in another feature class.

getLinkedFeatureClass

public Object getLinkedFeatureClass()

Returns the Linked feature class parameter of this tool . This parameter is this parameter is only available with Standard and Advanced licenses. the feature class to which you are linking annotation features. This option is only available if you choose FEATURE_LINKED for the previous parameter. This is an optional parameter.

Returns:

the Linked feature class

setLinkedFeatureClass

public void setLinkedFeatureClass(Object linkedFeatureClass)

Sets the Linked feature class parameter of this tool . This parameter is this parameter is only available with Standard and Advanced licenses. the feature class to which you are linking annotation features. This option is only available if you choose FEATURE_LINKED for the previous parameter. This is an optional parameter.

Parameters:

linkedFeatureClass - this parameter is only available with Standard and Advanced licenses. the feature class to which you are linking annotation features. This option is only available if you choose FEATURE_LINKED for the previous parameter.

getCreateAnnotationWhenFeatureAdded

public String getCreateAnnotationWhenFeatureAdded()

Returns the Create annotation when new features are added (Feature-linked only) parameter of this tool . This parameter is this parameter is only available with Standard and Advanced licenses. specify whether new annotation will be generated when you add new features to the feature class to which this annotation feature class is linked. this option is only available if you choose FEATURE_LINKED for the Feature-linked parameter and specify a Linked Feature Class. This is an optional parameter.

Returns:

the Create annotation when new features are added (Feature-linked only)

setCreateAnnotationWhenFeatureAdded

public void setCreateAnnotationWhenFeatureAdded(String createAnnotationWhenFeatureAdded)

Sets the Create annotation when new features are added (Feature-linked only) parameter of this tool . This parameter is this parameter is only available with Standard and Advanced licenses. specify whether new annotation will be generated when you add new features to the feature class to which this annotation feature class is linked. this option is only available if you choose FEATURE_LINKED for the Feature-linked parameter and specify a Linked Feature Class. This is an optional parameter.

Parameters:

createAnnotationWhenFeatureAdded - this parameter is only available with Standard and Advanced licenses. specify whether new annotation will be generated when you add new features to the feature class to which this annotation feature class is linked. this option is only available if you choose FEATURE_LINKED for the Feature-linked parameter and specify a Linked Feature Class.

getUpdateAnnotationWhenFeatureModified

public String getUpdateAnnotationWhenFeatureModified()

Returns the Update annotation when the shape of the linked feature is modified (Feature-linked only) parameter of this tool . This parameter is this parameter is only available with Standard and Advanced licenses. specify whether the ArcMap Editor will automatically update the placement of annotation when you edit features in the feature class to which this annotation feature class is linked. this option is only available if you choose FEATURE_LINKED for the Feature-linked parameter and specify a Linked Feature Class. This is an optional parameter.

Returns:

the Update annotation when the shape of the linked feature is modified (Feature-linked only)

setUpdateAnnotationWhenFeatureModified

public void setUpdateAnnotationWhenFeatureModified(String updateAnnotationWhenFeatureModified)

Sets the Update annotation when the shape of the linked feature is modified (Feature-linked only) parameter of this tool . This parameter is this parameter is only available with Standard and Advanced licenses. specify whether the ArcMap Editor will automatically update the placement of annotation when you edit features in the feature class to which this annotation feature class is linked. this option is only available if you choose FEATURE_LINKED for the Feature-linked parameter and specify a Linked Feature Class. This is an optional parameter.

Parameters:

updateAnnotationWhenFeatureModified - this parameter is only available with Standard and Advanced licenses. specify whether the ArcMap Editor will automatically update the placement of annotation when you edit features in the feature class to which this annotation feature class is linked. this option is only available if you choose FEATURE_LINKED for the Feature-linked parameter and specify a Linked Feature Class.

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