com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class AppendAnnotation

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.AppendAnnotation

All Implemented Interfaces:

GPTool

public class AppendAnnotation
extends AbstractGPTool

Creates a new geodatabase annotation feature class or appends to an existing annotation feature class by combining annotation from multiple input geodatabase annotation feature classes into a single feature class with annotation classes. The Append Annotation Feature Classes tool is contained in the Data Management Tools tool box.

Usage tips:

• When appending multiple annotation feature classes into a new annotation feature class, the input annotation feature classes must reside in the same database.
• The output geodatabase annotation feature class cannot be registered as versioned.
• If you select geodatabase annotation features in ArcMap or build a definition query, only those features will be appended to the output feature class.
• When appending feature-linked annotation feature classes, all the input annotation feature classes must be linked to the same feature class.
• If you select an output annotation feature class that already exists, the features will be appended to that feature class and the tool will project the annotation features in the destination spatial reference.
• An Standard or Advanced license is required to create an output annotation feature class that is feature-linked.

Field Summary

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

vals

Constructor Summary

AppendAnnotation()
Creates the Append Annotation Feature Classes tool with defaults.

AppendAnnotation(Object inputFeatures, Object outputFeatureclass, double referenceScale)
Creates the Append Annotation Feature Classes 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	getCreateSingleClass() Returns the Create a single annotation class parameter of this tool .
Object	getInputFeatures() Returns the Input features 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 .
void	setCreateAnnotationWhenFeatureAdded(String createAnnotationWhenFeatureAdded) Sets the Create annotation when new features are added (Feature-linked only) parameter of this tool .
void	setCreateSingleClass(String createSingleClass) Sets the Create a single annotation class parameter of this tool .
void	setInputFeatures(Object inputFeatures) Sets the Input features 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 .

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

AppendAnnotation

public AppendAnnotation()

Creates the Append Annotation Feature Classes tool with defaults.

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

AppendAnnotation

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

Creates the Append Annotation Feature Classes 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 - input annotation features that will form an annotation class in the output feature class.

outputFeatureclass - new annotation feature class that contains an annotation class for each input annotation feature class.

referenceScale - reference scale set in the output feature class. Input features created at a different reference scale will be transformed to match this output reference scale.

Method Detail

getInputFeatures

public Object getInputFeatures()

Returns the Input features parameter of this tool . This parameter is input annotation features that will form an annotation class in the output feature class. 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 input annotation features that will form an annotation class in the output feature class. This is a required parameter.

Parameters:

inputFeatures - input annotation features that will form an annotation class in the output feature class.

getOutputFeatureclass

public Object getOutputFeatureclass()

Returns the Output feature class parameter of this tool . This parameter is new annotation feature class that contains an annotation class for each input annotation feature class. 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 new annotation feature class that contains an annotation class for each input annotation feature class. This is a required parameter.

Parameters:

outputFeatureclass - new annotation feature class that contains an annotation class for each input annotation feature class.

getReferenceScale

public double getReferenceScale()

Returns the Reference scale parameter of this tool . This parameter is reference scale set in the output feature class. Input features created at a different reference scale will be transformed to match this output reference scale. 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 reference scale set in the output feature class. Input features created at a different reference scale will be transformed to match this output reference scale. This is a required parameter.

Parameters:

referenceScale - reference scale set in the output feature class. Input features created at a different reference scale will be transformed to match this output reference scale.

getCreateSingleClass

public String getCreateSingleClass()

Returns the Create a single annotation class parameter of this tool . This parameter is specifies how annotation features will be added to the output feature class. This is an optional parameter.

Returns:

the Create a single annotation class

setCreateSingleClass

public void setCreateSingleClass(String createSingleClass)

Sets the Create a single annotation class parameter of this tool . This parameter is specifies how annotation features will be added to the output feature class. This is an optional parameter.

Parameters:

createSingleClass - specifies how annotation features will be added to the output feature class.

getRequireSymbolFromTable

public String getRequireSymbolFromTable()

Returns the Require symbols to be selected from the symbol table parameter of this tool . This parameter is specifies how symbols can be selected for newly created annotation features. 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 specifies how symbols can be selected for newly created annotation features. This is an optional parameter.

Parameters:

requireSymbolFromTable - specifies how symbols can be selected for newly created annotation features.

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. specifies if feature-linked annotation is created when a feature is added. 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. specifies if feature-linked annotation is created when a feature is added. This is an optional parameter.

Parameters:

createAnnotationWhenFeatureAdded - this parameter is only available with Standard and Advanced licenses. specifies if feature-linked annotation is created when a feature is added.

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. specifies if feature-linked annotation is updated when a linked feature changes. 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. specifies if feature-linked annotation is updated when a linked feature changes. This is an optional parameter.

Parameters:

updateAnnotationWhenFeatureModified - this parameter is only available with Standard and Advanced licenses. specifies if feature-linked annotation is updated when a linked feature changes.

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