|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geoprocessing.DEToolbox
public class DEToolbox
COM Class 'DEToolbox'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'
Description 'The toolbox Data Element.' 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 long |
serialVersionUID
|
Fields inherited from interface com.esri.arcgis.geoprocessing.IDEToolbox2 |
---|
IID, IIDa6bfa57e_e24f_4488_b12b_0039e32e7c3e, xxDummy |
Fields inherited from interface com.esri.arcgis.geoprocessing.IDEToolbox |
---|
IID13898bab_baf8_438c_ae88_cc3f3341b270 |
Fields inherited from interface com.esri.arcgis.geodatabase.IDEDataset |
---|
IID, IID29fbed10_a332_11d5_931b_0080c71a3226, xxDummy |
Fields inherited from interface com.esri.arcgis.geodatabase.IDataElement |
---|
IID, IIDe2c87df0_33d9_4a47_9b67_fa54b2fd7966, xxDummy |
Fields inherited from interface com.esri.arcgis.geodatabase.IMetadata |
---|
IID, IID5de04a82_24e4_11d3_a641_0008c7d3ae50, xxDummy |
Fields inherited from interface com.esri.arcgis.geodatabase.IGPValue |
---|
IID, IID92ee08b6_c757_4178_803c_67cd665ac801, xxDummy |
Fields inherited from interface com.esri.arcgis.system.IXMLSerialize |
---|
IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy |
Fields inherited from interface com.esri.arcgis.system.IClone |
---|
IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy |
Fields inherited from interface com.esri.arcgis.system.IPersistStream |
---|
IID, IID00000109_0000_0000_c000_000000000046, xxDummy |
Fields inherited from interface com.esri.arcgis.system.IPersist |
---|
IID0000010c_0000_0000_c000_000000000046 |
Constructor Summary | |
---|---|
DEToolbox()
Constructs a DEToolbox using ArcGIS Engine. |
|
DEToolbox(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. DEToolbox theDEToolbox = (DEToolbox) obj; |
Method Summary | |
---|---|
void |
assign(IClone src)
Assigns the properties of src to the receiver. |
java.lang.Object |
describe(java.lang.String name)
The description of the named object. |
void |
deserialize(IXMLSerializeData data)
Deserializes an object from XML. |
void |
empty()
Clears the value object. |
boolean |
equals(java.lang.Object o)
Compare this object with another |
IClone |
esri_clone()
Clones the receiver and assigns the result to *clone. |
java.lang.String |
getAlias()
The toolbox alias. |
java.lang.String |
getAsText()
Provides the value of the value object. |
java.lang.String |
getBaseName()
File base name. |
java.lang.String |
getCatalogPath()
The string used to retrieve the element. |
IArray |
getChildren()
The list of sub-elements. |
void |
getClassID(GUID[] pClassID)
getClassID |
static java.lang.String |
getClsid()
getClsid. |
int |
getDatasetType()
Dataset type. |
java.lang.String |
getDisplayName()
The display name of the toolbox. |
int |
getDSID()
The id of the dataset. |
java.lang.String |
getExtension()
File extension. |
java.lang.String |
getFile()
File name. |
int |
getHelpContext()
The context identifier of the topic within the help file for this toolbox. |
java.lang.String |
getHelpFile()
The name of the (CHM) file containing help information for this toolbox. |
com.esri.arcgis.interop.Dispatch |
getJintegraDispatch()
Deprecated. Internal use only. |
IPropertySet |
getMetadata()
The PropertySet containing metadata. |
java.lang.String |
getPath()
File path. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
int |
hashCode()
the hashcode for this object |
java.lang.String |
IDataElement_getName()
The user assigned name for the element. |
java.lang.String |
IDataElement_getType()
The type of the element. |
IGPDataType |
IGPValue_getDataType()
The data type of the value object. |
boolean |
isCanVersion()
Indicates if this dataset can be versioned. |
boolean |
isChildrenExpanded()
Indicates if the children have been expanded. |
void |
isDirty()
isDirty |
boolean |
isEmpty()
Indicates if the value object is empty. |
boolean |
isEqual(IClone other)
Indicates if the receiver and other have the same properties. |
boolean |
isFullPropsRetrieved()
Indicates if full properties have been retrieved. |
boolean |
isIdentical(IClone other)
Indicates if the receiver and other are the same object. |
boolean |
isMetadataRetrieved()
Indicates if the metadata has been retrieved. |
boolean |
isVersioned()
Indicates if this dataset is versioned. |
void |
load(IStream pstm)
load |
void |
readExternal(java.io.ObjectInput in)
|
void |
release()
Release a DEToolbox. |
void |
save(IStream pstm,
int fClearDirty)
save |
void |
serialize(IXMLSerializeData data)
Serializes an object to XML. |
void |
setAlias(java.lang.String alias)
The toolbox alias. |
IGPMessage |
setAsText(java.lang.String text)
Provides the value of the value object with the given string value. |
void |
setCanVersion(boolean canVersion)
Indicates if this dataset can be versioned. |
void |
setCatalogPath(java.lang.String path)
The string used to retrieve the element. |
void |
setChildrenByRef(IArray dataElements)
The list of sub-elements. |
void |
setChildrenExpanded(boolean childrenExpanded)
Indicates if the children have been expanded. |
void |
setDatasetType(int type)
Dataset type. |
void |
setDisplayName(java.lang.String displayName)
The display name of the toolbox. |
void |
setDSID(int dSID)
The id of the dataset. |
void |
setFullPropsRetrieved(boolean fullPropsRetrieved)
Indicates if full properties have been retrieved. |
void |
setHelpContext(int context)
The context identifier of the topic within the help file for this toolbox. |
void |
setHelpFile(java.lang.String file)
The name of the (CHM) file containing help information for this toolbox. |
void |
setMetadata(IPropertySet propertySet)
The PropertySet containing metadata. |
void |
setMetadataRetrieved(boolean metadataRetrieved)
Indicates if the metadata has been retrieved. |
void |
setName(java.lang.String name)
The user assigned name for the element. |
void |
setType(java.lang.String type)
The type of the element. |
void |
setVersioned(boolean versioned)
Indicates if this dataset is versioned. |
void |
synchronize(int action,
int interval)
Updates metadata with the current properties; may create metadata if it doesn't already exist. |
void |
writeExternal(java.io.ObjectOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final long serialVersionUID
Constructor Detail |
---|
public DEToolbox() throws java.io.IOException, java.net.UnknownHostException
java.io.IOException
- if there are interop problems
java.net.UnknownHostException
- if there are interop problemspublic DEToolbox(java.lang.Object obj) throws java.io.IOException
DEToolbox theDEToolbox = (DEToolbox) obj;
obj
to DEToolbox
.
obj
- an object returned from ArcGIS Engine or Server
java.io.IOException
- if there are interop problemsMethod Detail |
---|
public static java.lang.String getClsid()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch
in interface com.esri.arcgis.interop.RemoteObjRef
public void release()
release
in interface com.esri.arcgis.interop.RemoteObjRef
public java.lang.String getDisplayName() throws java.io.IOException, AutomationException
getDisplayName
in interface IDEToolbox2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDisplayName(java.lang.String displayName) throws java.io.IOException, AutomationException
setDisplayName
in interface IDEToolbox2
displayName
- The displayName (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getHelpFile() throws java.io.IOException, AutomationException
getHelpFile
in interface IDEToolbox2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHelpFile(java.lang.String file) throws java.io.IOException, AutomationException
setHelpFile
in interface IDEToolbox2
file
- The file (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getHelpContext() throws java.io.IOException, AutomationException
getHelpContext
in interface IDEToolbox2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHelpContext(int context) throws java.io.IOException, AutomationException
setHelpContext
in interface IDEToolbox2
context
- The context (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getAlias() throws java.io.IOException, AutomationException
getAlias
in interface IDEToolbox
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAlias(java.lang.String alias) throws java.io.IOException, AutomationException
setAlias
in interface IDEToolbox
alias
- The alias (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getDatasetType() throws java.io.IOException, AutomationException
getDatasetType
in interface IDEDataset
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDatasetType(int type) throws java.io.IOException, AutomationException
setDatasetType
in interface IDEDataset
type
- A com.esri.arcgis.geodatabase.esriDatasetType constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isVersioned() throws java.io.IOException, AutomationException
isVersioned
in interface IDEDataset
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setVersioned(boolean versioned) throws java.io.IOException, AutomationException
setVersioned
in interface IDEDataset
versioned
- The versioned (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getDSID() throws java.io.IOException, AutomationException
getDSID
in interface IDEDataset
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDSID(int dSID) throws java.io.IOException, AutomationException
setDSID
in interface IDEDataset
dSID
- The dSID (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCanVersion() throws java.io.IOException, AutomationException
isCanVersion
in interface IDEDataset
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCanVersion(boolean canVersion) throws java.io.IOException, AutomationException
setCanVersion
in interface IDEDataset
canVersion
- The canVersion (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String IDataElement_getType() throws java.io.IOException, AutomationException
IDataElement_getType
in interface IDataElement
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setType(java.lang.String type) throws java.io.IOException, AutomationException
setType
in interface IDataElement
type
- The type (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String IDataElement_getName() throws java.io.IOException, AutomationException
IDataElement_getName
in interface IDataElement
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setName(java.lang.String name) throws java.io.IOException, AutomationException
setName
in interface IDataElement
name
- The name (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getCatalogPath() throws java.io.IOException, AutomationException
getCatalogPath
in interface IDataElement
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCatalogPath(java.lang.String path) throws java.io.IOException, AutomationException
setCatalogPath
in interface IDataElement
path
- The path (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray getChildren() throws java.io.IOException, AutomationException
getChildren
in interface IDataElement
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setChildrenByRef(IArray dataElements) throws java.io.IOException, AutomationException
setChildrenByRef
in interface IDataElement
dataElements
- A reference to a com.esri.arcgis.system.IArray (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isChildrenExpanded() throws java.io.IOException, AutomationException
isChildrenExpanded
in interface IDataElement
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setChildrenExpanded(boolean childrenExpanded) throws java.io.IOException, AutomationException
setChildrenExpanded
in interface IDataElement
childrenExpanded
- The childrenExpanded (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isMetadataRetrieved() throws java.io.IOException, AutomationException
isMetadataRetrieved
in interface IDataElement
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMetadataRetrieved(boolean metadataRetrieved) throws java.io.IOException, AutomationException
setMetadataRetrieved
in interface IDataElement
metadataRetrieved
- The metadataRetrieved (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isFullPropsRetrieved() throws java.io.IOException, AutomationException
isFullPropsRetrieved
in interface IDataElement
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setFullPropsRetrieved(boolean fullPropsRetrieved) throws java.io.IOException, AutomationException
setFullPropsRetrieved
in interface IDataElement
fullPropsRetrieved
- The fullPropsRetrieved (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getPath() throws java.io.IOException, AutomationException
getPath
in interface IDataElement
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getFile() throws java.io.IOException, AutomationException
getFile
in interface IDataElement
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getBaseName() throws java.io.IOException, AutomationException
getBaseName
in interface IDataElement
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getExtension() throws java.io.IOException, AutomationException
getExtension
in interface IDataElement
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPropertySet getMetadata() throws java.io.IOException, AutomationException
getMetadata
in interface IMetadata
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMetadata(IPropertySet propertySet) throws java.io.IOException, AutomationException
setMetadata
in interface IMetadata
propertySet
- A reference to a com.esri.arcgis.system.IPropertySet (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void synchronize(int action, int interval) throws java.io.IOException, AutomationException
synchronize
in interface IMetadata
action
- A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)interval
- The interval (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGPDataType IGPValue_getDataType() throws java.io.IOException, AutomationException
IGPValue_getDataType
in interface IGPValue
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEmpty() throws java.io.IOException, AutomationException
isEmpty
in interface IGPValue
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void empty() throws java.io.IOException, AutomationException
empty
in interface IGPValue
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getAsText() throws java.io.IOException, AutomationException
getAsText
in interface IGPValue
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGPMessage setAsText(java.lang.String text) throws java.io.IOException, AutomationException
setAsText
in interface IGPValue
text
- The text (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void serialize(IXMLSerializeData data) throws java.io.IOException, AutomationException
serialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deserialize(IXMLSerializeData data) throws java.io.IOException, AutomationException
deserialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IClone esri_clone() throws java.io.IOException, AutomationException
esri_clone
in interface IClone
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void assign(IClone src) throws java.io.IOException, AutomationException
assign
in interface IClone
src
- A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEqual(IClone other) throws java.io.IOException, AutomationException
isEqual
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isIdentical(IClone other) throws java.io.IOException, AutomationException
isIdentical
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws java.io.IOException, AutomationException
isDirty
in interface IPersistStream
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws java.io.IOException, AutomationException
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws java.io.IOException, AutomationException
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws java.io.IOException, AutomationException
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws java.io.IOException, AutomationException
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.Object describe(java.lang.String name) throws java.io.IOException, AutomationException
describe
in interface IGPDescribe
name
- The name (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
java.io.IOException
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
java.io.IOException
java.lang.ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |