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

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

public class ExtractDataAndEmailTask
extends AbstractGPTool

Extracts the data in the specified layers and area of interest to the selected format and spatial reference, zips the data and emails it to the specified address. This tool can be used to create a Data Extraction geoprocessing service. The Extract Data and Email Task 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
ExtractDataAndEmailTask()
          Creates the Extract Data and Email Task tool with defaults.
ExtractDataAndEmailTask(Object layersToClip, Object areaOfInterest, String featureFormat, String rasterFormat, String to)
          Creates the Extract Data and Email Task tool with the required parameters.
 
Method Summary
 Object getAreaOfInterest()
          Returns the Area of Interest 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 .
 String getRasterFormat()
          Returns the Raster Format parameter of this tool .
 String getSent()
          Returns the Sent parameter of this tool (Read only).
 String getTo()
          Returns the To 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 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 setRasterFormat(String rasterFormat)
          Sets the Raster Format parameter of this tool .
 void setTo(String to)
          Sets the To 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

ExtractDataAndEmailTask

public ExtractDataAndEmailTask()
Creates the Extract Data and Email Task tool with defaults.

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


ExtractDataAndEmailTask

public ExtractDataAndEmailTask(Object layersToClip,
                               Object areaOfInterest,
                               String featureFormat,
                               String rasterFormat,
                               String to)
Creates the Extract Data and Email Task 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 data sets 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
to - the email address of the recipient. this tool will be able to email to this address if and only if the SMTP server has been configured within this model.
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 data sets 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 data sets 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 data sets 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

getTo

public String getTo()
Returns the To parameter of this tool . This parameter is the email address of the recipient. this tool will be able to email to this address if and only if the SMTP server has been configured within this model. This is a required parameter.

Returns:
the To

setTo

public void setTo(String to)
Sets the To parameter of this tool . This parameter is the email address of the recipient. this tool will be able to email to this address if and only if the SMTP server has been configured within this model. This is a required parameter.

Parameters:
to - the email address of the recipient. this tool will be able to email to this address if and only if the SMTP server has been configured within this model.

getSent

public String getSent()
Returns the Sent parameter of this tool (Read only). This is an derived parameter.

Returns:
the Sent

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