com.esri.arcgis.geodatabase
Class MosaicDatasetName

java.lang.Object
  com.esri.arcgis.geodatabase.MosaicDatasetName

All Implemented Interfaces:

IDatasetName, IMosaicDatasetName, IMosaicDatasetName2, com.esri.arcgis.interop.RemoteObjRef, IName, Serializable

public class MosaicDatasetName
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicDatasetName, IMosaicDatasetName2, IName, IDatasetName

The mosaic dataset name object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

MosaicDatasetName()
Constructs a MosaicDatasetName using ArcGIS Engine.

MosaicDatasetName(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MosaicDatasetName theMosaicDatasetName = (MosaicDatasetName) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
String	getCategory() The category of the dataset.
IStringArray	getChildrenNames() The mosaic dataset table names.
static String	getClsid() getClsid.
String	getName() The name of the dataset.
String	getNameString() The name string of the object.
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	isReferenced() Indicates if this is a referenced mosaic dataset.
Object	open() Opens the object referred to by this name.
void	setCategory(String category) The category of the dataset.
void	setChildrenNamesByRef(IStringArray ppNames) The mosaic dataset table names.
void	setName(String name) The name of the dataset.
void	setNameString(String nameString) The name string of the object.
void	setReferenced(boolean pReferenced) Indicates if this is a referenced mosaic dataset.
void	setWorkspaceNameByRef(IWorkspaceName workspaceName) The WorkspaceName of the DatasetName.

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

MosaicDatasetName

public MosaicDatasetName()
                  throws IOException,
                         UnknownHostException

Constructs a MosaicDatasetName using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

MosaicDatasetName

public MosaicDatasetName(Object obj)
                  throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

isReferenced

public boolean isReferenced()
                     throws IOException,
                            AutomationException

Indicates if this is a referenced mosaic dataset.

Product Availability

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

Specified by:

isReferenced in interface IMosaicDatasetName

Returns:

The pReferenced

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenced

public void setReferenced(boolean pReferenced)
                   throws IOException,
                          AutomationException

Indicates if this is a referenced mosaic dataset.

Product Availability

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

Specified by:

setReferenced in interface IMosaicDatasetName

Parameters:

pReferenced - The pReferenced (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildrenNames

public IStringArray getChildrenNames()
                              throws IOException,
                                     AutomationException

The mosaic dataset table names.

Product Availability

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

Specified by:

getChildrenNames in interface IMosaicDatasetName2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setChildrenNamesByRef

public void setChildrenNamesByRef(IStringArray ppNames)
                           throws IOException,
                                  AutomationException

The mosaic dataset table names.

Product Availability

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

Specified by:

setChildrenNamesByRef in interface IMosaicDatasetName2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNameString

public void setNameString(String nameString)
                   throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNameString

public String getNameString()
                     throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

public Object open()
            throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IDatasetName

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

The name of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IDatasetName

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException

The type of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getType in interface IDatasetName

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException

The category of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCategory in interface IDatasetName

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(String category)
                 throws IOException,
                        AutomationException

The category of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCategory in interface IDatasetName

Parameters:

category - The category (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

public IWorkspaceName getWorkspaceName()
                                throws IOException,
                                       AutomationException

The WorkspaceName of the DatasetName.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWorkspaceName in interface IDatasetName

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWorkspaceNameByRef

public void setWorkspaceNameByRef(IWorkspaceName workspaceName)
                           throws IOException,
                                  AutomationException

The WorkspaceName of the DatasetName.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setWorkspaceNameByRef in interface IDatasetName

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubsetNames

public IEnumDatasetName getSubsetNames()
                                throws IOException,
                                       AutomationException

Subset names contained within this dataset name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSubsetNames in interface IDatasetName

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.