Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.geoprocessing.tools.servertools
Class ExtractData

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.servertools.ExtractData
All Implemented Interfaces:
GPTool
public class ExtractData
extends AbstractGPTool

Extracts selected layers in the specified area of interest to a specific format and spatial reference. The extracted data is then written to a zip file. The Extract Data tool is contained in the Server Tools tool box.

Usage tips:

Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
ExtractData()
          Creates the Extract Data tool with defaults.
ExtractData(Object layersToClip, Object areaOfInterest, String featureFormat, String rasterFormat, String spatialReference, Object outputZipFile)
          Creates the Extract Data tool with the required parameters.
 
Method Summary
 Object getAreaOfInterest()
          Returns the Area of Interest parameter of this tool .
 Object getCustomSpatialReferenceFolder()
          Returns the Custom Spatial Reference Folder parameter of this tool .
 String getFeatureFormat()
          Returns the Feature Format parameter of this tool .
 Object getLayersToClip()
          Returns the Layers to Clip parameter of this tool .
 Object getOutputZipFile()
          Returns the Output Zip File parameter of this tool .
 String getRasterFormat()
          Returns the Raster Format parameter of this tool .
 String getSpatialReference()
          Returns the Spatial Reference 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.
 void setAreaOfInterest(Object areaOfInterest)
          Sets the Area of Interest parameter of this tool .
 void setCustomSpatialReferenceFolder(Object customSpatialReferenceFolder)
          Sets the Custom Spatial Reference Folder parameter of this tool .
 void setFeatureFormat(String featureFormat)
          Sets the Feature Format parameter of this tool .
 void setLayersToClip(Object layersToClip)
          Sets the Layers to Clip parameter of this tool .
 void setOutputZipFile(Object outputZipFile)
          Sets the Output Zip File parameter of this tool .
 void setRasterFormat(String rasterFormat)
          Sets the Raster Format parameter of this tool .
 void setSpatialReference(String spatialReference)
          Sets the Spatial Reference 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

ExtractData

public ExtractData()
Creates the Extract Data tool with defaults.

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

ExtractData

public ExtractData(Object layersToClip,
                   Object areaOfInterest,
                   String featureFormat,
                   String rasterFormat,
                   String spatialReference,
                   Object outputZipFile)
Creates the Extract Data 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:
layersToClip - the Layers to be clipped. Layers should be either feature or raster layers.
areaOfInterest - the area by which the layers will be clipped.
featureFormat - the format in which the output features will be delivered. the string provided in the Feature Format parameter should be formatted as follows: for example: internally, this tool uses the Export to CAD tool to convert data to the .dgn, .dwg, and .dxf CAD formats. The list of short names supported includes: DGN_V8, DWG_R14, DWG_R2000, DWG_R2004, DWG_R2005, DWG_R2006, DWG_R2007, DWG_R2010, DXF_R14, DXF_R2000, DXF_R2004, DXF_R2005, DXF_R2006, DXF_R2007, and DXF_R2010. for all non-ESRI, non-CAD formats, this tool also supports formats used by the Quick Export tool. since the Quick Export tool is a part of the Data Interoperability Extension, non-ESRI, non-CAD formats will only work if the Data Interoperability Extension is available.
  • File Geodatabase - GDB - .gdb
  • Shapefile - SHP - .shp
  • Personal Geodatabase - MDB - .mdb
  • Geographic Markup Language - GML - .gml
  • OpenGIS KML Encoding Standard - OGCKML - .kmz
  • Autodesk AutoCAD - DXF_R2007 - .dxf
  • Autodesk AutoCAD - DWG_R2007 - .dwg
  • Bentley Microstation Design (V8) - DGN_V8 - .dgn
rasterFormat - the format in which the output raster datasets will be delivered. the string provided in the Raster Format parameter should be formatted as follows: any of the following strings will work:
  • ESRI GRID - GRID
  • File Geodatabase - GDB - .gdb
  • ERDAS IMAGINE - IMG - .img
  • Tagged Image File Format - TIFF - .tif
  • Portable Network Graphics - PNG - .png
  • Graphic Interchange Format - GIF - .gif
  • Joint Photographics Experts Group - JPEG - .jpg
  • Joint Photographics Experts Group - JPEG - .jp2
  • Bitmap - BMP - .bmp
  • Portable Network Graphics - PNG - .png
spatialReference - the spatial reference of the output data delivered by the tool. for standard ESRI spatial references, the name you provide here should be the name of the desired coordinate system. This name corresponds to the name of the spatial reference's projection file. Alternatively, you can use the Well Known ID (WKID) of the coordinate system. for example: for any custom projection, the name specified should be the name of the custom projection file (without extension). The location of the custom projection file(s) should be specified in the Custom Spatial Reference Folder parameter.
  • Sinusoidal (world)
  • WGS 1984 Web Mercator
  • NAD 1983 HARN StatePlane Oregon North FIPS 3601
  • WGS 1984 UTM Zone 11N
  • 102003
  • 54001
  • If you want the output to have the same coordinate system as the input, then use the string "Same As Input".
outputZipFile - the output Zip File that will contain the extracted data.
Method Detail

getLayersToClip

public Object getLayersToClip()
Returns the Layers to Clip parameter of this tool . This parameter is the Layers to be clipped. Layers should be either feature or raster layers. This is a required parameter.

Returns:
the Layers to Clip

setLayersToClip

public void setLayersToClip(Object layersToClip)
Sets the Layers to Clip parameter of this tool . This parameter is the Layers to be clipped. Layers should be either feature or raster layers. This is a required parameter.

Parameters:
layersToClip - the Layers to be clipped. Layers should be either feature or raster layers.

getAreaOfInterest

public Object getAreaOfInterest()
Returns the Area of Interest parameter of this tool . This parameter is the area by which the layers will be clipped. This is a required parameter.

Returns:
the Area of Interest

setAreaOfInterest

public void setAreaOfInterest(Object areaOfInterest)
Sets the Area of Interest parameter of this tool . This parameter is the area by which the layers will be clipped. This is a required parameter.

Parameters:
areaOfInterest - the area by which the layers will be clipped.

getFeatureFormat

public String getFeatureFormat()
Returns the Feature Format parameter of this tool . This parameter is the format in which the output features will be delivered. the string provided in the Feature Format parameter should be formatted as follows: for example: internally, this tool uses the Export to CAD tool to convert data to the .dgn, .dwg, and .dxf CAD formats. The list of short names supported includes: DGN_V8, DWG_R14, DWG_R2000, DWG_R2004, DWG_R2005, DWG_R2006, DWG_R2007, DWG_R2010, DXF_R14, DXF_R2000, DXF_R2004, DXF_R2005, DXF_R2006, DXF_R2007, and DXF_R2010. for all non-ESRI, non-CAD formats, this tool also supports formats used by the Quick Export tool. since the Quick Export tool is a part of the Data Interoperability Extension, non-ESRI, non-CAD formats will only work if the Data Interoperability Extension is available. This is a required parameter.

Returns:
the Feature Format

setFeatureFormat

public void setFeatureFormat(String featureFormat)
Sets the Feature Format parameter of this tool . This parameter is the format in which the output features will be delivered. the string provided in the Feature Format parameter should be formatted as follows: for example: internally, this tool uses the Export to CAD tool to convert data to the .dgn, .dwg, and .dxf CAD formats. The list of short names supported includes: DGN_V8, DWG_R14, DWG_R2000, DWG_R2004, DWG_R2005, DWG_R2006, DWG_R2007, DWG_R2010, DXF_R14, DXF_R2000, DXF_R2004, DXF_R2005, DXF_R2006, DXF_R2007, and DXF_R2010. for all non-ESRI, non-CAD formats, this tool also supports formats used by the Quick Export tool. since the Quick Export tool is a part of the Data Interoperability Extension, non-ESRI, non-CAD formats will only work if the Data Interoperability Extension is available. This is a required parameter.

Parameters:
featureFormat - the format in which the output features will be delivered. the string provided in the Feature Format parameter should be formatted as follows: for example: internally, this tool uses the Export to CAD tool to convert data to the .dgn, .dwg, and .dxf CAD formats. The list of short names supported includes: DGN_V8, DWG_R14, DWG_R2000, DWG_R2004, DWG_R2005, DWG_R2006, DWG_R2007, DWG_R2010, DXF_R14, DXF_R2000, DXF_R2004, DXF_R2005, DXF_R2006, DXF_R2007, and DXF_R2010. for all non-ESRI, non-CAD formats, this tool also supports formats used by the Quick Export tool. since the Quick Export tool is a part of the Data Interoperability Extension, non-ESRI, non-CAD formats will only work if the Data Interoperability Extension is available.
  • File Geodatabase - GDB - .gdb
  • Shapefile - SHP - .shp
  • Personal Geodatabase - MDB - .mdb
  • Geographic Markup Language - GML - .gml
  • OpenGIS KML Encoding Standard - OGCKML - .kmz
  • Autodesk AutoCAD - DXF_R2007 - .dxf
  • Autodesk AutoCAD - DWG_R2007 - .dwg
  • Bentley Microstation Design (V8) - DGN_V8 - .dgn

getRasterFormat

public String getRasterFormat()
Returns the Raster Format parameter of this tool . This parameter is the format in which the output raster datasets will be delivered. the string provided in the Raster Format parameter should be formatted as follows: any of the following strings will work: This is a required parameter.

Returns:
the Raster Format

setRasterFormat

public void setRasterFormat(String rasterFormat)
Sets the Raster Format parameter of this tool . This parameter is the format in which the output raster datasets will be delivered. the string provided in the Raster Format parameter should be formatted as follows: any of the following strings will work: This is a required parameter.

Parameters:
rasterFormat - the format in which the output raster datasets will be delivered. the string provided in the Raster Format parameter should be formatted as follows: any of the following strings will work:
  • ESRI GRID - GRID
  • File Geodatabase - GDB - .gdb
  • ERDAS IMAGINE - IMG - .img
  • Tagged Image File Format - TIFF - .tif
  • Portable Network Graphics - PNG - .png
  • Graphic Interchange Format - GIF - .gif
  • Joint Photographics Experts Group - JPEG - .jpg
  • Joint Photographics Experts Group - JPEG - .jp2
  • Bitmap - BMP - .bmp
  • Portable Network Graphics - PNG - .png

getSpatialReference

public String getSpatialReference()
Returns the Spatial Reference parameter of this tool . This parameter is the spatial reference of the output data delivered by the tool. for standard ESRI spatial references, the name you provide here should be the name of the desired coordinate system. This name corresponds to the name of the spatial reference's projection file. Alternatively, you can use the Well Known ID (WKID) of the coordinate system. for example: for any custom projection, the name specified should be the name of the custom projection file (without extension). The location of the custom projection file(s) should be specified in the Custom Spatial Reference Folder parameter. This is a required parameter.

Returns:
the Spatial Reference

setSpatialReference

public void setSpatialReference(String spatialReference)
Sets the Spatial Reference parameter of this tool . This parameter is the spatial reference of the output data delivered by the tool. for standard ESRI spatial references, the name you provide here should be the name of the desired coordinate system. This name corresponds to the name of the spatial reference's projection file. Alternatively, you can use the Well Known ID (WKID) of the coordinate system. for example: for any custom projection, the name specified should be the name of the custom projection file (without extension). The location of the custom projection file(s) should be specified in the Custom Spatial Reference Folder parameter. This is a required parameter.

Parameters:
spatialReference - the spatial reference of the output data delivered by the tool. for standard ESRI spatial references, the name you provide here should be the name of the desired coordinate system. This name corresponds to the name of the spatial reference's projection file. Alternatively, you can use the Well Known ID (WKID) of the coordinate system. for example: for any custom projection, the name specified should be the name of the custom projection file (without extension). The location of the custom projection file(s) should be specified in the Custom Spatial Reference Folder parameter.
  • Sinusoidal (world)
  • WGS 1984 Web Mercator
  • NAD 1983 HARN StatePlane Oregon North FIPS 3601
  • WGS 1984 UTM Zone 11N
  • 102003
  • 54001
  • If you want the output to have the same coordinate system as the input, then use the string "Same As Input".

getCustomSpatialReferenceFolder

public Object getCustomSpatialReferenceFolder()
Returns the Custom Spatial Reference Folder parameter of this tool . This parameter is the location of any custom projection file or files referenced in the Spatial Reference parameter. This is only necessary if the custom projection file is not in the default install Coordinate System folder. This is an optional parameter.

Returns:
the Custom Spatial Reference Folder

setCustomSpatialReferenceFolder

public void setCustomSpatialReferenceFolder(Object customSpatialReferenceFolder)
Sets the Custom Spatial Reference Folder parameter of this tool . This parameter is the location of any custom projection file or files referenced in the Spatial Reference parameter. This is only necessary if the custom projection file is not in the default install Coordinate System folder. This is an optional parameter.

Parameters:
customSpatialReferenceFolder - the location of any custom projection file or files referenced in the Spatial Reference parameter. This is only necessary if the custom projection file is not in the default install Coordinate System folder.

getOutputZipFile

public Object getOutputZipFile()
Returns the Output Zip File parameter of this tool . This parameter is the output Zip File that will contain the extracted data. This is a required parameter.

Returns:
the Output Zip File

setOutputZipFile

public void setOutputZipFile(Object outputZipFile)
Sets the Output Zip File parameter of this tool . This parameter is the output Zip File that will contain the extracted data. This is a required parameter.

Parameters:
outputZipFile - the output Zip File that will contain the extracted data.

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
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD