com.esri.arcgis.datasourcesraster
Class RasterTypeName

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.RasterTypeName
All Implemented Interfaces:
IRasterTypeName, com.esri.arcgis.interop.RemoteObjRef, IName, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class RasterTypeName
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IName, IRasterTypeName, IPersistStream, java.io.Externalizable

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

Description 'The raster type name 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.IRasterTypeName
IID, IID3de899f9_7c59_4d03_9afa_5f526398a6b5, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Constructor Summary
RasterTypeName()
          Constructs a RasterTypeName using ArcGIS Engine.
RasterTypeName(java.lang.Object obj)
          Construct a RasterTypeName using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 int getInstanceID()
          The object ID within the mosaic dataset of the raster type instance referenced by this raster type name object.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IMosaicDatasetName getMosaicDatasetName()
          The mosaic dataset name object that stores the raster type instance referenced by this raster type name object.
 java.lang.String getName()
          The string representation of the raster type object.
 java.lang.String getNameString()
          The name string of the object.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 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 a RasterTypeName.
 void save(IStream pstm, int fClearDirty)
          save
 void setInstanceID(int pInstanceID)
          The object ID within the mosaic dataset of the raster type instance referenced by this raster type name object.
 void setMosaicDatasetNameByRef(IMosaicDatasetName ppMosaicDatasetName)
          The mosaic dataset name object that stores the raster type instance referenced by this raster type name object.
 void setName(java.lang.String pName)
          The string representation of the raster type object.
 void setNameString(java.lang.String nameString)
          The name string of the object.
 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

RasterTypeName

public RasterTypeName()
               throws java.io.IOException,
                      java.net.UnknownHostException
Constructs a RasterTypeName using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

RasterTypeName

public RasterTypeName(java.lang.Object obj)
               throws java.io.IOException
Construct a RasterTypeName using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RasterTypeName.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems RasterTypeName theRasterTypeName = (RasterTypeName) obj;
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 RasterTypeName.

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.

setName

public void setName(java.lang.String pName)
             throws java.io.IOException,
                    AutomationException
The string representation of the raster type object. This can either be a name of an installed raster type object (like 'Raster Dataset' or 'Landsat 7 ETM+'), or path to a .ART file, or a fully-qualified path to a raster type instanced stored within a mosaic d?G?^??

Specified by:
setName in interface IRasterTypeName
Parameters:
pName - The pName (in)
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 string representation of the raster type object. This can either be a name of an installed raster type object (like 'Raster Dataset' or 'Landsat 7 ETM+'), or path to a .ART file, or a fully-qualified path to a raster type instanced stored within a mosaic d?G?^??

Specified by:
getName in interface IRasterTypeName
Returns:
The pName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMosaicDatasetNameByRef

public void setMosaicDatasetNameByRef(IMosaicDatasetName ppMosaicDatasetName)
                               throws java.io.IOException,
                                      AutomationException
The mosaic dataset name object that stores the raster type instance referenced by this raster type name object.

Specified by:
setMosaicDatasetNameByRef in interface IRasterTypeName
Parameters:
ppMosaicDatasetName - A reference to a com.esri.arcgis.geodatabase.IMosaicDatasetName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMosaicDatasetName

public IMosaicDatasetName getMosaicDatasetName()
                                        throws java.io.IOException,
                                               AutomationException
The mosaic dataset name object that stores the raster type instance referenced by this raster type name object.

Specified by:
getMosaicDatasetName in interface IRasterTypeName
Returns:
A reference to a com.esri.arcgis.geodatabase.IMosaicDatasetName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInstanceID

public void setInstanceID(int pInstanceID)
                   throws java.io.IOException,
                          AutomationException
The object ID within the mosaic dataset of the raster type instance referenced by this raster type name object.

Specified by:
setInstanceID in interface IRasterTypeName
Parameters:
pInstanceID - The pInstanceID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInstanceID

public int getInstanceID()
                  throws java.io.IOException,
                         AutomationException
The object ID within the mosaic dataset of the raster type instance referenced by this raster type name object.

Specified by:
getInstanceID in interface IRasterTypeName
Returns:
The pInstanceID
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.

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