com.esri.arcgis.datasourcesraster
Class DefineNoDataParameters

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.DefineNoDataParameters
All Implemented Interfaces:
IDefineNoDataParameters, IMosaicDatasetOperationParameters, ISelectionParameters, com.esri.arcgis.interop.RemoteObjRef, Serializable

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

An object that controls how NoData values are defined for items in a mosaic dataset.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
DefineNoDataParameters()
          Constructs a DefineNoDataParameters using ArcGIS Engine.
DefineNoDataParameters(Object obj)
          Construct a DefineNoDataParameters using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 IDoubleArray getIncludedRanges()
          The included value ranges, i.e.
 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 setIncludedRangesByRef(IDoubleArray ppRanges)
          The included value ranges, i.e.
 void setIsDatasetReadOnly(boolean pbIsDatasetReadOnly)
          Indicates whether the mosaic dataset is in read-only mode.
 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
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

DefineNoDataParameters

public DefineNoDataParameters()
                       throws IOException,
                              UnknownHostException
Constructs a DefineNoDataParameters using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

DefineNoDataParameters

public DefineNoDataParameters(Object obj)
                       throws 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:
IOException - if there are interop problems DefineNoDataParameters theDefineNoDataParameters = (DefineNoDataParameters) 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.

getIncludedRanges

public IDoubleArray getIncludedRanges()
                               throws IOException,
                                      AutomationException
The included value ranges, i.e. [min, max] for each band.

Product Availability

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

Specified by:
getIncludedRanges in interface IDefineNoDataParameters
Returns:
A reference to a com.esri.arcgis.system.IDoubleArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIncludedRangesByRef

public void setIncludedRangesByRef(IDoubleArray ppRanges)
                            throws IOException,
                                   AutomationException
The included value ranges, i.e. [min, max] for each band.

Product Availability

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

Specified by:
setIncludedRangesByRef in interface IDefineNoDataParameters
Parameters:
ppRanges - A reference to a com.esri.arcgis.system.IDoubleArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNoDataValues

public IStringArray getNoDataValues()
                             throws IOException,
                                    AutomationException
The list of, space separated, NoData values, for each band.

Product Availability

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

Specified by:
getNoDataValues in interface IDefineNoDataParameters
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.

setNoDataValuesByRef

public void setNoDataValuesByRef(IStringArray ppValues)
                          throws IOException,
                                 AutomationException
The list of, space separated, NoData values, for each band.

Product Availability

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

Specified by:
setNoDataValuesByRef in interface IDefineNoDataParameters
Parameters:
ppValues - 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.

setSelectionSetByRef

public void setSelectionSetByRef(ISelectionSet ppSelectionSet)
                          throws IOException,
                                 AutomationException
The selection set that identifies the collection of catalog items on which to perform the associated operation.

Product Availability

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

Specified by:
setSelectionSetByRef in interface ISelectionParameters
Parameters:
ppSelectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectionSet

public ISelectionSet getSelectionSet()
                              throws IOException,
                                     AutomationException
The selection set that identifies the collection of catalog items on which to perform the associated operation.

Product Availability

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

Specified by:
getSelectionSet in interface ISelectionParameters
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setQueryFilterByRef

public void setQueryFilterByRef(IQueryFilter ppQueryFilter)
                         throws 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.

Product Availability

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

Specified by:
setQueryFilterByRef in interface ISelectionParameters
Parameters:
ppQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getQueryFilter

public IQueryFilter getQueryFilter()
                            throws 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.

Product Availability

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

Specified by:
getQueryFilter in interface ISelectionParameters
Returns:
A reference to a com.esri.arcgis.geodatabase.IQueryFilter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.