com.esri.arcgis.geoprocessing
Interface GPTool

All Known Implementing Classes:

Abs, AbstractGPTool, ACos, ACosH, AddCADFields, AddCodedValueToDomain, AddColormap, AddFeatureClassToTerrain, AddFeatureClassToTopology, AddField, AddFieldToAnalysisLayer, AddGlobalIDs, AddIndex, AddItem, AddJoin, AddLocations, AddRastersToMosaicDataset, AddRepresentation, AddRuleToTopology, AddSpatialIndex, AddSubtype, AddSurfaceInformation, AddTerrainPoints, AddTerrainPyramidLevel, AddXY, AddXY, AddZInformation, Adjust3DZ, Aggregate, AggregatePoints, AggregatePolygons, AggregatePolygons, AggregatePolygons, AlignMarkerToStrokeOrFill, AlterVersion, Analyze, Append, Append, AppendAnnotation, AppendTerrainPoints, ApplySymbologyFromLayer, ArcDLG, ArcRoute, ArcS57, AreaSolarRadiation, Ascii3DToFeatureClass, ASCIIToRaster, ASin, ASinH, Aspect, Aspect, AssignDefaultToField, AssignDomainToField, ATan, ATan2, ATanH, AverageNearestNeighbor, BandCollectionStats, Basin, BatchBuildPyramids, BatchCalculateStatistics, BatchDefine, BatchProject, BearingDistanceToLine, BitwiseAnd, BitwiseLeftShift, BitwiseNot, BitwiseOr, BitwiseRightShift, BitwiseXOr, BlockStatistics, BooleanAnd, BooleanNot, BooleanOr, BooleanXOr, BoundaryClean, Buffer, Buffer, Build, BuildBoundary, BuildFootprints, BuildNetwork, BuildOverviews, BuildPyramids, BuildPyramidsandStatistics, BuildRasterAttributeTable, BuildSeamlines, BuildTerrain, CADLinestoPolygonFeatures, CADtoFeatureClass, CADtoFeatureClasswithAttributeofNearestPoint, CadToGeodatabase, CalculateAdjacentFields, CalculateAreas, CalculateCellSizeRanges, CalculateCentralMeridianAndParallels, CalculateDefaultClusterTolerance, CalculateDefaultGridIndex, CalculateDistanceBand, CalculateEndDate, CalculateEndTime, CalculateField, CalculateGeodesicAngle, CalculateGridConvergenceAngle, CalculateLineCaps, CalculateLocations, CalculatePolygonMainAngle, CalculateRepresentationRule, CalculateStatistics, CalculateUTMZone, CalculateValue, CalibrateRoutes, CellStatistics, CentralFeature, ChangePrivileges, ChangeTerrainReferenceScale, ChangeTerrainResolutionBounds, ChangeVersion, CheckGeometry, Checkin, CheckinDelta, Checkout, ClassProbability, Clean, ClearWorkspaceCache, Clip, Clip, Clip, ClustersOutliers, ClustersOutliersRendered, CollapseDualLinesToCenterline, CollapseDualLinesToCenterline, CollapseDualLinesToCenterline, CollectEvents, CollectEventsRendered, ColorBalanceMosaicDataset, CombinatorialAnd, CombinatorialOr, CombinatorialXOr, Combine, Compact, CompareReplicaSchema, CompositeBands, Compress, CompressFileGeodatabaseData, ComputeDirtyArea, ConcatenateDateAndTimeFields, ConsolidateLayer, ConsolidateMap, ConsolidateToolbox, ConstructSightLines, ConTool, Contour, Contour, ContourAnnotation, ContourList, ContourList, ContourWithBarriers, ContourWithBarriers, ConvertCoordinateNotation, ConvertDiagram, ConvertMapServerCacheStorageFormat, ConvertSpatialWeightsMatrixtoTable, ConvertTimeField, ConvertTimeZone, Copy, CopyFeatures, CopyRaster, CopyRasterCatalogItems, CopyRows, CopyTin, Corridor, Cos, CosH, CostAllocation, CostBackLink, CostDistance, CostPath, CountRenderer, Create, CreateAddressLocator, CreateArcInfoWorkspace, CreateArcSDEConnectionFile, CreateCADXData, CreateCompositeAddressLocator, CreateConstantRaster, CreateCustomGeoTransformation, CreateDiagram, CreateDomain, CreateFeatureclass, CreateFeatureClasswithAllJoinsfromStagingGeodatabase, CreateFeatureDataset, CreateFeaturesFromTextFile, CreateFileGDB, CreateFishnet, CreateFolder, CreateLabels, CreateMapServerCache, CreateMosaicDataset, CreateNormalRaster, CreateOrthoCorrectedRasterDataset, CreateOverpass, CreatePansharpenedRasterDataset, CreatePersonalGDB, CreateRandomPoints, CreateRandomRaster, CreateRandomRaster, CreateRasterCatalog, CreateRasterDataset, CreateReferencedMosaicDataset, CreateRelationshipClass, CreateReplica, CreateReplicaFootPrints, CreateReplicaFromServer, CreateRoutes, CreateSchematicFolder, CreateSignatures, CreateSpatiallyBalancedPoints, CreateSpatialReference, CreateTable, CreateTerrain, CreateThiessenPolygons, CreateTin, CreateTopology, CreateTurnFeatureClass, CreateUnderpass, CreateVersion, CrossValidation, CulDeSacMasks, Curvature, Curvature, CutFill, CutFill, DarcyFlow, DarcyVelocity, DecimateTinNodes, DefineMosaicDatasetNoData, DefineOverviews, DefineProjection, DefineProjection, Delete, DeleteCodedValueFromDomain, DeleteColormap, DeleteDomain, DeleteFeatures, DeleteField, DeleteGlobeServerCache, DeleteGridsAndGraticules, DeleteIdentical, DeleteMapServerCache, DeleteRasterAttributeTable, DeleteRasterCatalogItems, DeleteRows, DeleteTerrainPoints, DeleteVersion, DelineateTinDataArea, DEMToRaster, Dendrogram, DensifySamplingNetwork, DetectGraphicConflict, Dice, Diff, Difference3D, DiffusionInterpolationWithBarriers, DirectionalDistribution, DirectionalMean, Directions, DisperseMarkers, Dissolve, Dissolve, DissolveNetwork, DissolveRouteEvents, Divide, Divide, DLGArc, DomainToTable, DropIndex, DropItem, DropRepresentation, EditSignatures, EditTin, Eliminate, Eliminate, EliminatePolygonPart, EqualTo, EqualToFrequency, Erase, Erase, ESRITranslator, EucAllocation, EucDirection, EucDistance, Exp, Exp10, Exp2, Expand, Export, ExportAcknowledgementMessage, ExportCAD, ExportDataChangeMessage, ExportMapServerCache, ExportMetadata, ExportMetadataMultiple, ExportRasterCatalogPaths, ExportRasterWorldFile, ExportReplicaSchema, ExporttoDelta, ExportXYv, ExtractByAttributes, ExtractByCircle, ExtractByMask, ExtractByPoints, ExtractByPolygon, ExtractByRectangle, ExtractData, ExtractDataAndEmailTask, ExtractDataTask, ExtractMultiValuesToPoints, ExtractPackage, ExtractSubDataset, ExtractValuesToPoints, ExtractValuesToTable, ExtrudeBetween, FeatureclassToCoverage, FeatureClassToFeatureClass, FeatureClassToGeodatabase, FeatureClassToShapefile, FeatureClassZToASCII, FeatureCompare, FeatureEnvelopeToPolygon, FeatureOutlineMasks, FeatureTo3DByAttribute, FeatureToLine, FeatureToNetCDF, FeatureToPoint, FeatureToPolygon, FeatureToRaster, FeatureVerticesToPoints, FileCompare, Fill, Filter, FindConflicts, FindIdentical, Flip, Float, Float, FloatToRaster, FlowAccumulation, FlowDirection, FlowLength, FocalFlow, FocalStatistics, Frequency, FuzzyMembership, FuzzyOverlay, GACalculateZValue, GACreateGeostatisticalLayer, GAGetModelParameter, GALayerToContour, GALayerToGrid, GALayerToPoints, GAMovingWindowKriging, GANeighborhoodSelection, GASemivariogramSensitivity, GASetModelParameter, GaussianGeostatisticalSimulations, Generate, GenerateExcludeArea, GenerateGlobeServerCache, GenerateMapServerCache, GenerateMapServerCacheTilingScheme, GenerateNearTable, GenerateNetworkSpatialWeights, GenerateSpatialWeightsMatrix, GenericGPTool, GeocodeAddresses, GeographicallyWeightedRegression, GetCellValue, GetCount, GetRasterProperties, GlobalPolynomialInterpolation, GreaterThan, GreaterThanEqual, GreaterThanFrequency, GridIndexFeatures, HighestPosition, HighLowClustering, HillShade, HillShade, HotSpots, HotSpotsRendered, IDEdit, Identity, Identity, Idw, Idw, IDW, Import, Import3DFiles, ImportCAD, ImportCADAnnotation, ImportCoverageAnnotation, ImportFromE00, ImportMapServerCache, ImportMessage, ImportMetadata, ImportMosaicDatasetGeometry, ImportReplicaSchema, IncreaseMaximumEdges, IndexItem, InList, Inside3D, Int, Int, Integrate, InterpolatePolyToPatch, InterpolateShape, Intersect, Intersect, Intersect3D, Intersect3DLineWithMultiPatch, IntersectingLayersMasks, IsClosed3D, IsNull, IsoCluster, IsoClusterUnsupervisedClassification, JoinField, JoinItem, KernelDensity, KernelInterpolationWithBarriers, KMLToLayer, Kriging, Kriging, LandXMLToTin, LASToMultipoint, Layer3DToFeatureClass, LayerToKML, LayerToKML, LessThan, LessThanEqual, LessThanFrequency, LineDensity, LineOfSight, LineStatistics, Ln, LocalPolynomialInterpolation, LocateFeaturesAlongRoutes, LocateOutliers, Log10, Log2, Lookup, Lookup, LowestPosition, MajorityFilter, MakeClosestFacilityLayer, MakeFeatureLayer, MakeGraph, MakeGridsAndGraticulesLayer, MakeImageServerLayer, MakeLocationAllocationLayer, MakeMosaicLayer, MakeNetCDFFeatureLayer, MakeNetCDFRasterLayer, MakeNetCDFTableView, MakeODCostMatrixLayer, MakeQueryTable, MakeRasterCatalogLayer, MakeRasterLayer, MakeRouteEventLayer, MakeRouteLayer, MakeServiceAreaLayer, MakeTableView, MakeTrackingLayer, MakeVehicleRoutingProblemLayer, MakeWCSLayer, MakeXYEventLayer, ManageGlobeServerCacheTiles, ManageMapServerCacheScales, ManageMapServerCacheTiles, MapServerCacheTilingSchemeToPolygons, MapToKML, MapToKML, MDPublisher, MeanCenter, MedianCenter, Merge, MergeBranch, MergeDividedRoads, MetadataImporter, MigrateStorage, MinimumBoundingGeometry, Minus, Minus, Mirror, MLClassify, Mod, Mosaic, MosaicToNewRaster, MultiDistanceSpatialClustering, MultiOutputMapAlgebra, MultipartToSinglepart, MultiPatchFootprint, MultipatchToCollada, MultipleRingBuffer, NaturalNeighbor, NaturalNeighbor, Near, Near, Near3D, Negate, Nibble, NotEqual, ObserverPoints, ObserverPoints, OrdinaryLeastSquares, Over, OverlayRouteEvents, PackageLayer, PackageMap, ParticleTrack, PathAllocation, PathBackLink, PathDistance, Pick, PivotTable, Plus, Plus, PointDensity, PointDistance, PointDistance, PointFileInformation, PointNode, PointsSolarRadiation, PointStatistics, PointsToLine, PointToRaster, PolygonFeatureClasstoCADLines, PolygonToLine, PolygonToRaster, PolygonVolume, PolylineToRaster, PolyRegion, Popularity, PopulateAlternateIDFields, PorousPuff, PostVersion, Power, PrincipalComponents, Project, Project, ProjectRaster, PropagateDisplacement, RadialBasisFunctions, Rank, RasterCatalogToRasterDataset, RasterCompare, RasterDomain, RasterTin, RasterToASCII, RasterToDTED, RasterToFloat, RasterToGeodatabase, RasterToMultipoint, RasterToNetCDF, RasterToOtherFormat, RasterToPoint, RasterToPolygon, RasterToPolyline, RasterToVideo, RebuildAddressLocator, ReclassByASCIIFile, ReclassByASCIIFile, ReclassByTable, ReclassByTable, Reclassify, Reclassify, ReconcileVersion, ReExportUnacknowledgedMessages, RegionClass, RegionGroup, RegionPoly, RegisterAsVersioned, RegisterWithGeodatabase, RematchAddresses, RemoveDomainFromField, RemoveFeatureClassFromTerrain, RemoveFeatureClassFromTopology, RemoveIndex, RemoveJoin, RemoveOverride, RemoveRastersFromMosaicDataset, RemoveRuleFromTopology, RemoveSpatialIndex, RemoveSubtype, RemoveTerrainPoints, RemoveTerrainPyramidLevel, Rename, Renode, RepairGeometry, RepairRasterCatalogPaths, ReplaceTerrainPoints, Resample, Rescale, Reselect, ResolveBuildingConflicts, ResolveRoadConflicts, ReverseGeocode, Rotate, RoundDown, RoundUp, S57Arc, Sample, SaveGraph, SaveToLayerFile, SDTSExport, SDTSImport, Select, SelectByDimension, SelectData, SelectFeatureByOverride, SelectLayerByAttribute, SelectLayerByLocation, SendEmailWithZipFileAttachment, SetCADAlias, SetClusterTolerance, SetDefaultSubtype, SetLayerRepresentation, SetNull, SetRepresentationControlPointAtIntersect, SetRepresentationControlPointByAngle, SetSubtypeField, SetValueForRangeDomain, SharePackage, Shift, Shrink, SimplifyBuilding, SimplifyBuilding, SimplifyBuilding, SimplifyLine, SimplifyLine, SimplifyLineOrPolygon, SimplifyPolygon, SimplifyPolygon, Sin, SingleOutputMapAlgebra, SinH, Sink, Skyline, SkylineBarrier, SkylineGraph, Slice, Slice, Slope, Slope, SmoothLine, SmoothLine, SmoothPolygon, SmoothPolygon, SnapPourPoint, SolarRadiationGraphics, Solve, Sort, SpatialAutocorrelation, SpatialJoin, Spline, Spline, SplineWithBarriers, SplineWithBarriers, Split, Split, SplitLine, SplitLineAtPoint, SplitRaster, Square, SquareRoot, StandardDistance, StandardizeAddresses, Statistics, StreamLink, StreamOrder, StreamToFeature, StripMapIndexFeatures, SubModelMemoryLayerWithAllJoins, SubsetFeatures, SurfaceAspect, SurfaceContour, SurfaceDifference, SurfaceLength, SurfaceSlope, SurfaceSpot, SurfaceVolume, SymDiff, SynchronizeChanges, SynchronizeMetadata, SynchronizeMosaicDataset, TableCompare, TableSelect, TableToDBASE, TableToDomain, TableToEllipse, TableToGeodatabase, TableToNetCDF, TableToRelationshipClass, TableToTable, TabulateArea, Tan, TanH, TerrainToPoints, TerrainToRaster, TerrainToTin, Test, Thiessen, Thin, ThinRoadNetwork, TigerArc, TigerTool, TiledLabelsToAnnotation, Times, Times, TinAspect, TINCompare, TinContour, TinDifference, TinDomain, TinEdge, TinLine, TinNode, TinPolygonTag, TinPolygonVolume, TinRaster, TinSlope, TinTriangle, Tolerance, TopoToRaster, TopoToRaster, TopoToRasterByFile, TopoToRasterByFile, Transform, TransformRouteEvents, TransposeFields, TransposeTimeFields, Trend, Trend, TurnTableToTurnFeatureClass, UncompressFileGeodatabaseData, Ungenerate, Union, Union, Union3D, UnregisterAsVersioned, UnsplitLine, Update, Update, UpdateAnalysisLayerAttributeParameter, UpdateAnnotation, UpdateByAlternateIDFields, UpdateByGeometry, UpdateDiagram, UpdateDiagrams, UpdateGlobeServerCache, UpdateMapServerCache, UpdateOverride, UpgradeGDB, UpgradeMetadata, UpgradeNetwork, UpgradeSpatialReference, USGSMPTranslator, ValidateMetadata, ValidateMetadataMultiple, ValidateTopology, Viewshed, Viewshed, VPFExport, VPFImport, VPFTile, Warp, Watershed, WeightedOverlay, WeightedSum, WFSToFeatureClass, WorkspaceToGeodatabase, WorkspaceToMosaic, WorkspaceToNewMosaic, WorkspaceToNewRasterCatalog, WorkspaceToRasterCatalog, WorkspaceToRasterDataset, WriteFeaturesToTextFile, XMLSchemaValidator, XSLTransform, XYToLine, ZonalFill, ZonalGeometry, ZonalGeometryAsTable, ZonalHistogram, ZonalStatistics, ZonalStatisticsAsTable, ZRenderer

public interface GPTool

The Java GP tool.

The user creates a GPTool, sets its parameters and then calls execute() on the GeoProcessor to execute the tool. After execution, the user can use the getMessages() method to lookup messages resulting from the execution.

Method Summary

Object[]	getParameterValues() Returns the parameters of this tool as an array of Objects.
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.

Method Detail

getToolName

String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias

getParameterValues

Object[] getParameterValues()

Returns the parameters of this tool as an array of Objects.

This method is for internal consumption only by the GeoProcessor.

Returns:

the parameters of this tool as an array of Objects.