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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.datamanagementtools.AppendAnnotation
All Implemented Interfaces:
GPTool

public class AppendAnnotation
extends AbstractGPTool

Creates a new geodatabase 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.

Software restrictions: none

Usage tips:


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 - Feature Layer, input annotation features that will form an annotation class in the output feature class.
outputFeatureclass - Feature Class, new annotation feature class that contains an annotation class for each input annotation feature class.
referenceScale - Double, scale set in the output feature class. Input features created at a different reference scale will be transformed to match the output reference scale.
Method Detail

getInputFeatures

public Object getInputFeatures()
Returns the Input features parameter of this tool . This parameter is Feature Layer, 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 Feature Layer, input annotation features that will form an annotation class in the output feature class. This is a required parameter.

Parameters:
inputFeatures - Feature Layer, 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 Feature Class, 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 Feature Class, new annotation feature class that contains an annotation class for each input annotation feature class. This is a required parameter.

Parameters:
outputFeatureclass - Feature Class, 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 Double, scale set in the output feature class. Input features created at a different reference scale will be transformed to match the 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 Double, scale set in the output feature class. Input features created at a different reference scale will be transformed to match the output reference scale. This is a required parameter.

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

getCreateSingleClass

public String getCreateSingleClass()
Returns the Create a single annotation class parameter of this tool . This parameter is String, when checked, all annotation features will be aggregated into one annotation class within the 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 String, when checked, all annotation features will be aggregated into one annotation class within the feature class. This is an optional parameter.

Parameters:
createSingleClass - String, when checked, all annotation features will be aggregated into one annotation class within the feature class.

getRequireSymbolFromTable

public String getRequireSymbolFromTable()
Returns the Require symbols to be selected from the symbol table parameter of this tool . This parameter is String, restrict the creation of annotation features to the list of symbols in the symbol collection of the output 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 String, restrict the creation of annotation features to the list of symbols in the symbol collection of the output feature class. This is an optional parameter.

Parameters:
requireSymbolFromTable - String, restrict the creation of annotation features to the list of symbols in the symbol collection of the output feature class.

getCreateAnnotationWhenFeatureAdded

public String getCreateAnnotationWhenFeatureAdded()
Returns the Create annotation when new features are added (Feature-linked only) parameter of this tool . This parameter is String, use the label engine to place feature-linked annotation when a linked feature is created. 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 String, use the label engine to place feature-linked annotation when a linked feature is created. This is an optional parameter.

Parameters:
createAnnotationWhenFeatureAdded - String, use the label engine to place feature-linked annotation when a linked feature is created.

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 String, use the label engine to update feature-linked annotation 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 String, use the label engine to update feature-linked annotation when a linked feature changes. This is an optional parameter.

Parameters:
updateAnnotationWhenFeatureModified - String, use the label engine to update feature-linked annotation 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