|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.datasourcesfile.DEMapDocument
public class DEMapDocument
Map Document Data Element object.
| Constructor Summary | |
|---|---|
DEMapDocument()
Constructs a DEMapDocument using ArcGIS Engine. |
|
DEMapDocument(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. DEMapDocument theDEMapDocument = (DEMapDocument) obj; |
|
| Method Summary | |
|---|---|
void |
assign(IClone src)
Assigns the properties of src to the receiver. |
Object |
describe(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(Object o)
Compare this object with another |
IClone |
esri_clone()
Clones the receiver and assigns the result to *clone. |
String |
getAsText()
Provides the value of the value object. |
String |
getBaseName()
File base name. |
String |
getCatalogPath()
The string used to retrieve the element. |
IArray |
getChildren()
The list of sub-elements. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
String |
getExtension()
File extension. |
String |
getFile()
File name. |
IPropertySet |
getMetadata()
The PropertySet containing metadata. |
String |
getName()
The user assigned name for the element. |
String |
getPath()
File path. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
int |
hashCode()
the hashcode for this object |
String |
IDataElement_getType()
The type of the element. |
IGPDataType |
IGPValue_getDataType()
The data type of the value object. |
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. |
void |
load(IStream pstm)
load |
void |
readExternal(ObjectInput in)
|
void |
save(IStream pstm,
int fClearDirty)
save |
void |
serialize(IXMLSerializeData data)
Serializes an object to XML. |
IGPMessage |
setAsText(String text)
Provides the value of the value object with the given string value. |
void |
setCatalogPath(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 |
setFullPropsRetrieved(boolean fullPropsRetrieved)
Indicates if full properties have been retrieved. |
void |
setMetadata(IPropertySet ppPropertySet)
The PropertySet containing metadata. |
void |
setMetadataRetrieved(boolean metadataRetrieved)
Indicates if the metadata has been retrieved. |
void |
setName(String name)
The user assigned name for the element. |
void |
setType(String type)
The type of the element. |
void |
synchronize(int action,
int interval)
Updates metadata with the current properties; may create metadata if it doesn't already exist. |
void |
writeExternal(ObjectOutput out)
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
|---|
getJintegraDispatch, release |
| Constructor Detail |
|---|
public DEMapDocument()
throws IOException,
UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public DEMapDocument(Object obj)
throws IOException
DEMapDocument theDEMapDocument = (DEMapDocument) obj;
obj to DEMapDocument.
obj - an object returned from ArcGIS Engine or Server
IOException - if there are interop problems| Method Detail |
|---|
public static String getClsid()
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public String IDataElement_getType()
throws IOException,
AutomationException
IDataElement_getType in interface IDataElementIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setType(String type)
throws IOException,
AutomationException
setType in interface IDataElementtype - The type (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getName()
throws IOException,
AutomationException
getName in interface IDataElementIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setName(String name)
throws IOException,
AutomationException
setName in interface IDataElementname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getCatalogPath()
throws IOException,
AutomationException
| Dataset Type | Keyword |
|---|---|
| Feature dataset | FD |
| Feature class | FC |
| Object class | OC |
| Relationship class | RC |
| Geometric network | GN |
| Topology | TOPO |
| Raster band | RB |
| Raster dataset | RD |
| Raster catalog | RCAT |
| Toolbox | TB |
The following are sample catalog paths:
getCatalogPath in interface IDataElementIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCatalogPath(String path)
throws IOException,
AutomationException
setCatalogPath in interface IDataElementpath - The path (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IArray getChildren()
throws IOException,
AutomationException
getChildren in interface IDataElementIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setChildrenByRef(IArray dataElements)
throws IOException,
AutomationException
setChildrenByRef in interface IDataElementdataElements - A reference to a com.esri.arcgis.system.IArray (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isChildrenExpanded()
throws IOException,
AutomationException
isChildrenExpanded in interface IDataElementIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setChildrenExpanded(boolean childrenExpanded)
throws IOException,
AutomationException
setChildrenExpanded in interface IDataElementchildrenExpanded - The childrenExpanded (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isMetadataRetrieved()
throws IOException,
AutomationException
isMetadataRetrieved in interface IDataElementIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMetadataRetrieved(boolean metadataRetrieved)
throws IOException,
AutomationException
setMetadataRetrieved in interface IDataElementmetadataRetrieved - The metadataRetrieved (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isFullPropsRetrieved()
throws IOException,
AutomationException
isFullPropsRetrieved in interface IDataElementIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setFullPropsRetrieved(boolean fullPropsRetrieved)
throws IOException,
AutomationException
setFullPropsRetrieved in interface IDataElementfullPropsRetrieved - The fullPropsRetrieved (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getPath()
throws IOException,
AutomationException
getPath in interface IDataElementIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getFile()
throws IOException,
AutomationException
getFile in interface IDataElementIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getBaseName()
throws IOException,
AutomationException
getBaseName in interface IDataElementIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getExtension()
throws IOException,
AutomationException
getExtension in interface IDataElementIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet getMetadata()
throws IOException,
AutomationException
The variable to hold the data must be of IPropertySet data type.
The metadata property is frequently used to save, or update, changes to metadata documents that have taken place through methods available on the IPropertySet, IXmlPropertySet, and/or IXmlPropertySet2 interfaces.
getMetadata in interface IMetadataIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMetadata(IPropertySet ppPropertySet)
throws IOException,
AutomationException
setMetadata in interface IMetadatappPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void synchronize(int action,
int interval)
throws IOException,
AutomationException
The Synchronize method is used to extract metadata properties from an object and write those properties to the metadata .xml. Depending on the value of the esriMetaSyncAction, the Synchronize method may generate a new set of metadata if it doesn't already exist.
The following actions will result in synchronization given each of the listed conditions:
| Action | Metadata status | Esri/Sync element | Interval parameter |
|---|---|---|---|
| esriMSAAccessed | Doesn't matter | Must not be FALSE | Must be less than actual interval |
| esriMSAAlways | Doesn't matter | Doesn't matter | Doesn't matter |
| esriMSACreated | Must not exist | Must not be FALSE | Must be less than actual interval |
| esriMSANotCreated | Must exist | Must not be FALSE | Must be less than actual interval |
| esriMSAOverwrite | Doesn't matter | Doesn't matter | Doesn't matter |
The difference between esriMSAAlways and esriMSAOverwrite lies in which elements are synchronized. esriMSAAlways will honor the removal or value change of an element's Sync attribute (to disable synchronization), whereas using esriMSAOverwrite is equivalent to setting the IXmlPropertySet2.OverwriteSyncAttribute to true for the metadata's property set, meaning that even elements without a Sync attribute of TRUE will be synchronized.
synchronize in interface IMetadataaction - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)interval - The interval (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGPDataType IGPValue_getDataType()
throws IOException,
AutomationException
IGPValue_getDataType in interface IGPValueIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isEmpty()
throws IOException,
AutomationException
The IsEmpty method returns if this Value object has been set or not.
isEmpty in interface IGPValueIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void empty()
throws IOException,
AutomationException
The Empty method clears this Value object and releases any associated objects.
empty in interface IGPValueIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getAsText()
throws IOException,
AutomationException
The GetAsText method returns this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string for the scalar value.
getAsText in interface IGPValueIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGPMessage setAsText(String text)
throws IOException,
AutomationException
The SetAsText method sets the value of this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string representing the scalar value.
setAsText in interface IGPValuetext - The text (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void serialize(IXMLSerializeData data)
throws IOException,
AutomationException
serialize in interface IXMLSerializedata - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deserialize(IXMLSerializeData data)
throws IOException,
AutomationException
deserialize in interface IXMLSerializedata - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IClone esri_clone()
throws IOException,
AutomationException
esri_clone in interface ICloneIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void assign(IClone src)
throws IOException,
AutomationException
assign in interface IClonesrc - A reference to a com.esri.arcgis.system.IClone (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isEqual(IClone other)
throws IOException,
AutomationException
IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.
isEqual in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isIdentical(IClone other)
throws IOException,
AutomationException
IsIdentical returns true if the receiver and the source reference the same object.
isIdentical in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void isDirty()
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty in interface IPersistStreamIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void load(IStream pstm)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void save(IStream pstm,
int fClearDirty)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)fClearDirty - The fClearDirty (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getClassID(GUID[] pClassID)
throws IOException,
AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object describe(String name)
throws IOException,
AutomationException
describe in interface IGPDescribename - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void writeExternal(ObjectOutput out)
throws IOException
writeExternal in interface ExternalizableIOException
public void readExternal(ObjectInput in)
throws IOException,
ClassNotFoundException
readExternal in interface ExternalizableIOException
ClassNotFoundException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||