com.esri.arcgis.geodatabase

Class RasterDatasetName

java.lang.Object

com.esri.arcgis.geodatabase.RasterDatasetName

All Implemented Interfaces:

IDatasetName, IDatasetNameFileSize, IDatasetNameFileStat, IMetadata, IMetadataEdit, INativeTypeInfo, IRasterDatasetContainerName, IRasterDatasetName, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IName, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class RasterDatasetName
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IName, IDatasetName, IPersistStream, IRasterDatasetName, IMetadata, IMetadataEdit, INativeTypeInfo, IDatasetNameFileStat, IDatasetNameFileSize, IRasterDatasetContainerName, IDocumentVersionSupportGEN, java.io.Externalizable

COM Class 'RasterDatasetName'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description 'A container for name information about a raster dataset.' 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

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

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

IID, IID89e75917_c287_11d1_aa77_00c04fa33a15, 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.geodatabase.IRasterDatasetName

IID, IIDbc25e11e_168b_11d2_8d25_0000f8780535, 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.IMetadataEdit

IID, IID97fdb978_62a4_49c5_8252_b07837b33ee9, xxDummy

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

IID, IID906db24a_f0ad_4ca5_871b_5466e54fab80, xxDummy

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

IID, IID9db4594f_dc4b_457a_ae2e_ffea8bd8d72e, xxDummy

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

IID, IID62ae7f20_59e5_44af_8dba_fa4da33b6af7, xxDummy

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

IID, IIDedb00d1e_1e4e_4b1f_bb48_e09499137088, xxDummy

Constructor Summary

Constructors

Constructor and Description
RasterDatasetName() Constructs a RasterDatasetName using ArcGIS Engine.
RasterDatasetName(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. RasterDatasetName theRasterDatasetName = (RasterDatasetName) obj;

Method Summary

Modifier and Type	Method and Description
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getCategory() The category of the dataset.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
IPropertySet	getMetadata() The PropertySet containing metadata.
java.lang.String	getName() The name of the dataset.
java.lang.String	getNameString() The name string of the object.
INativeType	getNativeType() The native type.
IEnumDatasetName	getRasterBandNames() The band names in the RasterDataset.
long	getSize64() The size.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getStatMode() The access mode.
int	getStatSize() The size.
int	getStatTime(int dateMode) The date modified/created/accessed.
IEnumDatasetName	getSubsetNames() Subset names contained within this dataset name.
int	getType() The type of the dataset.
IWorkspaceName	getWorkspaceName() The WorkspaceName of the DatasetName.
int	hashCode() the hashcode for this object
boolean	isCanEditMetadata() Indicates if metadata can be edited.
void	isDirty() isDirty
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
java.lang.Object	open() Opens the object referred to by this name.
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	setCategory(java.lang.String category) The category of the dataset.
void	setMetadata(IPropertySet propertySet) The PropertySet containing metadata.
void	setName(java.lang.String name) The name of the dataset.
void	setNameString(java.lang.String nameString) The name string of the object.
void	setStatMode(int pAccessMode) The access mode.
void	setStatSize(int pSize) The size.
void	setStatTime(int dateMode, int pTime) The date modified/created/accessed.
void	setWorkspaceNameByRef(IWorkspaceName workspaceName) The WorkspaceName of the DatasetName.
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

RasterDatasetName

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

Constructs a RasterDatasetName using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RasterDatasetName

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

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

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

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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

setNameString

public void setNameString(java.lang.String nameString)
                   throws java.io.IOException,
                          AutomationException

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNameString in interface IName

Parameters:

nameString - The nameString (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNameString

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

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNameString in interface IName

Returns:

The nameString

Throws:

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

AutomationException - If the ArcObject component throws an exception.

open

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

Opens the object referred to by this name.

Remarks

The Open method lets you instantiate the actual object given the name object.

Note: Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.

Example:

IName   pName = pFeatureClassName; 
pFeatureClass = new IFeatureClassProxy(pName.open());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

open in interface IName

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

The name of the dataset.

Specified by:

getName in interface IDatasetName

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 name of the dataset.

Specified by:

setName in interface IDatasetName

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

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

The type of the dataset.

Specified by:

getType in interface IDatasetName

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCategory

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

The category of the dataset.

Specified by:

getCategory in interface IDatasetName

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(java.lang.String category)
                 throws java.io.IOException,
                        AutomationException

The category of the dataset.

Specified by:

setCategory in interface IDatasetName

Parameters:

category - The category (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

public IWorkspaceName getWorkspaceName()
                                throws java.io.IOException,
                                       AutomationException

The WorkspaceName of the DatasetName.

Specified by:

getWorkspaceName in interface IDatasetName

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWorkspaceNameByRef

public void setWorkspaceNameByRef(IWorkspaceName workspaceName)
                           throws java.io.IOException,
                                  AutomationException

The WorkspaceName of the DatasetName.

Specified by:

setWorkspaceNameByRef in interface IDatasetName

Parameters:

workspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubsetNames

public IEnumDatasetName getSubsetNames()
                                throws java.io.IOException,
                                       AutomationException

Subset names contained within this dataset name.

Specified by:

getSubsetNames in interface IDatasetName

Returns:

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

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.

getRasterBandNames

public IEnumDatasetName getRasterBandNames()
                                    throws java.io.IOException,
                                           AutomationException

The band names in the RasterDataset.

Specified by:

getRasterBandNames in interface IRasterDatasetName

Returns:

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

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.

isCanEditMetadata

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

Indicates if metadata can be edited.

Specified by:

isCanEditMetadata in interface IMetadataEdit

Returns:

The canEdit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNativeType

public INativeType getNativeType()
                          throws java.io.IOException,
                                 AutomationException

The native type.

Specified by:

getNativeType in interface INativeTypeInfo

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStatTime

public void setStatTime(int dateMode,
                        int pTime)
                 throws java.io.IOException,
                        AutomationException

The date modified/created/accessed.

Specified by:

setStatTime in interface IDatasetNameFileStat

Parameters:

dateMode - A com.esri.arcgis.geodatabase.esriDatasetFileStatTimeMode constant (in)

pTime - The pTime (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStatTime

public int getStatTime(int dateMode)
                throws java.io.IOException,
                       AutomationException

The date modified/created/accessed.

Specified by:

getStatTime in interface IDatasetNameFileStat

Parameters:

dateMode - A com.esri.arcgis.geodatabase.esriDatasetFileStatTimeMode constant (in)

Returns:

The pTime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStatSize

public void setStatSize(int pSize)
                 throws java.io.IOException,
                        AutomationException

The size.

Specified by:

setStatSize in interface IDatasetNameFileStat

Parameters:

pSize - The pSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStatSize

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

The size.

Specified by:

getStatSize in interface IDatasetNameFileStat

Returns:

The pSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStatMode

public void setStatMode(int pAccessMode)
                 throws java.io.IOException,
                        AutomationException

The access mode.

Specified by:

setStatMode in interface IDatasetNameFileStat

Parameters:

pAccessMode - A com.esri.arcgis.geodatabase.esriDatasetFileStatAccessMode constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStatMode

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

The access mode.

Specified by:

getStatMode in interface IDatasetNameFileStat

Returns:

A com.esri.arcgis.geodatabase.esriDatasetFileStatAccessMode constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSize64

public long getSize64()
               throws java.io.IOException,
                      AutomationException

The size. 64bit Value

Specified by:

getSize64 in interface IDatasetNameFileSize

Returns:

Unsigned 64-bit int

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.

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