com.esri.arcgis.geoprocessing.tools.cartographytools
Class MapServerCacheTilingSchemeToPolygons

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.cartographytools.MapServerCacheTilingSchemeToPolygons

All Implemented Interfaces:

GPTool

public class MapServerCacheTilingSchemeToPolygons
extends AbstractGPTool

Creates a new polygon feature class from an existing tiling scheme. The Map Server Cache Tiling Scheme To Polygons tool is contained in the Cartography Tools tool box.

Usage tips:

• There are several options for loading an existing tiling scheme:
  • Load a tiling scheme from an online mapping service such as ArcGIS Online, Google Maps, Bing Maps, or Yahoo. These tiling schemes are located in the installation directory of ArcGIS Desktop (example: C:\Program Files\ArcGIS\Desktop10.0\TilingSchemes).
  • Load a tiling scheme file from an existing map service cache. All map caches have a tiling scheme file, conf.xml, in the cache directory (example: C:\arcgisserver\arcgiscache\MyService\MyDataFrame\conf.xml).
  • Create your own tiling scheme file. For more information see in the ArcGIS Server Help.
• The output feature class from this tool may be used as input into the tool.
• For the Clip tiles at the coordinate system horizon parameter, the coordinate system horizon is the valid area of use for a particular geographic or projected coordinate system.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

MapServerCacheTilingSchemeToPolygons()
Creates the Map Server Cache Tiling Scheme To Polygons tool with defaults.

MapServerCacheTilingSchemeToPolygons(Object mapDocument, String dataFrame, Object tilingScheme, Object outputFeatureClass, String useMapExtent, String clipToHorizon)
Creates the Map Server Cache Tiling Scheme To Polygons tool with the required parameters.

Method Summary

String	getAntialiasing() Returns the Generate polygons that match map service caches with anti-aliasing enabled parameter of this tool .
String	getClipToHorizon() Returns the Clip tiles at the coordinate system horizon parameter of this tool .
String	getDataFrame() Returns the Data Frame parameter of this tool .
Object	getLevels() Returns the Scales parameter of this tool .
Object	getMapDocument() Returns the Map Document parameter of this tool .
Object	getOutputFeatureClass() Returns the Output Feature Class parameter of this tool .
Object	getTilingScheme() Returns the Tiling Scheme 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	getUseMapExtent() Returns the Generate polygons that intersect the map extent parameter of this tool .
void	setAntialiasing(String antialiasing) Sets the Generate polygons that match map service caches with anti-aliasing enabled parameter of this tool .
void	setClipToHorizon(String clipToHorizon) Sets the Clip tiles at the coordinate system horizon parameter of this tool .
void	setDataFrame(String dataFrame) Sets the Data Frame parameter of this tool .
void	setLevels(Object levels) Sets the Scales parameter of this tool .
void	setMapDocument(Object mapDocument) Sets the Map Document parameter of this tool .
void	setOutputFeatureClass(Object outputFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setTilingScheme(Object tilingScheme) Sets the Tiling Scheme parameter of this tool .
void	setUseMapExtent(String useMapExtent) Sets the Generate polygons that intersect the map extent 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

MapServerCacheTilingSchemeToPolygons

public MapServerCacheTilingSchemeToPolygons()

Creates the Map Server Cache Tiling Scheme To Polygons tool with defaults.

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

MapServerCacheTilingSchemeToPolygons

public MapServerCacheTilingSchemeToPolygons(Object mapDocument,
                                            String dataFrame,
                                            Object tilingScheme,
                                            Object outputFeatureClass,
                                            String useMapExtent,
                                            String clipToHorizon)

Creates the Map Server Cache Tiling Scheme To Polygons 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:

mapDocument - the source map document.

dataFrame - the data frame from the source map document.

tilingScheme - path to a predefined tiling scheme .xml file.

outputFeatureClass - the output polygon feature class.

useMapExtent - choose whether to produce tiles for the entire extent of the tiling scheme or only tiles that intersect the full extent of the data frame.

clipToHorizon - choose whether to constrain the polygons to the valid area of use for the geographic or projected coordinate system of the data frame.

Method Detail

getMapDocument

public Object getMapDocument()

Returns the Map Document parameter of this tool . This parameter is the source map document. This is a required parameter.

Returns:

the Map Document

setMapDocument

public void setMapDocument(Object mapDocument)

Sets the Map Document parameter of this tool . This parameter is the source map document. This is a required parameter.

Parameters:

mapDocument - the source map document.

getDataFrame

public String getDataFrame()

Returns the Data Frame parameter of this tool . This parameter is the data frame from the source map document. This is a required parameter.

Returns:

the Data Frame

setDataFrame

public void setDataFrame(String dataFrame)

Sets the Data Frame parameter of this tool . This parameter is the data frame from the source map document. This is a required parameter.

Parameters:

dataFrame - the data frame from the source map document.

getTilingScheme

public Object getTilingScheme()

Returns the Tiling Scheme parameter of this tool . This parameter is path to a predefined tiling scheme .xml file. This is a required parameter.

Returns:

the Tiling Scheme

setTilingScheme

public void setTilingScheme(Object tilingScheme)

Sets the Tiling Scheme parameter of this tool . This parameter is path to a predefined tiling scheme .xml file. This is a required parameter.

Parameters:

tilingScheme - path to a predefined tiling scheme .xml file.

getOutputFeatureClass

public Object getOutputFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the output polygon 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 the output polygon feature class. This is a required parameter.

Parameters:

outputFeatureClass - the output polygon feature class.

getUseMapExtent

public String getUseMapExtent()

Returns the Generate polygons that intersect the map extent parameter of this tool . This parameter is choose whether to produce tiles for the entire extent of the tiling scheme or only tiles that intersect the full extent of the data frame. This is a required parameter.

Returns:

the Generate polygons that intersect the map extent

setUseMapExtent

public void setUseMapExtent(String useMapExtent)

Sets the Generate polygons that intersect the map extent parameter of this tool . This parameter is choose whether to produce tiles for the entire extent of the tiling scheme or only tiles that intersect the full extent of the data frame. This is a required parameter.

Parameters:

useMapExtent - choose whether to produce tiles for the entire extent of the tiling scheme or only tiles that intersect the full extent of the data frame.

getClipToHorizon

public String getClipToHorizon()

Returns the Clip tiles at the coordinate system horizon parameter of this tool . This parameter is choose whether to constrain the polygons to the valid area of use for the geographic or projected coordinate system of the data frame. This is a required parameter.

Returns:

the Clip tiles at the coordinate system horizon

setClipToHorizon

public void setClipToHorizon(String clipToHorizon)

Sets the Clip tiles at the coordinate system horizon parameter of this tool . This parameter is choose whether to constrain the polygons to the valid area of use for the geographic or projected coordinate system of the data frame. This is a required parameter.

Parameters:

clipToHorizon - choose whether to constrain the polygons to the valid area of use for the geographic or projected coordinate system of the data frame.

getAntialiasing

public String getAntialiasing()

Returns the Generate polygons that match map service caches with anti-aliasing enabled parameter of this tool . This is an optional parameter.

Returns:

the Generate polygons that match map service caches with anti-aliasing enabled

setAntialiasing

public void setAntialiasing(String antialiasing)

Sets the Generate polygons that match map service caches with anti-aliasing enabled parameter of this tool . This is an optional parameter.

Parameters:

antialiasing - null

getLevels

public Object getLevels()

Returns the Scales parameter of this tool . This parameter is the scale levels at which you will create polygons. To create polygons for all scale levels included in a tiling scheme, leave this parameter blank. To specify only certain scales list them separated by a semicolon (;). This is an optional parameter.

Returns:

the Scales

setLevels

public void setLevels(Object levels)

Sets the Scales parameter of this tool . This parameter is the scale levels at which you will create polygons. To create polygons for all scale levels included in a tiling scheme, leave this parameter blank. To specify only certain scales list them separated by a semicolon (;). This is an optional parameter.

Parameters:

levels - the scale levels at which you will create polygons. To create polygons for all scale levels included in a tiling scheme, leave this parameter blank. To specify only certain scales list them separated by a semicolon (;).

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