com.esri.arcgis.datasourcesraster
Class CreateMosaicDatasetParameters

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

All Implemented Interfaces:

ICreateMosaicDatasetParameters, ICreateMosaicDatasetParameters2, IMosaicDatasetOperationParameters, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class CreateMosaicDatasetParameters
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicDatasetOperationParameters, ICreateMosaicDatasetParameters, ICreateMosaicDatasetParameters2

An object that controls how a mosaic dataset is created.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

CreateMosaicDatasetParameters()
Constructs a CreateMosaicDatasetParameters using ArcGIS Engine.

CreateMosaicDatasetParameters(Object obj)
Construct a CreateMosaicDatasetParameters using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
int	getBandCount() The number of bands in the mosaic dataset.
String	getBandDefinitionKeyword() The band definition keyword to be set on the mosaic dataset.
IArray	getBandProperties() Key band properties to be set on the mosaic dataset.
static String	getClsid() getClsid.
IFIDSet	getDefinitionFIDs() The definition selection set on the source catalog.
IGeometry	getDefinitionGeometry() The definition (spatial selection) geometry on the source catalog.
String	getLODFieldName() The name of the field that contains scale values for items in the mosaic dataset.
IMosaicLODInfos	getLODInfos() The levels of detail associated with the mosaic dataset.
String	getMaxCellsizeFieldName() The name of the field that contains maximum visible cell-size values for items in the mosaic dataset.
double	getMaximumVisibleCellsize() The cell-size value above which no mosaicking occurs.
String	getMinCellsizeFieldName() The name of the field that contains minimum visible cell-size values for items in the mosaic dataset.
IPropertySet	getParameters() All parameters associated with the mosaic dataset operation.
int	getPixelType() The pixel-type of the mosaic dataset.
IProgressor	getProgressor() The external progressor object associated with the mosaic dataset operation.
IPropertySet	getResults() The properties of the result associated with the mosaic dataset operation.
IMosaicDataset	getTemplateMosaicDataset() The mosaic dataset from which key properties are copied over to the newly created mosaic dataset.
int	hashCode() the hashcode for this object
boolean	isDatasetReadOnly() Indicates whether the mosaic dataset is in read-only mode.
void	setBandCount(int pCount) The number of bands in the mosaic dataset.
void	setBandDefinitionKeyword(String pBandDefinitionKeyword) The band definition keyword to be set on the mosaic dataset.
void	setBandPropertiesByRef(IArray ppArrayOfPropertySet) Key band properties to be set on the mosaic dataset.
void	setDefinitionFIDsByRef(IFIDSet ppFIDs) The definition selection set on the source catalog.
void	setDefinitionGeometryByRef(IGeometry ppGeometry) The definition (spatial selection) geometry on the source catalog.
void	setIsDatasetReadOnly(boolean pbIsDatasetReadOnly) Indicates whether the mosaic dataset is in read-only mode.
void	setLODFieldName(String pLODFieldName) The name of the field that contains scale values for items in the mosaic dataset.
void	setLODInfosByRef(IMosaicLODInfos ppLODInfos) The levels of detail associated with the mosaic dataset.
void	setMaxCellsizeFieldName(String pMaxCellsizeFieldName) The name of the field that contains maximum visible cell-size values for items in the mosaic dataset.
void	setMaximumVisibleCellsize(double pCellsize) The cell-size value above which no mosaicking occurs.
void	setMinCellsizeFieldName(String pMinCellsizeFieldName) The name of the field that contains minimum visible cell-size values for items in the mosaic dataset.
void	setParametersByRef(IPropertySet ppAllParameters) All parameters associated with the mosaic dataset operation.
void	setPixelType(int pPixelType) The pixel-type of the mosaic dataset.
void	setProgressorByRef(IProgressor ppProgressor) The external progressor object associated with the mosaic dataset operation.
void	setResultsByRef(IPropertySet ppOperationResults) The properties of the result associated with the mosaic dataset operation.
void	setTemplateMosaicDatasetByRef(IMosaicDataset ppMosaicDataset) The mosaic dataset from which key properties are copied over to the newly created mosaic dataset.

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

CreateMosaicDatasetParameters

public CreateMosaicDatasetParameters()
                              throws IOException,
                                     UnknownHostException

Constructs a CreateMosaicDatasetParameters using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

CreateMosaicDatasetParameters

public CreateMosaicDatasetParameters(Object obj)
                              throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems CreateMosaicDatasetParameters theCreateMosaicDatasetParameters = (CreateMosaicDatasetParameters) obj;

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

setParametersByRef

public void setParametersByRef(IPropertySet ppAllParameters)
                        throws IOException,
                               AutomationException

All parameters associated with the mosaic dataset operation.

Product Availability

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

Specified by:

setParametersByRef in interface IMosaicDatasetOperationParameters

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameters

public IPropertySet getParameters()
                           throws IOException,
                                  AutomationException

All parameters associated with the mosaic dataset operation.

Product Availability

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

Specified by:

getParameters in interface IMosaicDatasetOperationParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProgressorByRef

public void setProgressorByRef(IProgressor ppProgressor)
                        throws IOException,
                               AutomationException

The external progressor object associated with the mosaic dataset operation.

Product Availability

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

Specified by:

setProgressorByRef in interface IMosaicDatasetOperationParameters

Parameters:

ppProgressor - A reference to a com.esri.arcgis.system.IProgressor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProgressor

public IProgressor getProgressor()
                          throws IOException,
                                 AutomationException

The external progressor object associated with the mosaic dataset operation.

Product Availability

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

Specified by:

getProgressor in interface IMosaicDatasetOperationParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsDatasetReadOnly

public void setIsDatasetReadOnly(boolean pbIsDatasetReadOnly)
                          throws IOException,
                                 AutomationException

Indicates whether the mosaic dataset is in read-only mode. Mosaic dataset operations do not perform write operations on a read-only mosaic.

Product Availability

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

Specified by:

setIsDatasetReadOnly in interface IMosaicDatasetOperationParameters

Parameters:

pbIsDatasetReadOnly - The pbIsDatasetReadOnly (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDatasetReadOnly

public boolean isDatasetReadOnly()
                          throws IOException,
                                 AutomationException

Indicates whether the mosaic dataset is in read-only mode. Mosaic dataset operations do not perform write operations on a read-only mosaic.

Product Availability

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

Specified by:

isDatasetReadOnly in interface IMosaicDatasetOperationParameters

Returns:

The pbIsDatasetReadOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResultsByRef

public void setResultsByRef(IPropertySet ppOperationResults)
                     throws IOException,
                            AutomationException

The properties of the result associated with the mosaic dataset operation.

Product Availability

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

Specified by:

setResultsByRef in interface IMosaicDatasetOperationParameters

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResults

public IPropertySet getResults()
                        throws IOException,
                               AutomationException

The properties of the result associated with the mosaic dataset operation.

Product Availability

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

Specified by:

getResults in interface IMosaicDatasetOperationParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefinitionGeometryByRef

public void setDefinitionGeometryByRef(IGeometry ppGeometry)
                                throws IOException,
                                       AutomationException

The definition (spatial selection) geometry on the source catalog.

Product Availability

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

Specified by:

setDefinitionGeometryByRef in interface ICreateMosaicDatasetParameters

Parameters:

ppGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefinitionGeometry

public IGeometry getDefinitionGeometry()
                                throws IOException,
                                       AutomationException

The definition (spatial selection) geometry on the source catalog.

Product Availability

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

Specified by:

getDefinitionGeometry in interface ICreateMosaicDatasetParameters

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumVisibleCellsize

public void setMaximumVisibleCellsize(double pCellsize)
                               throws IOException,
                                      AutomationException

The cell-size value above which no mosaicking occurs.

Description

Maximum resolution above which the mosaiced rasters are displayed as rasterized wireframes in a referenced Mosaic Dataset.

Product Availability

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

Specified by:

setMaximumVisibleCellsize in interface ICreateMosaicDatasetParameters

Parameters:

pCellsize - The pCellsize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumVisibleCellsize

public double getMaximumVisibleCellsize()
                                 throws IOException,
                                        AutomationException

The cell-size value above which no mosaicking occurs.

Description

Maximum resolution above which the mosaiced rasters are displayed as rasterized wireframes in a referenced Mosaic Dataset.

Product Availability

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

Specified by:

getMaximumVisibleCellsize in interface ICreateMosaicDatasetParameters

Returns:

The pCellsize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLODInfosByRef

public void setLODInfosByRef(IMosaicLODInfos ppLODInfos)
                      throws IOException,
                             AutomationException

The levels of detail associated with the mosaic dataset.

Description

This object describes LOD (Level Of Detail) information for the Mosaic Dataset. This is used when creating a referenced Mosaic Dataset from a Military Analyst catalog.

Product Availability

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

Specified by:

setLODInfosByRef in interface ICreateMosaicDatasetParameters

Parameters:

ppLODInfos - A reference to a com.esri.arcgis.datasourcesraster.IMosaicLODInfos (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLODInfos

public IMosaicLODInfos getLODInfos()
                            throws IOException,
                                   AutomationException

The levels of detail associated with the mosaic dataset.

Description

This object describes LOD (Level Of Detail) information for the Mosaic Dataset. This is used when creating a referenced Mosaic Dataset from a Military Analyst catalog.

Product Availability

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

Specified by:

getLODInfos in interface ICreateMosaicDatasetParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPixelType

public void setPixelType(int pPixelType)
                  throws IOException,
                         AutomationException

The pixel-type of the mosaic dataset.

Description

Pixel Type of the Mosaic Dataset to be created.

Product Availability

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

Specified by:

setPixelType in interface ICreateMosaicDatasetParameters

Parameters:

pPixelType - A com.esri.arcgis.geodatabase.rstPixelType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelType

public int getPixelType()
                 throws IOException,
                        AutomationException

The pixel-type of the mosaic dataset.

Description

Pixel Type of the Mosaic Dataset to be created.

Product Availability

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

Specified by:

getPixelType in interface ICreateMosaicDatasetParameters

Returns:

A com.esri.arcgis.geodatabase.rstPixelType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBandCount

public void setBandCount(int pCount)
                  throws IOException,
                         AutomationException

The number of bands in the mosaic dataset.

Description

Number of bands of the Mosaic Dataset to be created.

Product Availability

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

Specified by:

setBandCount in interface ICreateMosaicDatasetParameters

Parameters:

pCount - The pCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBandCount

public int getBandCount()
                 throws IOException,
                        AutomationException

The number of bands in the mosaic dataset.

Description

Number of bands of the Mosaic Dataset to be created.

Product Availability

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

Specified by:

getBandCount in interface ICreateMosaicDatasetParameters

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinCellsizeFieldName

public void setMinCellsizeFieldName(String pMinCellsizeFieldName)
                             throws IOException,
                                    AutomationException

The name of the field that contains minimum visible cell-size values for items in the mosaic dataset.

Description

Field name corresponding to the minimum cell size field in the source mosaic dataset for a referenced mosaic dataset.

Product Availability

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

Specified by:

setMinCellsizeFieldName in interface ICreateMosaicDatasetParameters

Parameters:

pMinCellsizeFieldName - The pMinCellsizeFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinCellsizeFieldName

public String getMinCellsizeFieldName()
                               throws IOException,
                                      AutomationException

The name of the field that contains minimum visible cell-size values for items in the mosaic dataset.

Description

Field name corresponding to the minimum cell size field in the source mosaic dataset for a referenced mosaic dataset.

Product Availability

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

Specified by:

getMinCellsizeFieldName in interface ICreateMosaicDatasetParameters

Returns:

The pMinCellsizeFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxCellsizeFieldName

public void setMaxCellsizeFieldName(String pMaxCellsizeFieldName)
                             throws IOException,
                                    AutomationException

The name of the field that contains maximum visible cell-size values for items in the mosaic dataset.

Description

Field name corresponding to the maximum cell size field in the source mosaic dataset for a referenced mosaic dataset.

Product Availability

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

Specified by:

setMaxCellsizeFieldName in interface ICreateMosaicDatasetParameters

Parameters:

pMaxCellsizeFieldName - The pMaxCellsizeFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxCellsizeFieldName

public String getMaxCellsizeFieldName()
                               throws IOException,
                                      AutomationException

The name of the field that contains maximum visible cell-size values for items in the mosaic dataset.

Description

Field name corresponding to the maximum cell size field in the source mosaic dataset for a referenced mosaic dataset.

Product Availability

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

Specified by:

getMaxCellsizeFieldName in interface ICreateMosaicDatasetParameters

Returns:

The pMaxCellsizeFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLODFieldName

public void setLODFieldName(String pLODFieldName)
                     throws IOException,
                            AutomationException

The name of the field that contains scale values for items in the mosaic dataset.

Description

Field name that corresponds to a field in a Military Analyst catalog that describes the LOD (Level Of Detail) for each raster. This is used when creating a referenced Mosaic Dataset from a Military Analyst catalog.

Product Availability

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

Specified by:

setLODFieldName in interface ICreateMosaicDatasetParameters

Parameters:

pLODFieldName - The pLODFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLODFieldName

public String getLODFieldName()
                       throws IOException,
                              AutomationException

The name of the field that contains scale values for items in the mosaic dataset.

Description

Field name that corresponds to a field in a Military Analyst catalog that describes the LOD (Level Of Detail) for each raster. This is used when creating a referenced Mosaic Dataset from a Military Analyst catalog.

Product Availability

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

Specified by:

getLODFieldName in interface ICreateMosaicDatasetParameters

Returns:

The pLODFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefinitionFIDsByRef

public void setDefinitionFIDsByRef(IFIDSet ppFIDs)
                            throws IOException,
                                   AutomationException

The definition selection set on the source catalog.

Product Availability

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

Specified by:

setDefinitionFIDsByRef in interface ICreateMosaicDatasetParameters

Parameters:

ppFIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefinitionFIDs

public IFIDSet getDefinitionFIDs()
                          throws IOException,
                                 AutomationException

The definition selection set on the source catalog.

Product Availability

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

Specified by:

getDefinitionFIDs in interface ICreateMosaicDatasetParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemplateMosaicDatasetByRef

public void setTemplateMosaicDatasetByRef(IMosaicDataset ppMosaicDataset)
                                   throws IOException,
                                          AutomationException

The mosaic dataset from which key properties are copied over to the newly created mosaic dataset.

Product Availability

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

Specified by:

setTemplateMosaicDatasetByRef in interface ICreateMosaicDatasetParameters2

Parameters:

ppMosaicDataset - A reference to a com.esri.arcgis.datasourcesraster.IMosaicDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemplateMosaicDataset

public IMosaicDataset getTemplateMosaicDataset()
                                        throws IOException,
                                               AutomationException

The mosaic dataset from which key properties are copied over to the newly created mosaic dataset.

Product Availability

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

Specified by:

getTemplateMosaicDataset in interface ICreateMosaicDatasetParameters2

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.

setBandDefinitionKeyword

public void setBandDefinitionKeyword(String pBandDefinitionKeyword)
                              throws IOException,
                                     AutomationException

The band definition keyword to be set on the mosaic dataset.

Product Availability

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

Specified by:

setBandDefinitionKeyword in interface ICreateMosaicDatasetParameters2

Parameters:

pBandDefinitionKeyword - The pBandDefinitionKeyword (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBandDefinitionKeyword

public String getBandDefinitionKeyword()
                                throws IOException,
                                       AutomationException

The band definition keyword to be set on the mosaic dataset.

Product Availability

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

Specified by:

getBandDefinitionKeyword in interface ICreateMosaicDatasetParameters2

Returns:

The pBandDefinitionKeyword

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBandPropertiesByRef

public void setBandPropertiesByRef(IArray ppArrayOfPropertySet)
                            throws IOException,
                                   AutomationException

Key band properties to be set on the mosaic dataset.

Product Availability

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

Specified by:

setBandPropertiesByRef in interface ICreateMosaicDatasetParameters2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBandProperties

public IArray getBandProperties()
                         throws IOException,
                                AutomationException

Key band properties to be set on the mosaic dataset.

Product Availability

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

Specified by:

getBandProperties in interface ICreateMosaicDatasetParameters2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.