com.esri.arcgis.datasourcesraster
Class DEMosaicDataset

java.lang.Object
  com.esri.arcgis.datasourcesraster.DEMosaicDataset

All Implemented Interfaces:

IDEMosaicDataset, IDEMosaicDataset2, IDEMosaicDataset3, IItemPaths, IDataElement, IDERasterDataset, IGPDescribe, IGPValue, IMetadata, com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class DEMosaicDataset
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDEMosaicDataset3, IDERasterDataset, IDataElement, IItemPaths, IGPValue, IGPDescribe, IMetadata, IXMLSerialize, IClone, IPersistStream, IDocumentVersionSupportGEN, IXMLVersionSupport, java.io.Externalizable

COM Class 'DEMosaicDataset'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description 'The MosaicDataset Data Element object.' 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 =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.datasourcesraster.IDEMosaicDataset3

IID, IIDa75c50a6_512a_45be_99e5_2f14e8bcd0c9, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IDEMosaicDataset2

IID661474e7_4926_4bcb_b655_052c890ee010

Fields inherited from interface com.esri.arcgis.datasourcesraster.IDEMosaicDataset

IIDb29e01e9_f293_4b0f_9f1a_3bdafc647ea4

Fields inherited from interface com.esri.arcgis.geodatabase.IDERasterDataset

IID, IID533c75e5_7ca0_40b5_9b20_5f6c1d4b4019, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IDataElement

IID, IIDe2c87df0_33d9_4a47_9b67_fa54b2fd7966, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IItemPaths

IID, IIDcafd4e87_0672_43e0_b92d_175306c1a309, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IGPValue

IID, IID92ee08b6_c757_4178_803c_67cd665ac801, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IMetadata

IID, IID5de04a82_24e4_11d3_a641_0008c7d3ae50, 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

Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

Constructor Summary

DEMosaicDataset()
Constructs a DEMosaicDataset using ArcGIS Engine.

DEMosaicDataset(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DEMosaicDataset theDEMosaicDataset = (DEMosaicDataset) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
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	getAsText() Provides the value of the value object.
int	getBandCount() The number of bands in the collection.
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.
IStringArray	getChildrenNames() The mosaic dataset table names.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getCompressionType() The compression technique applied to this RasterDataset.
java.lang.Object	getContent() The mosaic dataset content.
java.lang.String	getDefinitionQuery() The definition query on raster catalog.
IDETable	getDERasterAttributeTable() The raster attribute table.
IDERasterCatalog	getDERasterCatalog() The DE raster catalog.
java.lang.String	getExtension() File extension.
java.lang.String	getFile() File name.
java.lang.String	getFormat() The format of this RasterRataset.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
double	getMeanCellHeight() The approximate cell height.
double	getMeanCellWidth() The approximate cell width.
IPropertySet	getMetadata() The PropertySet containing metadata.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
IPropertySet	getParameters() The mosaic dataset creation parameters.
java.lang.String	getPath() File path.
IStringArray	getPaths() Returns all paths associated with the object.
java.lang.String	getSensorType() The sensor type of this RasterDataset.
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	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	isInteger() Indicates if the data is integer.
boolean	isMetadataRetrieved() Indicates if the metadata has been retrieved.
boolean	isPermanent() Indicates if the dataset is temporary.
boolean	isReferenced() Indicates if this is a referenced mosaic dataset.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a DEMosaicDataset.
void	replacePaths(IStringArray pOldPaths, IStringArray pNewPaths) Updates all paths associated with the object using the specified mapping rule.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
IGPMessage	setAsText(java.lang.String text) Provides the value of the value object with the given string value.
void	setBandCount(int count) The number of bands in the collection.
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	setChildrenNamesByRef(IStringArray ppNames) The mosaic dataset table names.
void	setCompressionType(java.lang.String comp) The compression technique applied to this RasterDataset.
void	setContent(java.lang.Object pContent) The mosaic dataset content.
void	setDefinitionQuery(java.lang.String pQuery) The definition query on raster catalog.
void	setDERasterAttributeTableByRef(IDETable ppTable) The raster attribute table.
void	setDERasterCatalogByRef(IDERasterCatalog ppDECatalog) The DE raster catalog.
void	setFormat(java.lang.String format) The format of this RasterRataset.
void	setFullPropsRetrieved(boolean fullPropsRetrieved) Indicates if full properties have been retrieved.
void	setIsInteger(boolean isInteger) Indicates if the data is integer.
void	setMeanCellHeight(double cellHeight) The approximate cell height.
void	setMeanCellWidth(double cellWidth) The approximate cell width.
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	setParametersByRef(IPropertySet ppParameters) The mosaic dataset creation parameters.
void	setPermanent(boolean b) Indicates if the dataset is temporary.
void	setReferenced(boolean pReferenced) Indicates if this is a referenced mosaic dataset.
void	setSensorType(java.lang.String sensor) The sensor type of this RasterDataset.
void	setType(java.lang.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(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

DEMosaicDataset

public DEMosaicDataset()
                throws java.io.IOException,
                       java.net.UnknownHostException

Constructs a DEMosaicDataset using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

DEMosaicDataset

public DEMosaicDataset(java.lang.Object obj)
                throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DEMosaicDataset theDEMosaicDataset = (DEMosaicDataset) obj;

Construct a DEMosaicDataset using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to DEMosaicDataset.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a DEMosaicDataset.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getMeanCellHeight

public double getMeanCellHeight()
                         throws java.io.IOException,
                                AutomationException

The approximate cell height.

Specified by:

getMeanCellHeight in interface IDEMosaicDataset3

Returns:

The cellHeight

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMeanCellWidth

public double getMeanCellWidth()
                        throws java.io.IOException,
                               AutomationException

The approximate cell width.

Specified by:

getMeanCellWidth in interface IDEMosaicDataset3

Returns:

The cellWidth

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMeanCellHeight

public void setMeanCellHeight(double cellHeight)
                       throws java.io.IOException,
                              AutomationException

The approximate cell height.

Specified by:

setMeanCellHeight in interface IDEMosaicDataset3

Parameters:

cellHeight - The cellHeight (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMeanCellWidth

public void setMeanCellWidth(double cellWidth)
                      throws java.io.IOException,
                             AutomationException

The approximate cell width.

Specified by:

setMeanCellWidth in interface IDEMosaicDataset3

Parameters:

cellWidth - The cellWidth (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInteger

public boolean isInteger()
                  throws java.io.IOException,
                         AutomationException

Indicates if the data is integer.

Specified by:

isInteger in interface IDEMosaicDataset3

Returns:

The isInteger

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsInteger

public void setIsInteger(boolean isInteger)
                  throws java.io.IOException,
                         AutomationException

Indicates if the data is integer.

Specified by:

setIsInteger in interface IDEMosaicDataset3

Parameters:

isInteger - The isInteger (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDERasterAttributeTable

public IDETable getDERasterAttributeTable()
                                   throws java.io.IOException,
                                          AutomationException

The raster attribute table.

Specified by:

getDERasterAttributeTable in interface IDEMosaicDataset2

Returns:

A reference to a com.esri.arcgis.geodatabase.IDETable

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDERasterAttributeTableByRef

public void setDERasterAttributeTableByRef(IDETable ppTable)
                                    throws java.io.IOException,
                                           AutomationException

The raster attribute table.

Specified by:

setDERasterAttributeTableByRef in interface IDEMosaicDataset2

Parameters:

ppTable - A reference to a com.esri.arcgis.geodatabase.IDETable (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContent

public java.lang.Object getContent()
                            throws java.io.IOException,
                                   AutomationException

The mosaic dataset content.

Specified by:

getContent in interface IDEMosaicDataset

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setContent

public void setContent(java.lang.Object pContent)
                throws java.io.IOException,
                       AutomationException

The mosaic dataset content.

Specified by:

setContent in interface IDEMosaicDataset

Parameters:

pContent - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReferenced

public boolean isReferenced()
                     throws java.io.IOException,
                            AutomationException

Indicates if this is a referenced mosaic dataset.

Specified by:

isReferenced in interface IDEMosaicDataset

Returns:

The pReferenced

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenced

public void setReferenced(boolean pReferenced)
                   throws java.io.IOException,
                          AutomationException

Indicates if this is a referenced mosaic dataset.

Specified by:

setReferenced in interface IDEMosaicDataset

Parameters:

pReferenced - The pReferenced (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildrenNames

public IStringArray getChildrenNames()
                              throws java.io.IOException,
                                     AutomationException

The mosaic dataset table names.

Specified by:

getChildrenNames in interface IDEMosaicDataset

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setChildrenNamesByRef

public void setChildrenNamesByRef(IStringArray ppNames)
                           throws java.io.IOException,
                                  AutomationException

The mosaic dataset table names.

Specified by:

setChildrenNamesByRef in interface IDEMosaicDataset

Parameters:

ppNames - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDERasterCatalog

public IDERasterCatalog getDERasterCatalog()
                                    throws java.io.IOException,
                                           AutomationException

The DE raster catalog.

Specified by:

getDERasterCatalog in interface IDEMosaicDataset

Returns:

A reference to a com.esri.arcgis.geodatabase.IDERasterCatalog

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDERasterCatalogByRef

public void setDERasterCatalogByRef(IDERasterCatalog ppDECatalog)
                             throws java.io.IOException,
                                    AutomationException

The DE raster catalog.

Specified by:

setDERasterCatalogByRef in interface IDEMosaicDataset

Parameters:

ppDECatalog - A reference to a com.esri.arcgis.geodatabase.IDERasterCatalog (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefinitionQuery

public java.lang.String getDefinitionQuery()
                                    throws java.io.IOException,
                                           AutomationException

The definition query on raster catalog.

Specified by:

getDefinitionQuery in interface IDEMosaicDataset

Returns:

The pQuery

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefinitionQuery

public void setDefinitionQuery(java.lang.String pQuery)
                        throws java.io.IOException,
                               AutomationException

The definition query on raster catalog.

Specified by:

setDefinitionQuery in interface IDEMosaicDataset

Parameters:

pQuery - The pQuery (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameters

public IPropertySet getParameters()
                           throws java.io.IOException,
                                  AutomationException

The mosaic dataset creation parameters.

Specified by:

getParameters in interface IDEMosaicDataset

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParametersByRef

public void setParametersByRef(IPropertySet ppParameters)
                        throws java.io.IOException,
                               AutomationException

The mosaic dataset creation parameters.

Specified by:

setParametersByRef in interface IDEMosaicDataset

Parameters:

ppParameters - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFormat

public java.lang.String getFormat()
                           throws java.io.IOException,
                                  AutomationException

The format of this RasterRataset.

Specified by:

getFormat in interface IDERasterDataset

Returns:

The format

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFormat

public void setFormat(java.lang.String format)
               throws java.io.IOException,
                      AutomationException

The format of this RasterRataset.

Specified by:

setFormat in interface IDERasterDataset

Parameters:

format - The format (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompressionType

public java.lang.String getCompressionType()
                                    throws java.io.IOException,
                                           AutomationException

The compression technique applied to this RasterDataset.

Specified by:

getCompressionType in interface IDERasterDataset

Returns:

The comp

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompressionType

public void setCompressionType(java.lang.String comp)
                        throws java.io.IOException,
                               AutomationException

The compression technique applied to this RasterDataset.

Specified by:

setCompressionType in interface IDERasterDataset

Parameters:

comp - The comp (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSensorType

public java.lang.String getSensorType()
                               throws java.io.IOException,
                                      AutomationException

The sensor type of this RasterDataset.

Specified by:

getSensorType in interface IDERasterDataset

Returns:

The sensor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSensorType

public void setSensorType(java.lang.String sensor)
                   throws java.io.IOException,
                          AutomationException

The sensor type of this RasterDataset.

Specified by:

setSensorType in interface IDERasterDataset

Parameters:

sensor - The sensor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBandCount

public int getBandCount()
                 throws java.io.IOException,
                        AutomationException

The number of bands in the collection.

Specified by:

getBandCount in interface IDERasterDataset

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBandCount

public void setBandCount(int count)
                  throws java.io.IOException,
                         AutomationException

The number of bands in the collection.

Specified by:

setBandCount in interface IDERasterDataset

Parameters:

count - The count (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPermanent

public boolean isPermanent()
                    throws java.io.IOException,
                           AutomationException

Indicates if the dataset is temporary.

Specified by:

isPermanent in interface IDERasterDataset

Returns:

The b

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPermanent

public void setPermanent(boolean b)
                  throws java.io.IOException,
                         AutomationException

Indicates if the dataset is temporary.

Specified by:

setPermanent in interface IDERasterDataset

Parameters:

b - The b (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IDataElement_getType

public java.lang.String IDataElement_getType()
                                      throws java.io.IOException,
                                             AutomationException

The type of the element.

Specified by:

IDataElement_getType in interface IDataElement

Returns:

The type

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

public void setType(java.lang.String type)
             throws java.io.IOException,
                    AutomationException

The type of the element.

Specified by:

setType in interface IDataElement

Parameters:

type - The type (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IDataElement_getName

public java.lang.String IDataElement_getName()
                                      throws java.io.IOException,
                                             AutomationException

The user assigned name for the element.

Specified by:

IDataElement_getName in interface IDataElement

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

The user assigned name for the element.

Specified by:

setName in interface IDataElement

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCatalogPath

public java.lang.String getCatalogPath()
                                throws java.io.IOException,
                                       AutomationException

The string used to retrieve the element.

Specified by:

getCatalogPath in interface IDataElement

Returns:

The path

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCatalogPath

public void setCatalogPath(java.lang.String path)
                    throws java.io.IOException,
                           AutomationException

The string used to retrieve the element.

Specified by:

setCatalogPath in interface IDataElement

Parameters:

path - The path (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildren

public IArray getChildren()
                   throws java.io.IOException,
                          AutomationException

The list of sub-elements.

Specified by:

getChildren in interface IDataElement

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setChildrenByRef

public void setChildrenByRef(IArray dataElements)
                      throws java.io.IOException,
                             AutomationException

The list of sub-elements.

Specified by:

setChildrenByRef in interface IDataElement

Parameters:

dataElements - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isChildrenExpanded

public boolean isChildrenExpanded()
                           throws java.io.IOException,
                                  AutomationException

Indicates if the children have been expanded.

Specified by:

isChildrenExpanded in interface IDataElement

Returns:

The childrenExpanded

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setChildrenExpanded

public void setChildrenExpanded(boolean childrenExpanded)
                         throws java.io.IOException,
                                AutomationException

Indicates if the children have been expanded.

Specified by:

setChildrenExpanded in interface IDataElement

Parameters:

childrenExpanded - The childrenExpanded (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMetadataRetrieved

public boolean isMetadataRetrieved()
                            throws java.io.IOException,
                                   AutomationException

Indicates if the metadata has been retrieved.

Specified by:

isMetadataRetrieved in interface IDataElement

Returns:

The metadataRetrieved

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMetadataRetrieved

public void setMetadataRetrieved(boolean metadataRetrieved)
                          throws java.io.IOException,
                                 AutomationException

Indicates if the metadata has been retrieved.

Specified by:

setMetadataRetrieved in interface IDataElement

Parameters:

metadataRetrieved - The metadataRetrieved (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFullPropsRetrieved

public boolean isFullPropsRetrieved()
                             throws java.io.IOException,
                                    AutomationException

Indicates if full properties have been retrieved.

Specified by:

isFullPropsRetrieved in interface IDataElement

Returns:

The fullPropsRetrieved

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFullPropsRetrieved

public void setFullPropsRetrieved(boolean fullPropsRetrieved)
                           throws java.io.IOException,
                                  AutomationException

Indicates if full properties have been retrieved.

Specified by:

setFullPropsRetrieved in interface IDataElement

Parameters:

fullPropsRetrieved - The fullPropsRetrieved (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPath

public java.lang.String getPath()
                         throws java.io.IOException,
                                AutomationException

File path.

Specified by:

getPath in interface IDataElement

Returns:

The path

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFile

public java.lang.String getFile()
                         throws java.io.IOException,
                                AutomationException

File name.

Specified by:

getFile in interface IDataElement

Returns:

The file

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaseName

public java.lang.String getBaseName()
                             throws java.io.IOException,
                                    AutomationException

File base name.

Specified by:

getBaseName in interface IDataElement

Returns:

The baseName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtension

public java.lang.String getExtension()
                              throws java.io.IOException,
                                     AutomationException

File extension.

Specified by:

getExtension in interface IDataElement

Returns:

The extension

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPaths

public IStringArray getPaths()
                      throws java.io.IOException,
                             AutomationException

Returns all paths associated with the object.

Specified by:

getPaths in interface IItemPaths

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replacePaths

public void replacePaths(IStringArray pOldPaths,
                         IStringArray pNewPaths)
                  throws java.io.IOException,
                         AutomationException

Updates all paths associated with the object using the specified mapping rule. The number of values in the two arrays must be the same.

Specified by:

replacePaths in interface IItemPaths

Parameters:

pOldPaths - A reference to a com.esri.arcgis.system.IStringArray (in)

pNewPaths - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws java.io.IOException,
                                        AutomationException

The data type of the value object.

Specified by:

IGPValue_getDataType in interface IGPValue

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPDataType

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws java.io.IOException,
                       AutomationException

Indicates if the value object is empty.

Specified by:

isEmpty in interface IGPValue

Returns:

The isEmpty

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws java.io.IOException,
                  AutomationException

Clears the value object.

Specified by:

empty in interface IGPValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAsText

public java.lang.String getAsText()
                           throws java.io.IOException,
                                  AutomationException

Provides the value of the value object.

Specified by:

getAsText in interface IGPValue

Returns:

The text

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(java.lang.String text)
                     throws java.io.IOException,
                            AutomationException

Provides the value of the value object with the given string value.

Specified by:

setAsText in interface IGPValue

Parameters:

text - The text (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPMessage

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

describe

public java.lang.Object describe(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

The description of the named object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

describe in interface IGPDescribe

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMetadata

public IPropertySet getMetadata()
                         throws java.io.IOException,
                                AutomationException

The PropertySet containing metadata.

Specified by:

getMetadata in interface IMetadata

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMetadata

public void setMetadata(IPropertySet propertySet)
                 throws java.io.IOException,
                        AutomationException

The PropertySet containing metadata.

Specified by:

setMetadata in interface IMetadata

Parameters:

propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

synchronize

public void synchronize(int action,
                        int interval)
                 throws java.io.IOException,
                        AutomationException

Updates metadata with the current properties; may create metadata if it doesn't already exist.

Specified by:

synchronize in interface IMetadata

Parameters:

action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)

interval - The interval (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public java.lang.String getMinNamespaceSupported()
                                          throws java.io.IOException,
                                                 AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException