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, AddRepresentation, AddRuleToTopology, AddSpatialIndex, AddSubtype, AddTerrainPoints, AddTerrainPyramidLevel, AddXY, AddXY, Adjust3DZ, Aggregate, AggregatePolygons, AggregatePolygons, AlignMarkerToStrokeOrFill, AlterVersion, Analyze, Append, Append, AppendAnnotation, ApplySymbologyFromLayer, ArcDLG, ArcRoute, ArcS57, AreaSolarRadiation, Ascii3DToFeatureClass, ASCIIToRaster, ASin, ASinH, Aspect, Aspect, AssignDefaultToField, AssignDomainToField, ATan, ATan2, ATanH, AverageNearestNeighbor, BandCollectionStats, Basin, BatchBuildPyramids, BatchCalculateStatistics, BatchDefine, BatchProject, BitwiseAnd, BitwiseLeftShift, BitwiseNot, BitwiseOr, BitwiseRightShift, BitwiseXOr, BlockStatistics, BooleanAnd, BooleanNot, BooleanOr, BooleanXOr, BoundaryClean, Buffer, Buffer, Build, BuildNetwork, BuildPyramids, BuildRasterAttributeTable, BuildTerrain, CADLinestoPolygonFeatures, CADtoFeatureClass, CADtoFeatureClasswithAttributeofNearestPoint, CalculateAreas, CalculateDefaultClusterTolerance, CalculateDefaultGridIndex, CalculateDistanceBand, CalculateEndDate, CalculateField, CalculateGeodesicAngle, CalculateLineCaps, CalculateLocations, CalculatePolygonMainAngle, CalculateRepresentationRule, CalculateStatistics, CalculateValue, CalibrateRoutes, CellStatistics, CentralFeature, ChangePrivileges, ChangeTerrainReferenceScale, CheckGeometry, Checkin, CheckinDelta, Checkout, ClassProbability, Clean, ClearWorkspaceCache, Clip, Clip, Clip, ClustersOutliers, ClustersOutliersRendered, CollapseDualLinesToCenterline, CollapseDualLinesToCenterline, CollectEvents, CollectEventsRendered, CombinatorialAnd, CombinatorialOr, CombinatorialXOr, Combine, Compact, CompareReplicaSchema, CompositeBands, Compress, CompressFileGeodatabaseData, ConcatenateDateAndTimeFields, ConTool, Contour, Contour, ContourList, ContourList, ContourWithBarriers, ContourWithBarriers, ConvertDiagram, ConvertSpatialWeightsMatrixtoTable, Copy, CopyFeatures, CopyRaster, CopyRasterCatalogItems, CopyRows, Corridor, Cos, CosH, CostAllocation, CostBackLink, CostDistance, CostPath, CountRenderer, Create, CreateAddressLocator, CreateArcInfoWorkspace, CreateCADXData, CreateConstantRaster, CreateCustomGeoTransformation, CreateDiagram, CreateDomain, CreateFeatureclass, CreateFeatureClasswithAllJoinsfromStagingGeodatabase, CreateFeatureDataset, CreateFeaturesFromTextFile, CreateFileGDB, CreateFishnet, CreateFolder, CreateLabels, CreateMapServerCache, CreateNormalRaster, CreateOrthoCorrectedRasterDataset, CreateOverpass, CreatePansharpenedRasterDataset, CreatePersonalGDB, CreateRandomPoints, CreateRandomRaster, CreateRandomRaster, CreateRasterCatalog, CreateRasterDataset, CreateRelationshipClass, CreateReplica, CreateReplicaFootPrints, CreateReplicaFromServer, CreateRoutes, CreateSchematicFolder, CreateSignatures, CreateSpatialReference, CreateTable, CreateTerrain, CreateThiessenPolygons, CreateTin, CreateTopology, CreateTurnFeatureClass, CreateUnderpass, CreateVersion, CulDeSacMasks, Curvature, Curvature, CutFill, CutFill, DarcyFlow, DarcyVelocity, DecimateTinNodes, DefineProjection, DefineProjection, Delete, DeleteCodedValueFromDomain, DeleteColormap, DeleteDomain, DeleteFeatures, DeleteField, DeleteGlobeServerCache, DeleteMapServerCache, DeleteRasterAttributeTable, DeleteRasterCatalogItems, DeleteRows, DeleteVersion, DelineateTinDataArea, DEMToRaster, Dendrogram, DetectGraphicConflict, Diff, DirectionalDistribution, DirectionalMean, Directions, DisperseMarkers, Dissolve, Dissolve, DissolveRouteEvents, Divide, Divide, DLGArc, DomainToTable, DropIndex, DropItem, DropRepresentation, EditSignatures, EditTin, Eliminate, Eliminate, EqualTo, EqualToFrequency, Erase, Erase, ESRITranslator, EucAllocation, EucDirection, EucDistance, Exp, Exp10, Exp2, Expand, Export, ExportAcknowledgementMessage, ExportCAD, ExportDataChangeMessage, ExportRasterCatalogPaths, ExportRasterWorldFile, ExportReplicaSchema, ExporttoDelta, ExportXYv, ExtractByAttributes, ExtractByCircle, ExtractByMask, ExtractByPoints, ExtractByPolygon, ExtractByRectangle, ExtractSubDataset, ExtractValuesToPoints, ExtrudeBetween, FeatureclassToCoverage, FeatureClassToFeatureClass, FeatureClassToGeodatabase, FeatureClassToShapefile, FeatureClassZToASCII, FeatureCompare, FeatureEnvelopeToPolygon, FeatureOutlineMasks, FeatureToLine, FeatureToNetCDF, FeatureToPoint, FeatureToPolygon, FeatureToRaster, FeatureVerticesToPoints, FileCompare, Fill, Filter, FindConflicts, Flip, Float, Float, FloatToRaster, FlowAccumulation, FlowDirection, FlowLength, FocalFlow, FocalStatistics, Frequency, GACalculateZValue, GACreateGeostatisticalLayer, GAGetModelParameter, GALayerToContour, GALayerToGrid, GALayerToPoints, GAMovingWindowKriging, GANeighborhoodSelection, GASemivariogramSensitivity, GASetModelParameter, GaussianGeostatisticalSimulations, Generate, GenerateGlobeServerCache, GenerateMapServerCache, GenerateMapServerCacheTilingScheme, GenerateNearTable, GenerateNetworkSpatialWeights, GenerateSpatialWeightsMatrix, GenericGPTool, GeocodeAddresses, GeographicallyWeightedRegression, GetCellValue, GetCount, GetRasterProperties, GreaterThan, GreaterThanEqual, GreaterThanFrequency, HighestPosition, HighLowClustering, HillShade, HillShade, HotSpots, HotSpotsRendered, IDEdit, Identity, Identity, Idw, Idw, Import, Import3DFiles, ImportCAD, ImportCADAnnotation, ImportCoverageAnnotation, ImportMessage, ImportReplicaSchema, IncreaseMaximumEdges, IndexItem, InList, Int, Int, Integrate, InterpolatePolyToPatch, InterpolateShape, Intersect, Intersect, IntersectingLayersMasks, IsNull, IsoCluster, JoinField, JoinItem, KernelDensity, Kriging, Kriging, LASToMultipoint, Layer3DToFeatureClass, LayerToKML, LayerToKML, LessThan, LessThanEqual, LessThanFrequency, LineDensity, LineOfSight, LineStatistics, Ln, LocateFeaturesAlongRoutes, Log10, Log2, Lookup, Lookup, LowestPosition, MajorityFilter, MakeClosestFacilityLayer, MakeFeatureLayer, MakeImageServerLayer, MakeNetCDFFeatureLayer, MakeNetCDFRasterLayer, MakeNetCDFTableView, MakeODCostMatrixLayer, MakeQueryTable, MakeRasterCatalogLayer, MakeRasterLayer, MakeRouteEventLayer, MakeRouteLayer, MakeServiceAreaLayer, MakeTableView, MakeTrackingLayer, MakeVehicleRoutingProblemLayer, MakeWCSLayer, MakeXYEventLayer, ManageGlobeServerCacheTiles, ManageMapServerCacheScales, ManageMapServerCacheTiles, MapToKML, MapToKML, MDPublisher, MeanCenter, Merge, MergeBranch, MetadataImporter, MigrateStorage, Minus, Minus, Mirror, MLClassify, Mod, Mosaic, MosaicToNewRaster, MultiDistanceSpatialClustering, MultiOutputMapAlgebra, MultipartToSinglepart, MultiPatchFootprint, MultipleRingBuffer, NaturalNeighbor, NaturalNeighbor, Near, Near, Negate, Nibble, NotEqual, ObserverPoints, ObserverPoints, OrdinaryLeastSquares, Over, OverlayRouteEvents, ParticleTrack, PathAllocation, PathBackLink, PathDistance, Pick, PivotTable, Plus, Plus, PointDensity, PointDistance, PointDistance, PointFileInformation, PointNode, PointsSolarRadiation, PointStatistics, PointToRaster, PolygonFeatureClasstoCADLines, PolygonToLine, PolygonToRaster, PolylineToRaster, PolyRegion, Popularity, PopulateAlternateIDFields, PorousPuff, PostVersion, Power, PrincipalComponents, Project, Project, ProjectRaster, QuickExport, QuickImport, Rank, RasterCatalogToRasterDataset, RasterCompare, RasterDomain, RasterTin, RasterToASCII, RasterToFloat, RasterToGeodatabase, RasterToNetCDF, RasterToOtherFormat, RasterToPoint, RasterToPolygon, RasterToPolyline, RebuildAddressLocator, ReclassByASCIIFile, ReclassByASCIIFile, ReclassByTable, ReclassByTable, Reclassify, Reclassify, ReconcileVersion, ReExportUnacknowledgedMessages, RegionClass, RegionGroup, RegionPoly, RegisterAsVersioned, RematchAddresses, RemoveDomainFromField, RemoveFeatureClassFromTerrain, RemoveFeatureClassFromTopology, RemoveIndex, RemoveJoin, RemoveOverride, RemoveRuleFromTopology, RemoveSpatialIndex, RemoveSubtype, RemoveTerrainPoints, RemoveTerrainPyramidLevel, Rename, Renode, RepairGeometry, RepairRasterCatalogPaths, Resample, Rescale, Reselect, Rotate, RoundDown, RoundUp, S57Arc, Sample, SaveToLayerFile, SDTSExport, SDTSImport, Select, SelectByDimension, SelectData, SelectFeatureByOverride, SelectLayerByAttribute, SelectLayerByLocation, SetCADAlias, SetClusterTolerance, SetDefaultSubtype, SetLayerRepresentation, SetNull, SetRepresentationControlPointAtIntersect, SetRepresentationControlPointByAngle, SetSubtypeField, SetValueForRangeDomain, Shift, Shrink, SimplifyBuilding, SimplifyBuilding, SimplifyLine, SimplifyLineOrPolygon, SimplifyPolygon, Sin, SingleOutputMapAlgebra, SinH, Sink, Slice, Slice, Slope, Slope, SmoothLine, SmoothPolygon, SnapPourPoint, SolarRadiationGraphics, Solve, SpatialAutocorrelation, SpatialJoin, Spline, Spline, SplineWithBarriers, SplineWithBarriers, Split, Split, SplitLine, Square, SquareRoot, StandardDistance, StandardizeAddresses, Statistics, StreamLink, StreamOrder, StreamToFeature, SubModelMemoryLayerWithAllJoins, SurfaceLength, SurfaceSpot, SurfaceVolume, SymDiff, SynchronizeChanges, TableCompare, TableSelect, TableToDBASE, TableToDomain, TableToGeodatabase, TableToNetCDF, TableToRelationshipClass, TableToTable, TabulateArea, Tan, TanH, TerrainToRaster, TerrainToTin, Test, Thiessen, Thin, TigerArc, TigerTool, Times, Times, TinAspect, TINCompare, TinContour, TinDifference, TinDomain, TinEdge, TinLine, TinNode, TinPolygonTag, TinPolygonVolume, TinRaster, TinSlope, TinTriangle, Tolerance, TopoToRaster, TopoToRaster, TopoToRasterByFile, TopoToRasterByFile, Transform, TransformRouteEvents, TransposeTimeFields, Trend, Trend, TurnTableToTurnFeatureClass, UncompressFileGeodatabaseData, Ungenerate, Union, Union, UnregisterAsVersioned, Update, Update, UpdateAnalysisLayerAttributeParameter, UpdateAnnotation, UpdateByAlternateIDFields, UpdateByGeometry, UpdateDiagram, UpdateDiagrams, UpdateGlobeServerCache, UpdateMapServerCache, UpdateMapServerCacheScales, UpdateOverride, UpgradeSpatialReference, USGSMPTranslator, ValidateTopology, Viewshed, Viewshed, VPFExport, VPFImport, VPFTile, Warp, Watershed, WeightedOverlay, WeightedSum, WFSToFeatureClass, WorkspaceToGeodatabase, WorkspaceToMosaic, WorkspaceToNewMosaic, WorkspaceToNewRasterCatalog, WorkspaceToRasterCatalog, WorkspaceToRasterDataset, WriteFeaturesToTextFile, XSLTransform, ZonalFill, ZonalGeometry, ZonalGeometryAsTable, 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.