|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geoprocessing.BaseGeoprocessingTool
public abstract class BaseGeoprocessingTool
Field Summary | |
---|---|
GPUtilities |
gpUtilities
|
Constructor Summary | |
---|---|
BaseGeoprocessingTool()
|
Method Summary | |
---|---|
abstract void |
execute(IArray paramvalues,
ITrackCancel trackcancel,
IGPEnvironmentManager envMgr,
IGPMessages messages)
Executes the tool |
IUID |
getDialogCLSID()
Returns Dialog Class ID |
abstract java.lang.String |
getDisplayName()
This is the display name of the function tool. |
abstract IName |
getFullName()
This is the function name object for the geoprocessing function tool. |
int |
getHelpContext()
Returns the Help Context - unique context identifier in a [MAP] file (.h). |
java.lang.String |
getHelpFile()
Returns path to a compiled help file (a .chm file), which is used to describe and explain the function and its operations |
abstract java.lang.String |
getMetadataFile()
This is the name of the .xml file containing the default metadata for this function object. |
abstract java.lang.String |
getName()
This is the name of the function tool. |
abstract IArray |
getParameterInfo()
Returns an array of paramInfo This is the location where the parameters to the Function Tool are defined. |
java.lang.Object |
getRenderer(IGPParameter arg0)
This is used to set a custom renderer for the output of the function tool. |
abstract boolean |
isLicensed()
This is used to return whether the function tool is licensed to execute. |
abstract void |
updateMessages(IArray paramvalues,
IGPEnvironmentManager envMgr,
IGPMessages gpMessages)
Post validates the given set of values. |
abstract void |
updateParameters(IArray paramvalues,
IGPEnvironmentManager envMgr)
Pre validates the given set of values. |
IGPMessages |
validate(IArray paramvalues,
boolean updateValues,
IGPEnvironmentManager envMgr)
Validates the tool This will validate each parameter and return messages. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public GPUtilities gpUtilities
Constructor Detail |
---|
public BaseGeoprocessingTool()
Method Detail |
---|
public abstract IArray getParameterInfo() throws java.io.IOException, AutomationException
getParameterInfo
in interface IGPFunction
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public abstract void updateParameters(IArray paramvalues, IGPEnvironmentManager envMgr)
updateParameters
in interface IGPFunction2
paramvalues
- A reference to a com.esri.arcgis.system.IArray (in)pEnvMgr
- A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public abstract void updateMessages(IArray paramvalues, IGPEnvironmentManager envMgr, IGPMessages gpMessages)
updateMessages
in interface IGPFunction2
paramvalues
- A reference to a com.esri.arcgis.system.IArray (in)pEnvMgr
- A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)messages
- A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public abstract void execute(IArray paramvalues, ITrackCancel trackcancel, IGPEnvironmentManager envMgr, IGPMessages messages) throws java.io.IOException, AutomationException
execute
in interface IGPFunction
paramvalues
- A reference to a com.esri.arcgis.system.IArray (in)trackcancel
- A reference to a com.esri.arcgis.system.ITrackCancel (in)envMgr
- A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)messages
- A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public abstract boolean isLicensed() throws java.io.IOException, AutomationException
isLicensed
in interface IGPFunction
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public abstract java.lang.String getName() throws java.io.IOException, AutomationException
getName
in interface IGPFunction
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public abstract java.lang.String getDisplayName() throws java.io.IOException, AutomationException
getDisplayName
in interface IGPFunction
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public abstract IName getFullName() throws java.io.IOException, AutomationException
getFullName
in interface IGPFunction
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public abstract java.lang.String getMetadataFile() throws java.io.IOException, AutomationException
getMetadataFile
in interface IGPFunction
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public final java.lang.String getHelpFile() throws java.io.IOException, AutomationException
getHelpFile
in interface IGPFunction
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public final int getHelpContext() throws java.io.IOException, AutomationException
getHelpContext
in interface IGPFunction
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public final IGPMessages validate(IArray paramvalues, boolean updateValues, IGPEnvironmentManager envMgr)
validate
in interface IGPFunction
paramvalues
- A reference to a com.esri.arcgis.system.IArray (in)updateValues
- The updateValues (in)envMgr
- A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
public final IUID getDialogCLSID() throws java.io.IOException, AutomationException
getDialogCLSID
in interface IGPFunction
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public final java.lang.Object getRenderer(IGPParameter arg0) throws java.io.IOException, AutomationException
getRenderer
in interface IGPFunction
arg0
- A reference to a com.esri.arcgis.geoprocessing.IGPParameter (in)
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 |