|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.esri.arcgis.geoprocessing.AbstractGPTool
com.esri.arcgis.geoprocessing.tools.datamanagementtools.BuildOverviews
public class BuildOverviews
Defines and generates overviews for a mosaic dataset. The Build Overviews tool is contained in the Data Management Tools tool box.
Field Summary |
---|
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool |
---|
vals |
Constructor Summary | |
---|---|
BuildOverviews()
Creates the Build Overviews tool with defaults. |
|
BuildOverviews(Object inMosaicDataset)
Creates the Build Overviews tool with the required parameters. |
Method Summary | |
---|---|
String |
getDefineMissingTiles()
Returns the Define Missing Overview Tiles parameter of this tool . |
String |
getGenerateMissingImages()
Returns the Generate Missing Overview Images Only parameter of this tool . |
String |
getGenerateOverviews()
Returns the Generate Overviews parameter of this tool . |
Object |
getInMosaicDataset()
Returns the Mosaic Dataset parameter of this tool . |
Object |
getOutMosaicDataset()
Returns the Mosaic Dataset parameter of this tool (Read only). |
String |
getRegenerateStaleImages()
Returns the Regenerate Stale Overview Images Only 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. |
Object |
getWhereClause()
Returns the Query Definition parameter of this tool . |
void |
setDefineMissingTiles(String defineMissingTiles)
Sets the Define Missing Overview Tiles parameter of this tool . |
void |
setGenerateMissingImages(String generateMissingImages)
Sets the Generate Missing Overview Images Only parameter of this tool . |
void |
setGenerateOverviews(String generateOverviews)
Sets the Generate Overviews parameter of this tool . |
void |
setInMosaicDataset(Object inMosaicDataset)
Sets the Mosaic Dataset parameter of this tool . |
void |
setRegenerateStaleImages(String regenerateStaleImages)
Sets the Regenerate Stale Overview Images Only parameter of this tool . |
void |
setWhereClause(Object whereClause)
Sets the Query Definition 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 |
---|
public BuildOverviews()
Initializes the array of tool parameters with the default values specified when the tool was created.
public BuildOverviews(Object inMosaicDataset)
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.
inMosaicDataset
- path and name of the mosaic dataset.Method Detail |
---|
public Object getInMosaicDataset()
public void setInMosaicDataset(Object inMosaicDataset)
inMosaicDataset
- path and name of the mosaic dataset.public Object getWhereClause()
public void setWhereClause(Object whereClause)
whereClause
- using SQL you can define a query, or use the Query Builder to build a query.public String getDefineMissingTiles()
public void setDefineMissingTiles(String defineMissingTiles)
defineMissingTiles
- generates overviews if not enough overviews were defined or if new data was added without defining additional overviews.public String getGenerateOverviews()
public void setGenerateOverviews(String generateOverviews)
generateOverviews
- all overviews that need to be created or recreated will be generated. This includes missing overviews and stale overviews.public String getGenerateMissingImages()
public void setGenerateMissingImages(String generateMissingImages)
generateMissingImages
- use if overviews have been defined but not generated.public String getRegenerateStaleImages()
public void setRegenerateStaleImages(String regenerateStaleImages)
regenerateStaleImages
- if the underlying raster datasets have changed or they have had their properties modified, the overviews will be identified as stale.public Object getOutMosaicDataset()
public String getToolName()
public String getToolboxName()
public String getToolboxAlias()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |