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, java.io.Serializable

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

COM Class 'CreateMosaicDatasetParameters'. Generated 9/21/2023 10:01:44 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'An object that controls how a mosaic dataset is created.' 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 inherited from interface com.esri.arcgis.datasourcesraster.IMosaicDatasetOperationParameters

IID, IID379006f4_6f75_4c3b_b783_0c2e88a7b280, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.ICreateMosaicDatasetParameters2

IID, IID98d47342_25e0_4fca_8a23_34d006e312ae, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.ICreateMosaicDatasetParameters

IIDbe94ffc7_98f4_48d0_8fad_c3f1834c768f

Constructor Summary

Constructors

Constructor and Description
CreateMosaicDatasetParameters() Constructs a CreateMosaicDatasetParameters using ArcGIS Engine.
CreateMosaicDatasetParameters(java.lang.Object obj) Construct a CreateMosaicDatasetParameters using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
int	getBandCount() The number of bands in the mosaic dataset.
java.lang.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 java.lang.String	getClsid() getClsid.
IFIDSet	getDefinitionFIDs() The definition selection set on the source catalog.
IGeometry	getDefinitionGeometry() The definition (spatial selection) geometry on the source catalog.
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.
java.lang.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.
java.lang.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.
java.lang.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	release() Release this COM object reference
void	setBandCount(int pCount) The number of bands in the mosaic dataset.
void	setBandDefinitionKeyword(java.lang.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(java.lang.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(java.lang.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(java.lang.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

Constructor Detail

CreateMosaicDatasetParameters

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

Constructs a CreateMosaicDatasetParameters using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

CreateMosaicDatasetParameters

public CreateMosaicDatasetParameters(java.lang.Object obj)
                              throws java.io.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:

java.io.IOException - if there are interop problems CreateMosaicDatasetParameters theCreateMosaicDatasetParameters = (CreateMosaicDatasetParameters) 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()

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

setParametersByRef

public void setParametersByRef(IPropertySet ppAllParameters)
                        throws java.io.IOException,
                               AutomationException

All parameters associated with the mosaic dataset operation.

Specified by:

setParametersByRef in interface IMosaicDatasetOperationParameters

Parameters:

ppAllParameters - 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.

getParameters

public IPropertySet getParameters()
                           throws java.io.IOException,
                                  AutomationException

All parameters associated with the mosaic dataset operation.

Specified by:

getParameters in interface IMosaicDatasetOperationParameters

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.

setProgressorByRef

public void setProgressorByRef(IProgressor ppProgressor)
                        throws java.io.IOException,
                               AutomationException

The external progressor object associated with the mosaic dataset operation.

Specified by:

setProgressorByRef in interface IMosaicDatasetOperationParameters

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProgressor

public IProgressor getProgressor()
                          throws java.io.IOException,
                                 AutomationException

The external progressor object associated with the mosaic dataset operation.

Specified by:

getProgressor in interface IMosaicDatasetOperationParameters

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsDatasetReadOnly

public void setIsDatasetReadOnly(boolean pbIsDatasetReadOnly)
                          throws java.io.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.

Specified by:

setIsDatasetReadOnly in interface IMosaicDatasetOperationParameters

Parameters:

pbIsDatasetReadOnly - The pbIsDatasetReadOnly (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDatasetReadOnly

public boolean isDatasetReadOnly()
                          throws java.io.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.

Specified by:

isDatasetReadOnly in interface IMosaicDatasetOperationParameters

Returns:

The pbIsDatasetReadOnly

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResultsByRef

public void setResultsByRef(IPropertySet ppOperationResults)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:

setResultsByRef in interface IMosaicDatasetOperationParameters

Parameters:

ppOperationResults - 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.

getResults

public IPropertySet getResults()
                        throws java.io.IOException,
                               AutomationException

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

Specified by:

getResults in interface IMosaicDatasetOperationParameters

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.

setDefinitionGeometryByRef

public void setDefinitionGeometryByRef(IGeometry ppGeometry)
                                throws java.io.IOException,
                                       AutomationException

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

Specified by:

setDefinitionGeometryByRef in interface ICreateMosaicDatasetParameters

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefinitionGeometry

public IGeometry getDefinitionGeometry()
                                throws java.io.IOException,
                                       AutomationException

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

Specified by:

getDefinitionGeometry in interface ICreateMosaicDatasetParameters

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumVisibleCellsize

public void setMaximumVisibleCellsize(double pCellsize)
                               throws java.io.IOException,
                                      AutomationException

The cell-size value above which no mosaicking occurs.

Specified by:

setMaximumVisibleCellsize in interface ICreateMosaicDatasetParameters

Parameters:

pCellsize - The pCellsize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumVisibleCellsize

public double getMaximumVisibleCellsize()
                                 throws java.io.IOException,
                                        AutomationException

The cell-size value above which no mosaicking occurs.

Specified by:

getMaximumVisibleCellsize in interface ICreateMosaicDatasetParameters

Returns:

The pCellsize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLODInfosByRef

public void setLODInfosByRef(IMosaicLODInfos ppLODInfos)
                      throws java.io.IOException,
                             AutomationException

The levels of detail associated with the mosaic dataset.

Specified by:

setLODInfosByRef in interface ICreateMosaicDatasetParameters

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLODInfos

public IMosaicLODInfos getLODInfos()
                            throws java.io.IOException,
                                   AutomationException

The levels of detail associated with the mosaic dataset.

Specified by:

getLODInfos in interface ICreateMosaicDatasetParameters

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPixelType

public void setPixelType(int pPixelType)
                  throws java.io.IOException,
                         AutomationException

The pixel-type of the mosaic dataset.

Specified by:

setPixelType in interface ICreateMosaicDatasetParameters

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelType

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

The pixel-type of the mosaic dataset.

Specified by:

getPixelType in interface ICreateMosaicDatasetParameters

Returns:

A com.esri.arcgis.geodatabase.rstPixelType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBandCount

public void setBandCount(int pCount)
                  throws java.io.IOException,
                         AutomationException

The number of bands in the mosaic dataset.

Specified by:

setBandCount in interface ICreateMosaicDatasetParameters

Parameters:

pCount - The pCount (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBandCount

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

The number of bands in the mosaic dataset.

Specified by:

getBandCount in interface ICreateMosaicDatasetParameters

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinCellsizeFieldName

public void setMinCellsizeFieldName(java.lang.String pMinCellsizeFieldName)
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:

setMinCellsizeFieldName in interface ICreateMosaicDatasetParameters

Parameters:

pMinCellsizeFieldName - The pMinCellsizeFieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinCellsizeFieldName

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

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

Specified by:

getMinCellsizeFieldName in interface ICreateMosaicDatasetParameters

Returns:

The pMinCellsizeFieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxCellsizeFieldName

public void setMaxCellsizeFieldName(java.lang.String pMaxCellsizeFieldName)
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:

setMaxCellsizeFieldName in interface ICreateMosaicDatasetParameters

Parameters:

pMaxCellsizeFieldName - The pMaxCellsizeFieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxCellsizeFieldName

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

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

Specified by:

getMaxCellsizeFieldName in interface ICreateMosaicDatasetParameters

Returns:

The pMaxCellsizeFieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLODFieldName

public void setLODFieldName(java.lang.String pLODFieldName)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:

setLODFieldName in interface ICreateMosaicDatasetParameters

Parameters:

pLODFieldName - The pLODFieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLODFieldName

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

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

Specified by:

getLODFieldName in interface ICreateMosaicDatasetParameters

Returns:

The pLODFieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefinitionFIDsByRef

public void setDefinitionFIDsByRef(IFIDSet ppFIDs)
                            throws java.io.IOException,
                                   AutomationException

The definition selection set on the source catalog.

Specified by:

setDefinitionFIDsByRef in interface ICreateMosaicDatasetParameters

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefinitionFIDs

public IFIDSet getDefinitionFIDs()
                          throws java.io.IOException,
                                 AutomationException

The definition selection set on the source catalog.

Specified by:

getDefinitionFIDs in interface ICreateMosaicDatasetParameters

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTemplateMosaicDatasetByRef

public void setTemplateMosaicDatasetByRef(IMosaicDataset ppMosaicDataset)
                                   throws java.io.IOException,
                                          AutomationException

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

Specified by:

setTemplateMosaicDatasetByRef in interface ICreateMosaicDatasetParameters2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTemplateMosaicDataset

public IMosaicDataset getTemplateMosaicDataset()
                                        throws java.io.IOException,
                                               AutomationException

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

Specified by:

getTemplateMosaicDataset in interface ICreateMosaicDatasetParameters2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBandDefinitionKeyword

public void setBandDefinitionKeyword(java.lang.String pBandDefinitionKeyword)
                              throws java.io.IOException,
                                     AutomationException

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

Specified by:

setBandDefinitionKeyword in interface ICreateMosaicDatasetParameters2

Parameters:

pBandDefinitionKeyword - The pBandDefinitionKeyword (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBandDefinitionKeyword

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

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

Specified by:

getBandDefinitionKeyword in interface ICreateMosaicDatasetParameters2

Returns:

The pBandDefinitionKeyword

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBandPropertiesByRef

public void setBandPropertiesByRef(IArray ppArrayOfPropertySet)
                            throws java.io.IOException,
                                   AutomationException

Key band properties to be set on the mosaic dataset.

Specified by:

setBandPropertiesByRef in interface ICreateMosaicDatasetParameters2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBandProperties

public IArray getBandProperties()
                         throws java.io.IOException,
                                AutomationException

Key band properties to be set on the mosaic dataset.

Specified by:

getBandProperties in interface ICreateMosaicDatasetParameters2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.