|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.catalog.GxCadDataset
public class GxCadDataset
A Cad Feature Class or Drawing dataset.
Constructor Summary | |
---|---|
GxCadDataset()
Constructs a GxCadDataset using ArcGIS Engine. |
|
GxCadDataset(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. GxCadDataset theGxCadDataset = (GxCadDataset) obj; |
Method Summary | |
---|---|
IGxObject |
addChild(IGxObject child)
Adds a new child and returns a reference to it. |
void |
attach(IGxObject parent,
IGxCatalog pCatalog)
Attaches the object to its parent and the catalog. |
boolean |
canCopy()
Indicates if the object can be copied. |
boolean |
canDelete()
Indicates if the object can be deleted. |
boolean |
canPaste(IEnumName names,
boolean[] moveOperation)
Indicates if the specified names may be pasted into this object. |
boolean |
canRename()
Indicates if the object can be renamed. |
void |
delete()
Deletes the object. |
void |
deleteChild(IGxObject child)
Deletes the specified child object. |
void |
detach()
Instructs the object to detach itself from its parent and the catalog. |
void |
editProperties(int hParent)
Presents a modal dialog to allow editing the object's properties. |
boolean |
equals(Object o)
Compare this object with another |
String |
getBaseName()
The base name of the object (i.e. |
String |
getCategory()
The category of the object. |
IEnumGxObject |
getChildren()
An enumeration of the child objects. |
IUID |
getClassID()
The class ID of this object. |
static String |
getClsid()
getClsid. |
IUID |
getContextMenu()
The class ID of the context menu for this object. |
IDataElement |
getDataElement(IDEBrowseOptions browseOptions)
Get the GxObject's data element. |
IDataset |
getDataset()
The associated dataset. |
IDatasetName |
getDatasetName()
The associated dataset name. |
String |
getFullName()
The full name of the object. |
IName |
getInternalObjectName()
The Name for the internal object that this GxObject represents. |
int |
getLargeImage()
The large image that represents the object. |
int |
getLargeSelectedImage()
The large image that represents the object when it is selected. |
IPropertySet |
getMetadata()
The PropertySet containing metadata. |
String |
getName()
The short name of the object. |
INativeType |
getNativeType()
The native type. |
IUID |
getNewMenu()
The class ID of the New menu for this object. |
IGxObject |
getParent()
The parent of the object. |
void |
getPropByIndex(int index,
String[] name,
Object[] value)
The name and value of the indexed property in the GxObject. |
Object |
getProperty(String name)
The value of the named property in the GxObject. |
int |
getPropertyCount()
The number of properties in the GxObject. |
int |
getSmallImage()
The small image that represents the object. |
int |
getSmallSelectedImage()
The small image that represents the object when it is selected. |
IPicture |
getThumbnail()
The Thumbnail. |
int |
getType()
The type of the associated dataset. |
int |
hashCode()
the hashcode for this object |
boolean |
isAreChildrenViewable()
Indicates if the objects children are available for viewing in the tree-view. |
boolean |
isCanEditMetadata()
Indicates if metadata can be edited. |
boolean |
isHasChildren()
Indicates if the object has any children. |
boolean |
isValid()
Indicates if the object is still valid. |
void |
loadCachedObjects()
Loads any objects that should be cached for efficiency. |
boolean |
paste(IEnumName names,
boolean[] moveOperation)
Pastes the specified names into this object. |
void |
refresh()
Updates the object and any children of the object. |
void |
releaseCachedObjects()
Releases any objects that have been cached for efficiency. |
void |
rename(String newShortName)
Renames the object. |
void |
retrieveDEBaseProperties(IDataElement[] dataElement)
Retrieve the GxObject's light-weight properties. |
void |
retrieveDEFullProperties(IDataElement[] dataElement)
Retrieve the GxObject's heavy-weight properties. |
void |
setDatasetNameByRef(IDatasetName datasetName)
The associated dataset name. |
void |
setInternalObjectNameByRef(IName internalObjectName)
The Name for the internal object that this GxObject represents. |
void |
setMetadata(IPropertySet ppPropertySet)
The PropertySet containing metadata. |
void |
setProperty(String name,
Object value)
Set the value of the named property in the GxObject. |
void |
setThumbnailByRef(IPicture picture)
The Thumbnail. |
void |
synchronize(int action,
int interval)
Updates metadata with the current properties; may create metadata if it doesn't already exist. |
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 GxCadDataset() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic GxCadDataset(Object obj) throws IOException
GxCadDataset theGxCadDataset = (GxCadDataset) obj;
obj
to GxCadDataset
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public void setDatasetNameByRef(IDatasetName datasetName) throws IOException, AutomationException
setDatasetNameByRef
in interface IGxDataset
datasetName
- A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IDatasetName getDatasetName() throws IOException, AutomationException
getDatasetName
in interface IGxDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IDataset getDataset() throws IOException, AutomationException
getDataset
in interface IGxDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getType() throws IOException, AutomationException
getType
in interface IGxDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getName() throws IOException, AutomationException
getName
in interface IGxObject
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getFullName() throws IOException, AutomationException
getFullName
in interface IGxObject
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getBaseName() throws IOException, AutomationException
getBaseName
in interface IGxObject
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getCategory() throws IOException, AutomationException
getCategory
in interface IGxObject
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGxObject getParent() throws IOException, AutomationException
getParent
in interface IGxObject
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IUID getClassID() throws IOException, AutomationException
getClassID
in interface IGxObject
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IName getInternalObjectName() throws IOException, AutomationException
getInternalObjectName
in interface IGxObject
getInternalObjectName
in interface IGxObjectInternalName
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isValid() throws IOException, AutomationException
isValid
in interface IGxObject
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void attach(IGxObject parent, IGxCatalog pCatalog) throws IOException, AutomationException
attach
in interface IGxObject
parent
- A reference to a com.esri.arcgis.catalog.IGxObject (in)pCatalog
- A reference to a com.esri.arcgis.catalog.IGxCatalog (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void detach() throws IOException, AutomationException
detach
in interface IGxObject
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void refresh() throws IOException, AutomationException
refresh
in interface IGxObject
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSmallImage() throws IOException, AutomationException
getSmallImage
in interface IGxObjectUI
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSmallSelectedImage() throws IOException, AutomationException
getSmallSelectedImage
in interface IGxObjectUI
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getLargeImage() throws IOException, AutomationException
getLargeImage
in interface IGxObjectUI
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getLargeSelectedImage() throws IOException, AutomationException
getLargeSelectedImage
in interface IGxObjectUI
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IUID getContextMenu() throws IOException, AutomationException
getContextMenu
in interface IGxObjectUI
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IUID getNewMenu() throws IOException, AutomationException
getNewMenu
in interface IGxObjectUI
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canPaste(IEnumName names, boolean[] moveOperation) throws IOException, AutomationException
canPaste
in interface IGxPasteTarget
names
- A reference to a com.esri.arcgis.system.IEnumName (in)moveOperation
- The moveOperation (in/out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean paste(IEnumName names, boolean[] moveOperation) throws IOException, AutomationException
paste
in interface IGxPasteTarget
names
- A reference to a com.esri.arcgis.system.IEnumName (in)moveOperation
- The moveOperation (in/out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void loadCachedObjects() throws IOException, AutomationException
loadCachedObjects
in interface IGxCachedObjects
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void releaseCachedObjects() throws IOException, AutomationException
releaseCachedObjects
in interface IGxCachedObjects
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canRename() throws IOException, AutomationException
canRename
in interface IGxObjectEdit
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void rename(String newShortName) throws IOException, AutomationException
rename
in interface IGxObjectEdit
newShortName
- The newShortName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canDelete() throws IOException, AutomationException
canDelete
in interface IGxObjectEdit
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void delete() throws IOException, AutomationException
delete
in interface IGxObjectEdit
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void editProperties(int hParent) throws IOException, AutomationException
editProperties
in interface IGxObjectEdit
hParent
- The hParent (A COM typedef) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canCopy() throws IOException, AutomationException
CanCopy must return True if your customized GxObject is intended to support copy/paste, drag/drop within ArcCatalog or drag/drop from ArcCatalog to ArcMap.
canCopy
in interface IGxObjectEdit
IOException
- 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 IMetadata
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMetadata(IPropertySet ppPropertySet) throws IOException, AutomationException
setMetadata
in interface IMetadata
ppPropertySet
- 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 IMetadata
action
- 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 boolean isCanEditMetadata() throws IOException, AutomationException
This property is available to those objects that support metadata.
isCanEditMetadata
in interface IMetadataEdit
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setThumbnailByRef(IPicture picture) throws IOException, AutomationException
setThumbnailByRef
in interface IGxThumbnail
picture
- A reference to a com.esri.arcgis.support.ms.stdole.IPicture (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPicture getThumbnail() throws IOException, AutomationException
getThumbnail
in interface IGxThumbnail
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isHasChildren() throws IOException, AutomationException
Note: This property always return True even when it has no children. This was done to improve the overall ArcCatalog browsing performance.
isHasChildren
in interface IGxObjectContainer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumGxObject getChildren() throws IOException, AutomationException
getChildren
in interface IGxObjectContainer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isAreChildrenViewable() throws IOException, AutomationException
isAreChildrenViewable
in interface IGxObjectContainer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGxObject addChild(IGxObject child) throws IOException, AutomationException
addChild
in interface IGxObjectContainer
child
- A reference to a com.esri.arcgis.catalog.IGxObject (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deleteChild(IGxObject child) throws IOException, AutomationException
deleteChild
in interface IGxObjectContainer
child
- A reference to a com.esri.arcgis.catalog.IGxObject (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getPropertyCount() throws IOException, AutomationException
getPropertyCount
in interface IGxObjectProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getPropByIndex(int index, String[] name, Object[] value) throws IOException, AutomationException
getPropByIndex
in interface IGxObjectProperties
index
- The index (in)name
- The name (in/out: use single element array)value
- A Variant (in/out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getProperty(String name) throws IOException, AutomationException
getProperty
in interface IGxObjectProperties
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setProperty(String name, Object value) throws IOException, AutomationException
setProperty
in interface IGxObjectProperties
name
- The name (in)value
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setInternalObjectNameByRef(IName internalObjectName) throws IOException, AutomationException
setInternalObjectNameByRef
in interface IGxObjectInternalName
internalObjectName
- A reference to a com.esri.arcgis.system.IName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public INativeType getNativeType() throws IOException, AutomationException
getNativeType
in interface INativeTypeInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IDataElement getDataElement(IDEBrowseOptions browseOptions) throws IOException, AutomationException
getDataElement
in interface IGxDataElement
browseOptions
- A reference to a com.esri.arcgis.geodatabase.IDEBrowseOptions (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void retrieveDEFullProperties(IDataElement[] dataElement) throws IOException, AutomationException
retrieveDEFullProperties
in interface IGxDataElementHelper
dataElement
- A reference to a com.esri.arcgis.geodatabase.IDataElement (in/out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void retrieveDEBaseProperties(IDataElement[] dataElement) throws IOException, AutomationException
retrieveDEBaseProperties
in interface IGxDataElementHelper
dataElement
- A reference to a com.esri.arcgis.geodatabase.IDataElement (in/out: use single element array)
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 |