com.esri.arcgis.datasourcesraster
Class EstimateStatisticsParameters

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

All Implemented Interfaces:

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

public class EstimateStatisticsParameters
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicDatasetOperationParameters, IEstimateStatisticsParameters, ISelectionParameters

COM Class 'EstimateStatisticsParameters'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description 'An object that controls how raster statistics of a mosaic dataset are estimated.' 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.IEstimateStatisticsParameters

IID, IIDb7bd9b36_4f05_457b_999f_706ede360654, xxDummy

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

IID, IID95627b93_1275_4714_94a7_a55df27e70a2, xxDummy

Constructor Summary

EstimateStatisticsParameters()
Constructs a EstimateStatisticsParameters using ArcGIS Engine.

EstimateStatisticsParameters(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EstimateStatisticsParameters theEstimateStatisticsParameters = (EstimateStatisticsParameters) obj;

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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	isComputeItemStatisticsIfMissing() Indicates whether statistics of selected mosaic dataset items are computed if missing.
boolean	isDatasetReadOnly() Indicates whether the mosaic dataset is in read-only mode.
boolean	isMergeExistingStatistics() Indicates whether existing mosaic dataset statistics are used towards computation of the aggregate statistics.
boolean	isUpdateMosaicDataset() Indicates whether the mosaic dataset is updated with the aggregate statistics.
void	release() Release a EstimateStatisticsParameters.
void	setComputeItemStatisticsIfMissing(boolean pbComputeItemStatisticsIfMissing) Indicates whether statistics of selected mosaic dataset items are computed if missing.
void	setIsDatasetReadOnly(boolean pbIsDatasetReadOnly) Indicates whether the mosaic dataset is in read-only mode.
void	setMergeExistingStatistics(boolean pbMergeExistingStatistics) Indicates whether existing mosaic dataset statistics are used towards computation of the aggregate statistics.
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.
void	setUpdateMosaicDataset(boolean pbUpdateMosaicDataset) Indicates whether the mosaic dataset is updated with the aggregate statistics.

Methods inherited from class java.lang.Object

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

Constructor Detail

EstimateStatisticsParameters

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

Constructs a EstimateStatisticsParameters using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

EstimateStatisticsParameters

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

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

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()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a EstimateStatisticsParameters.

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.

setMergeExistingStatistics

public void setMergeExistingStatistics(boolean pbMergeExistingStatistics)
                                throws java.io.IOException,
                                       AutomationException

Indicates whether existing mosaic dataset statistics are used towards computation of the aggregate statistics.

Specified by:

setMergeExistingStatistics in interface IEstimateStatisticsParameters

Parameters:

pbMergeExistingStatistics - The pbMergeExistingStatistics (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isMergeExistingStatistics

public boolean isMergeExistingStatistics()
                                  throws java.io.IOException,
                                         AutomationException

Indicates whether existing mosaic dataset statistics are used towards computation of the aggregate statistics.

Specified by:

isMergeExistingStatistics in interface IEstimateStatisticsParameters

Returns:

The pbMergeExistingStatistics

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setComputeItemStatisticsIfMissing

public void setComputeItemStatisticsIfMissing(boolean pbComputeItemStatisticsIfMissing)
                                       throws java.io.IOException,
                                              AutomationException

Indicates whether statistics of selected mosaic dataset items are computed if missing. If set to FALSE, items without statistics are skipped and excluded from the aggregate.

Specified by:

setComputeItemStatisticsIfMissing in interface IEstimateStatisticsParameters

Parameters:

pbComputeItemStatisticsIfMissing - The pbComputeItemStatisticsIfMissing (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isComputeItemStatisticsIfMissing

public boolean isComputeItemStatisticsIfMissing()
                                         throws java.io.IOException,
                                                AutomationException

Indicates whether statistics of selected mosaic dataset items are computed if missing. If set to FALSE, items without statistics are skipped and excluded from the aggregate.

Specified by:

isComputeItemStatisticsIfMissing in interface IEstimateStatisticsParameters

Returns:

The pbComputeItemStatisticsIfMissing

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUpdateMosaicDataset

public void setUpdateMosaicDataset(boolean pbUpdateMosaicDataset)
                            throws java.io.IOException,
                                   AutomationException

Indicates whether the mosaic dataset is updated with the aggregate statistics.

Specified by:

setUpdateMosaicDataset in interface IEstimateStatisticsParameters

Parameters:

pbUpdateMosaicDataset - The pbUpdateMosaicDataset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUpdateMosaicDataset

public boolean isUpdateMosaicDataset()
                              throws java.io.IOException,
                                     AutomationException

Indicates whether the mosaic dataset is updated with the aggregate statistics.

Specified by:

isUpdateMosaicDataset in interface IEstimateStatisticsParameters

Returns:

The pbUpdateMosaicDataset

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.