|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IGeoProcessor2
COM Interface 'IGeoProcessor2'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'
Description: 'The Geoprocessor. Provides access to toolboxes and tools.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =
Field Summary | |
---|---|
static java.lang.String |
IID
Deprecated. Internal use only |
static int |
IIDcdad9319_2080_4c89_91c6_b679ae671975
|
static int |
xxDummy
Deprecated. Internal use only |
Method Summary | |
---|---|
void |
addError(java.lang.String message)
Output an error message. |
void |
addMessage(java.lang.String message)
Output an informative message. |
void |
addReturnMessage(int index)
Output message from the last tool executed. |
void |
addToolbox(java.lang.String toolbox)
Add a toolbox to the current Geoprocessing session by catalog path. |
void |
addWarning(java.lang.String message)
Output a warning message. |
void |
checkResultStatus(IGeoProcessorResult pGPResult)
Check for end of result. |
void |
clearMessages()
Clear the messages to be returned as tool message when running within a script tool. |
IGeoProcessorResult |
createResult(java.lang.String toolName,
java.lang.String jobID)
Create a new result object. |
IGeoProcessorResult |
execute(java.lang.String name,
IVariantArray ipValues,
ITrackCancel pTrackCancel)
Execute a tool within the current Geoprocessing session. |
IGeoProcessorResult |
executeASync(java.lang.String name,
IVariantArray ipValues)
Execute a tool within the current Geoprocessing session. |
boolean |
exists(java.lang.Object inputValue,
java.lang.Object pDataType)
Test the existence of a given parameter value (GPValue or catalog path) the type of the data is optional. |
IDataElement |
getDataElement(java.lang.Object inputValue,
java.lang.Object pDataType)
Make a dataelement from the given value. |
java.lang.Object |
getEnvironmentValue(java.lang.String environmentName)
Retrieve the value of an environment by name. |
int |
getMaxSeverity()
Return the maximum severity of the message of the last tool executed. |
java.lang.String |
getMessage(int index)
Return the message description by index of the last tool executed. |
int |
getMessageCount()
Return the number of messages of the last tool executed. |
java.lang.String |
getMessages(java.lang.Object pSeverity)
Return all of the message descriptions of the last tool executed. |
int |
getParameterCount()
Return the number of input command line or script tool parameters. |
java.lang.Object |
getParameterValue(int index)
Return the input command line or script tool parameter by index as a GPValue. |
int |
getReturnCode(int index)
Return the message error code (Error Messages Only) by index of the last tool executed. |
IGPMessages |
getReturnMessages()
Return the GPMessages object which will be messages of the last tool executed. |
int |
getSeverity(int index)
Return the message severity by index of the last tool executed. |
boolean |
isAddOutputsToMap()
Set whether resulting output datasets should be added to the application display. |
boolean |
isAddToResults()
Set whether to add results to result view. |
boolean |
isLogHistory()
Set whether or not to log the execution of geoprocessing tools. |
boolean |
isOverwriteOutput()
Set the overwrite outputs flag within the current Geoprocessing session. |
boolean |
isSynchronous(java.lang.String toolName)
Is server tool synchronous. |
boolean |
isTemporaryMapLayers()
Set whether new map layers are temporary by default. |
IGpEnumList |
listDatasets(java.lang.String wildCard,
java.lang.String datasetType)
Return the list of feature datasets within the current workspace. |
IGpEnumList |
listEnvironments(java.lang.String wildCard)
Return the list of environments (properties) within the current Geoprocessing session. |
IGpEnumList |
listFeatureClasses(java.lang.String wildCard,
java.lang.String featureType,
java.lang.String dataset)
Return the list of feature classes within the current workspace or feature dataset within the workspace. |
IGpEnumList |
listRasters(java.lang.String wildCard,
java.lang.String rasterType)
Return the list of rasters within the current workspace. |
IGpEnumList |
listTables(java.lang.String wildCard,
java.lang.String tableType)
Return the list of tables within the current workspace. |
IGpEnumList |
listToolboxes(java.lang.String wildCard)
Return the list of toolboxes within the current Geoprocessing session. |
IGpEnumList |
listTools(java.lang.String wildCard)
Return the list of tools within the current Geoprocessing session. |
IGpEnumList |
listWorkspaces(java.lang.String wildCard,
java.lang.String workspaceType)
Return the list of workspaces within the current workspace (the workspace can be a folder). |
void |
loadSettings(java.lang.String fileName)
Load the current settings (toolboxes, environment values, etc) from a file on disk in XML format. |
java.lang.Object |
open(java.lang.Object value)
Open an objector a namestring. |
java.lang.String |
parseFieldName(java.lang.String inputFieldName,
java.lang.String workspace)
Parse a field name within the given workspace. |
java.lang.String |
parseTableName(java.lang.String inputTableName,
java.lang.String workspace)
Parse a table name within the given workspace. |
java.lang.String |
qualifyFieldName(java.lang.String inputFieldName,
java.lang.String workspace)
Qualify a field name within the given workspace. |
java.lang.String |
qualifyTableName(java.lang.String inputTableName,
java.lang.String workspace)
Qualify a table name within the given workspace. |
void |
registerGeoProcessorEvents(IGeoProcessorEvents pGeoProcessorEvents)
Register an object to recieve IGeoProcessorEvents. |
void |
registerGeoProcessorEvents3(IGeoProcessorEvents3 pGeoProcessorEvents3)
Register an object to recieve IGeoProcessorEvents3. |
void |
removeToolbox(java.lang.String toolbox)
Remove a toolbox from the current Geoprocessing session by catalog path. |
void |
resetEnvironments()
Reset the environments to their initial state. |
void |
saveSettings(java.lang.String fileName)
Save the current settings (toolboxes, environment values, etc) to a file on disk in XML format. |
void |
setAddOutputsToMap(boolean addToMap)
Set whether resulting output datasets should be added to the application display. |
void |
setAddToResults(boolean addToResults)
Set whether to add results to result view. |
void |
setEnvironmentValue(java.lang.String environmentName,
java.lang.Object value)
Update the value of an environment by name. |
void |
setLogHistory(boolean logHistory)
Set whether or not to log the execution of geoprocessing tools. |
void |
setOverwriteOutput(boolean pOverrideOutput)
Set the overwrite outputs flag within the current Geoprocessing session. |
void |
setParameterValue(int index,
java.lang.Object value)
Set the output script tool parameter by index as a GPValue. |
void |
setTemporaryMapLayers(boolean temporaryMapLayers)
Set whether new map layers are temporary by default. |
java.lang.String |
testSchemaLock(java.lang.String fileName)
Test for the presence of a schema lock (already open for writing) of a given file or dataset. |
void |
unRegisterGeoProcessorEvents(IGeoProcessorEvents pGeoProcessorEvents)
UnRegister an object to stop recieving IGeoProcessorEvents. |
void |
unRegisterGeoProcessorEvents3(IGeoProcessorEvents3 pGeoProcessorEvents3)
UnRegister an object to stop recieving IGeoProcessorEvents3. |
java.lang.String |
usage(java.lang.String method)
Returns the command line usage of a given tool by name. |
IGPMessages |
validate(java.lang.String name,
IVariantArray ipValues,
boolean bUpdateValues)
Validate the parameters (input) of a tool within the current Geoprocessing session. |
java.lang.String |
validateFieldName(java.lang.String inputFieldName,
java.lang.String workspace)
Validate a field name within the given workspace. |
java.lang.String |
validateTableName(java.lang.String inputTableName,
java.lang.String workspace)
Validate a table or feature class name within the given workspace. |
Field Detail |
---|
static final int IIDcdad9319_2080_4c89_91c6_b679ae671975
static final int xxDummy
static final java.lang.String IID
Method Detail |
---|
java.lang.Object getEnvironmentValue(java.lang.String environmentName) throws java.io.IOException, AutomationException
environmentName
- The environmentName (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setEnvironmentValue(java.lang.String environmentName, java.lang.Object value) throws java.io.IOException, AutomationException
environmentName
- The environmentName (in)value
- A Variant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void resetEnvironments() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IGeoProcessorResult execute(java.lang.String name, IVariantArray ipValues, ITrackCancel pTrackCancel) throws java.io.IOException, AutomationException
name
- The name (in)ipValues
- A reference to a com.esri.arcgis.system.IVariantArray (in)pTrackCancel
- A reference to a com.esri.arcgis.system.ITrackCancel (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IGPMessages validate(java.lang.String name, IVariantArray ipValues, boolean bUpdateValues) throws java.io.IOException, AutomationException
name
- The name (in)ipValues
- A reference to a com.esri.arcgis.system.IVariantArray (in)bUpdateValues
- The bUpdateValues (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.Object open(java.lang.Object value) throws java.io.IOException, AutomationException
value
- A Variant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IDataElement getDataElement(java.lang.Object inputValue, java.lang.Object pDataType) throws java.io.IOException, AutomationException
inputValue
- A Variant (in)pDataType
- A Variant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IGpEnumList listTools(java.lang.String wildCard) throws java.io.IOException, AutomationException
wildCard
- The wildCard (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IGpEnumList listEnvironments(java.lang.String wildCard) throws java.io.IOException, AutomationException
wildCard
- The wildCard (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IGpEnumList listToolboxes(java.lang.String wildCard) throws java.io.IOException, AutomationException
wildCard
- The wildCard (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void addToolbox(java.lang.String toolbox) throws java.io.IOException, AutomationException
toolbox
- The toolbox (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void removeToolbox(java.lang.String toolbox) throws java.io.IOException, AutomationException
toolbox
- The toolbox (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setAddOutputsToMap(boolean addToMap) throws java.io.IOException, AutomationException
addToMap
- The addToMap (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isAddOutputsToMap() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setOverwriteOutput(boolean pOverrideOutput) throws java.io.IOException, AutomationException
pOverrideOutput
- The pOverrideOutput (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isOverwriteOutput() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setTemporaryMapLayers(boolean temporaryMapLayers) throws java.io.IOException, AutomationException
temporaryMapLayers
- The temporaryMapLayers (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isTemporaryMapLayers() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setLogHistory(boolean logHistory) throws java.io.IOException, AutomationException
logHistory
- The logHistory (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isLogHistory() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IGPMessages getReturnMessages() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getMessageCount() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.String getMessage(int index) throws java.io.IOException, AutomationException
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getSeverity(int index) throws java.io.IOException, AutomationException
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getReturnCode(int index) throws java.io.IOException, AutomationException
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.String getMessages(java.lang.Object pSeverity) throws java.io.IOException, AutomationException
pSeverity
- A Variant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getMaxSeverity() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void addMessage(java.lang.String message) throws java.io.IOException, AutomationException
message
- The message (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void addError(java.lang.String message) throws java.io.IOException, AutomationException
message
- The message (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void addWarning(java.lang.String message) throws java.io.IOException, AutomationException
message
- The message (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void addReturnMessage(int index) throws java.io.IOException, AutomationException
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void clearMessages() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getParameterCount() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.Object getParameterValue(int index) throws java.io.IOException, AutomationException
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setParameterValue(int index, java.lang.Object value) throws java.io.IOException, AutomationException
index
- The index (in)value
- A Variant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean exists(java.lang.Object inputValue, java.lang.Object pDataType) throws java.io.IOException, AutomationException
inputValue
- A Variant (in)pDataType
- A Variant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.String usage(java.lang.String method) throws java.io.IOException, AutomationException
method
- The method (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IGpEnumList listFeatureClasses(java.lang.String wildCard, java.lang.String featureType, java.lang.String dataset) throws java.io.IOException, AutomationException
wildCard
- The wildCard (in)featureType
- The featureType (in)dataset
- The dataset (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IGpEnumList listDatasets(java.lang.String wildCard, java.lang.String datasetType) throws java.io.IOException, AutomationException
wildCard
- The wildCard (in)datasetType
- The datasetType (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IGpEnumList listWorkspaces(java.lang.String wildCard, java.lang.String workspaceType) throws java.io.IOException, AutomationException
wildCard
- The wildCard (in)workspaceType
- The workspaceType (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IGpEnumList listTables(java.lang.String wildCard, java.lang.String tableType) throws java.io.IOException, AutomationException
wildCard
- The wildCard (in)tableType
- The tableType (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IGpEnumList listRasters(java.lang.String wildCard, java.lang.String rasterType) throws java.io.IOException, AutomationException
wildCard
- The wildCard (in)rasterType
- The rasterType (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.String validateFieldName(java.lang.String inputFieldName, java.lang.String workspace) throws java.io.IOException, AutomationException
inputFieldName
- The inputFieldName (in)workspace
- The workspace (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.String validateTableName(java.lang.String inputTableName, java.lang.String workspace) throws java.io.IOException, AutomationException
inputTableName
- The inputTableName (in)workspace
- The workspace (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.String qualifyFieldName(java.lang.String inputFieldName, java.lang.String workspace) throws java.io.IOException, AutomationException
inputFieldName
- The inputFieldName (in)workspace
- The workspace (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.String qualifyTableName(java.lang.String inputTableName, java.lang.String workspace) throws java.io.IOException, AutomationException
inputTableName
- The inputTableName (in)workspace
- The workspace (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.String parseFieldName(java.lang.String inputFieldName, java.lang.String workspace) throws java.io.IOException, AutomationException
inputFieldName
- The inputFieldName (in)workspace
- The workspace (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.String parseTableName(java.lang.String inputTableName, java.lang.String workspace) throws java.io.IOException, AutomationException
inputTableName
- The inputTableName (in)workspace
- The workspace (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void saveSettings(java.lang.String fileName) throws java.io.IOException, AutomationException
fileName
- The fileName (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void loadSettings(java.lang.String fileName) throws java.io.IOException, AutomationException
fileName
- The fileName (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.String testSchemaLock(java.lang.String fileName) throws java.io.IOException, AutomationException
fileName
- The fileName (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void registerGeoProcessorEvents(IGeoProcessorEvents pGeoProcessorEvents) throws java.io.IOException, AutomationException
pGeoProcessorEvents
- A reference to a com.esri.arcgis.geoprocessing.IGeoProcessorEvents (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void unRegisterGeoProcessorEvents(IGeoProcessorEvents pGeoProcessorEvents) throws java.io.IOException, AutomationException
pGeoProcessorEvents
- A reference to a com.esri.arcgis.geoprocessing.IGeoProcessorEvents (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IGeoProcessorResult createResult(java.lang.String toolName, java.lang.String jobID) throws java.io.IOException, AutomationException
toolName
- The toolName (in)jobID
- The jobID (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isSynchronous(java.lang.String toolName) throws java.io.IOException, AutomationException
toolName
- The toolName (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IGeoProcessorResult executeASync(java.lang.String name, IVariantArray ipValues) throws java.io.IOException, AutomationException
name
- The name (in)ipValues
- A reference to a com.esri.arcgis.system.IVariantArray (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void registerGeoProcessorEvents3(IGeoProcessorEvents3 pGeoProcessorEvents3) throws java.io.IOException, AutomationException
pGeoProcessorEvents3
- A reference to a com.esri.arcgis.geoprocessing.IGeoProcessorEvents3 (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void unRegisterGeoProcessorEvents3(IGeoProcessorEvents3 pGeoProcessorEvents3) throws java.io.IOException, AutomationException
pGeoProcessorEvents3
- A reference to a com.esri.arcgis.geoprocessing.IGeoProcessorEvents3 (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void checkResultStatus(IGeoProcessorResult pGPResult) throws java.io.IOException, AutomationException
pGPResult
- A reference to a com.esri.arcgis.geoprocessing.IGeoProcessorResult (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setAddToResults(boolean addToResults) throws java.io.IOException, AutomationException
addToResults
- The addToResults (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isAddToResults() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |