com.esri.arcgis.datasourcesraster
Class MosaicWorkspaceExtension

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

All Implemented Interfaces:

IMosaicWorkspaceExtension, IDatasetContainer, IDatasetContainer2, IDatasetContainer3, IWorkspaceExtension, IWorkspaceExtension2, IWorkspaceExtensionControl, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class MosaicWorkspaceExtension
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicWorkspaceExtension, IWorkspaceExtension, IWorkspaceExtension2, IWorkspaceExtensionControl, IDatasetContainer, IDatasetContainer2, IDatasetContainer3

A mosaic dataset workspace extension.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

MosaicWorkspaceExtension()
Constructs a MosaicWorkspaceExtension using ArcGIS Engine.

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

Method Summary

void	addDataset(IDataset datasetToAdd) Adds a dataset to the dataset collection.
IDataset	createDataset(IDEDataset dataElement) Given a data element, create a dataset in this container.
IMosaicDataset	createMosaicDataset(String name, ISpatialReference pSpatialReference, ICreateMosaicDatasetParameters pParameters, String configurationKeyword) Creates a mosaic dataset.
IMosaicDataset	createReferencedMosaicDataset(String name, ISpatialReference pSpatialReference, IRasterCatalog pExternalCatalog, String definitionQuery, ICreateMosaicDatasetParameters pParameters, String configurationKeyword) Creates a referenced mosaic dataset from an external raster catalog.
void	deleteMosaicDataset(String name) Deletes a mosaic dataset.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IEnumBSTR	getDataDictionaryTableNames() Any data dictionary tables that should not be exposed to browsers and should not participate in edit sessions.
IDataset	getDataset(int type, int index) The dataset associated with the specified index value and dataset type.
IDataset	getDatasetByID(int type, int datasetID) The dataset associated with the specified index value and dataset type.
IDataset	getDatasetByName(int type, String name) The dataset of the specified type with the specified name.
int	getDatasetCount(int type) The number of datasets of the specified type in this container.
IEnumDatasetName	getDatasetNames(int type) The names of all the datasets with the specified type.
IEnumDataset	getDatasets(int type) An enumerator over the datasets of the specified type.
IEnumDatasetType	getDatasetTypes() The names of all the datasets with the specified type.
IUID	getGUID() The GUID that identifies this Workspace Extension.
String	getName() The Name for this Workspace Extension.
IEnumBSTR	getPrivateDatasetNames(int dtype) The private datasets that should not be exposed to browsers.
IWorkspace	getWorkspace() The workspace associated with this Workspace Extension.
int	hashCode() the hashcode for this object
void	init(IWorkspaceHelper pWorkspaceHelper) Initializes the extension, passing in a reference to its workspace helper.
IMosaicDataset	openMosaicDataset(String name) Opens a mosaic dataset for a given name.
boolean	ownsDatasetType(int datasetType) Indicates if the workspace extension owns the dataset type.
void	shutdown() Informs the extension that its workspace helper (and workspace) are going away.

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

MosaicWorkspaceExtension

public MosaicWorkspaceExtension()
                         throws IOException,
                                UnknownHostException

Constructs a MosaicWorkspaceExtension using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

MosaicWorkspaceExtension

public MosaicWorkspaceExtension(Object obj)
                         throws IOException

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

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

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

createMosaicDataset

public IMosaicDataset createMosaicDataset(String name,
                                          ISpatialReference pSpatialReference,
                                          ICreateMosaicDatasetParameters pParameters,
                                          String configurationKeyword)
                                   throws IOException,
                                          AutomationException

Creates a mosaic dataset.

Product Availability

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

Specified by:

createMosaicDataset in interface IMosaicWorkspaceExtension

Parameters:

name - The name (in)

pSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

pParameters - A reference to a com.esri.arcgis.datasourcesraster.ICreateMosaicDatasetParameters (in)

configurationKeyword - The configurationKeyword (in)

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IMosaicDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createReferencedMosaicDataset

public IMosaicDataset createReferencedMosaicDataset(String name,
                                                    ISpatialReference pSpatialReference,
                                                    IRasterCatalog pExternalCatalog,
                                                    String definitionQuery,
                                                    ICreateMosaicDatasetParameters pParameters,
                                                    String configurationKeyword)
                                             throws IOException,
                                                    AutomationException

Creates a referenced mosaic dataset from an external raster catalog.

Product Availability

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

Specified by:

createReferencedMosaicDataset in interface IMosaicWorkspaceExtension

Parameters:

name - The name (in)

pSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

pExternalCatalog - A reference to a com.esri.arcgis.geodatabase.IRasterCatalog (in)

definitionQuery - The definitionQuery (in)

pParameters - A reference to a com.esri.arcgis.datasourcesraster.ICreateMosaicDatasetParameters (in)

configurationKeyword - The configurationKeyword (in)

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IMosaicDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openMosaicDataset

public IMosaicDataset openMosaicDataset(String name)
                                 throws IOException,
                                        AutomationException

Opens a mosaic dataset for a given name.

Product Availability

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

Specified by:

openMosaicDataset in interface IMosaicWorkspaceExtension

Parameters:

name - The name (in)

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IMosaicDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteMosaicDataset

public void deleteMosaicDataset(String name)
                         throws IOException,
                                AutomationException

Deletes a mosaic dataset.

Product Availability

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

Specified by:

deleteMosaicDataset in interface IMosaicWorkspaceExtension

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The Name for this Workspace Extension.

Remarks

The Name property is the name of the extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IWorkspaceExtension

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGUID

public IUID getGUID()
             throws IOException,
                    AutomationException

The GUID that identifies this Workspace Extension.

Remarks

The GUID property returns the well-known GUID for the extension and is guaranteed to be unique.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getGUID in interface IWorkspaceExtension

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrivateDatasetNames

public IEnumBSTR getPrivateDatasetNames(int dtype)
                                 throws IOException,
                                        AutomationException

The private datasets that should not be exposed to browsers.

Product Availability

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

Specified by:

getPrivateDatasetNames in interface IWorkspaceExtension

Parameters:

dtype - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataDictionaryTableNames

public IEnumBSTR getDataDictionaryTableNames()
                                      throws IOException,
                                             AutomationException

Any data dictionary tables that should not be exposed to browsers and should not participate in edit sessions.

Remarks

The PrivateDatasetNames and DataDictionaryNames properties return the names of tables and datasets that are private to the extension and will not be exposed by the workspace to browsing clients. Since they return an EnumBSTR object that is not cocreatable, you must create your own object that implements IEnumBSTR.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDataDictionaryTableNames in interface IWorkspaceExtension

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

ownsDatasetType

public boolean ownsDatasetType(int datasetType)
                        throws IOException,
                               AutomationException

Indicates if the workspace extension owns the dataset type.

Remarks

The OwnDatasetType method returns a boolean indicating whether the workspace extension supports the specified dataset type.

Product Availability

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

Specified by:

ownsDatasetType in interface IWorkspaceExtension2

Parameters:

datasetType - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

Returns:

The pOwnsType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspace

public IWorkspace getWorkspace()
                        throws IOException,
                               AutomationException

The workspace associated with this Workspace Extension.

Remarks

The Workspace property returns a reference to the workspace associated with the extension.

Product Availability

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

Specified by:

getWorkspace in interface IWorkspaceExtension2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

init

public void init(IWorkspaceHelper pWorkspaceHelper)
          throws IOException,
                 AutomationException

Initializes the extension, passing in a reference to its workspace helper.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

init in interface IWorkspaceExtensionControl

Parameters:

pWorkspaceHelper - A reference to a com.esri.arcgis.geodatabase.IWorkspaceHelper (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

shutdown

public void shutdown()
              throws IOException,
                     AutomationException

Informs the extension that its workspace helper (and workspace) are going away.

Remarks

The Shutdown method informs the workspace extension that the workspace has been released by all clients and is about to go away. In response, the workspace extension should release its reference on the workspace helper. Any subsequent calls by the application to the workspace extension should return an error.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

shutdown in interface IWorkspaceExtensionControl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDataset

public void addDataset(IDataset datasetToAdd)
                throws IOException,
                       AutomationException

Adds a dataset to the dataset collection.

Remarks

When calling this method on feature datasets, both the XY and Z spatial reference systems of the dataset (if applicable) must match those of the feature dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

addDataset in interface IDatasetContainer

Parameters:

datasetToAdd - A reference to a com.esri.arcgis.geodatabase.IDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataset

public IDataset getDataset(int type,
                           int index)
                    throws IOException,
                           AutomationException

The dataset associated with the specified index value and dataset type.

Product Availability

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

Specified by:

getDataset in interface IDatasetContainer2

Parameters:

type - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasets

public IEnumDataset getDatasets(int type)
                         throws IOException,
                                AutomationException

An enumerator over the datasets of the specified type.

Product Availability

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

Specified by:

getDatasets in interface IDatasetContainer2

Parameters:

type - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetCount

public int getDatasetCount(int type)
                    throws IOException,
                           AutomationException

The number of datasets of the specified type in this container.

Product Availability

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

Specified by:

getDatasetCount in interface IDatasetContainer2

Parameters:

type - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetByName

public IDataset getDatasetByName(int type,
                                 String name)
                          throws IOException,
                                 AutomationException

The dataset of the specified type with the specified name.

Product Availability

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

Specified by:

getDatasetByName in interface IDatasetContainer2

Parameters:

type - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

name - The name (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetNames

public IEnumDatasetName getDatasetNames(int type)
                                 throws IOException,
                                        AutomationException

The names of all the datasets with the specified type.

Product Availability

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

Specified by:

getDatasetNames in interface IDatasetContainer2

Parameters:

type - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

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.

getDatasetTypes

public IEnumDatasetType getDatasetTypes()
                                 throws IOException,
                                        AutomationException

The names of all the datasets with the specified type.

Remarks

The DatasetTypes property returns an enumerator of IEnumDatasetType containing the supported esriDatasetTypes for the container. Use this method to determine the supported datasets for the container.

Product Availability

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

Specified by:

getDatasetTypes in interface IDatasetContainer2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createDataset

public IDataset createDataset(IDEDataset dataElement)
                       throws IOException,
                              AutomationException

Given a data element, create a dataset in this container.

Remarks

The CreateDataset method will create a dataset given a populated data element. Use the DatasetTypes property to determine the supported dataset types.

Product Availability

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

Specified by:

createDataset in interface IDatasetContainer2

Parameters:

dataElement - A reference to a com.esri.arcgis.geodatabase.IDEDataset (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetByID

public IDataset getDatasetByID(int type,
                               int datasetID)
                        throws IOException,
                               AutomationException

The dataset associated with the specified index value and dataset type.

Product Availability

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

Specified by:

getDatasetByID in interface IDatasetContainer3

Parameters:

type - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

datasetID - The datasetID (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.