com.esri.arcgis.datasourcesraster

Class DefineNoDataParameters

java.lang.Object

com.esri.arcgis.datasourcesraster.DefineNoDataParameters

All Implemented Interfaces:

IDefineNoDataParameters, IDefineNoDataParameters2, IMosaicDatasetOperationParameters, ISelectionParameters, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class DefineNoDataParameters
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicDatasetOperationParameters, IDefineNoDataParameters, IDefineNoDataParameters2, ISelectionParameters

COM Class 'DefineNoDataParameters'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'An object that controls how NoData values are defined for items in a mosaic dataset.' 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.IDefineNoDataParameters2

IID, IID46e8419e_07ab_40cc_8a5d_8566f8c8918d, xxDummy

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

IID9cfc869f_0be0_485c_9e5a_9d4bdea0cc4f

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

IID, IID95627b93_1275_4714_94a7_a55df27e70a2, xxDummy

Constructor Summary

Constructors

Constructor and Description
DefineNoDataParameters() Constructs a DefineNoDataParameters using ArcGIS Engine.
DefineNoDataParameters(java.lang.Object obj) Construct a DefineNoDataParameters 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
static java.lang.String	getClsid() getClsid.
IDoubleArray	getIncludedRanges() The included value ranges, i.e.
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.
int	getNoDataInterpretation() Defines how the NoData values should be interpreted.
IStringArray	getNoDataValues() The list of, space separated, NoData values, for each band.
IPropertySet	getParameters() All parameters associated with the mosaic dataset operation.
IProgressor	getProgressor() The external progressor object associated with the mosaic dataset operation.
IQueryFilter	getQueryFilter() The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation.
IPropertySet	getResults() The properties of the result associated with the mosaic dataset operation.
ISelectionSet	getSelectionSet() The selection set that identifies the collection of catalog items on which to perform the associated operation.
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	setIncludedRangesByRef(IDoubleArray ppRanges) The included value ranges, i.e.
void	setIsDatasetReadOnly(boolean pbIsDatasetReadOnly) Indicates whether the mosaic dataset is in read-only mode.
void	setNoDataInterpretation(int pNoDataInterpretation) Defines how the NoData values should be interpreted.
void	setNoDataValuesByRef(IStringArray ppValues) The list of, space separated, NoData values, for each band.
void	setParametersByRef(IPropertySet ppAllParameters) All parameters associated with the mosaic dataset operation.
void	setProgressorByRef(IProgressor ppProgressor) The external progressor object associated with the mosaic dataset operation.
void	setQueryFilterByRef(IQueryFilter ppQueryFilter) The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation.
void	setResultsByRef(IPropertySet ppOperationResults) The properties of the result associated with the mosaic dataset operation.
void	setSelectionSetByRef(ISelectionSet ppSelectionSet) The selection set that identifies the collection of catalog items on which to perform the associated operation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefineNoDataParameters

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

Constructs a DefineNoDataParameters using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

DefineNoDataParameters

public DefineNoDataParameters(java.lang.Object obj)
                       throws java.io.IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

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

getIncludedRanges

public IDoubleArray getIncludedRanges()
                               throws java.io.IOException,
                                      AutomationException

The included value ranges, i.e. [min, max] for each band.

Specified by:

getIncludedRanges in interface IDefineNoDataParameters

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIncludedRangesByRef

public void setIncludedRangesByRef(IDoubleArray ppRanges)
                            throws java.io.IOException,
                                   AutomationException

The included value ranges, i.e. [min, max] for each band.

Specified by:

setIncludedRangesByRef in interface IDefineNoDataParameters

Parameters:

ppRanges - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNoDataValues

public IStringArray getNoDataValues()
                             throws java.io.IOException,
                                    AutomationException

The list of, space separated, NoData values, for each band.

Specified by:

getNoDataValues in interface IDefineNoDataParameters

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNoDataValuesByRef

public void setNoDataValuesByRef(IStringArray ppValues)
                          throws java.io.IOException,
                                 AutomationException

The list of, space separated, NoData values, for each band.

Specified by:

setNoDataValuesByRef in interface IDefineNoDataParameters

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNoDataInterpretation

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

Defines how the NoData values should be interpreted.

Specified by:

getNoDataInterpretation in interface IDefineNoDataParameters2

Returns:

A com.esri.arcgis.datasourcesraster.esriNoDataInterpretation constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNoDataInterpretation

public void setNoDataInterpretation(int pNoDataInterpretation)
                             throws java.io.IOException,
                                    AutomationException

Defines how the NoData values should be interpreted.

Specified by:

setNoDataInterpretation in interface IDefineNoDataParameters2

Parameters:

pNoDataInterpretation - A com.esri.arcgis.datasourcesraster.esriNoDataInterpretation constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSelectionSetByRef

public void setSelectionSetByRef(ISelectionSet ppSelectionSet)
                          throws java.io.IOException,
                                 AutomationException

The selection set that identifies the collection of catalog items on which to perform the associated operation.

Specified by:

setSelectionSetByRef in interface ISelectionParameters

Parameters:

ppSelectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectionSet

public ISelectionSet getSelectionSet()
                              throws java.io.IOException,
                                     AutomationException

The selection set that identifies the collection of catalog items on which to perform the associated operation.

Specified by:

getSelectionSet in interface ISelectionParameters

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setQueryFilterByRef

public void setQueryFilterByRef(IQueryFilter ppQueryFilter)
                         throws java.io.IOException,
                                AutomationException

The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation. If no selection is specified, the query filter is applied on the entire catalog.

Specified by:

setQueryFilterByRef in interface ISelectionParameters

Parameters:

ppQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getQueryFilter

public IQueryFilter getQueryFilter()
                            throws java.io.IOException,
                                   AutomationException

The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation. If no selection is specified, the query filter is applied on the entire catalog.

Specified by:

getQueryFilter in interface ISelectionParameters

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.