com.esri.arcgis.datasourcesraster
Class GenerateOverviewsParameters

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

All Implemented Interfaces:

ICalculateStatisticsParameters, IGenerateOverviewsParameters, IGenerateOverviewsParameters2, IMosaicDatasetOperationParameters, ISelectionParameters, IThreadedOperationParameters, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class GenerateOverviewsParameters
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicDatasetOperationParameters, IGenerateOverviewsParameters, IGenerateOverviewsParameters2, ICalculateStatisticsParameters, ISelectionParameters, IThreadedOperationParameters

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

Description 'An object that controls how a mosaic dataset's overview images are generated.' 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.IGenerateOverviewsParameters2

IID, IID76253922_1edf_4e4d_9ec9_2ffadf75ebfb, xxDummy

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

IIDd1bcace5_6733_46aa_9680_add4d97a5e73

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

IID, IIDce8ed17c_1c4d_4eec_8259_77b784cd8de9, xxDummy

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

IID, IID95627b93_1275_4714_94a7_a55df27e70a2, xxDummy

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

IID, IIDb4a72532_b2fd_41ee_9216_2fa2921af897, xxDummy

Constructor Summary

GenerateOverviewsParameters()
Constructs a GenerateOverviewsParameters using ArcGIS Engine.

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

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
java.lang.Object	getIgnoreValues() The ignore values for statistics.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getNumThreads() The number of parallel threads that execute parts of the associated operation.
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.
void	getRecommendedNumThreads(int[] pRecommendedNumThreads) The number of parallel threads of execution recommended by the system.
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.
java.lang.String	getServerName() The URL to the server object name where parts of the operation may be remotely executed.
int	getXSkipFactor() The X skip factor for statistics.
int	getYSkipFactor() The Y skip factor for statistics.
int	hashCode() the hashcode for this object
boolean	isComputeStatistics() Indicates whether histogram statistics are computed for the mosaic dataset, if they are missing, upon successful completion of the overview generation process.
boolean	isDatasetReadOnly() Indicates whether the mosaic dataset is in read-only mode.
boolean	isGenerateMissingImages() Indicates whether missing overview images are generated.
boolean	isGenerateStaleImages() Indicates whether overview images for stale items are rengenerated.
void	release() Release a GenerateOverviewsParameters.
void	setComputeStatistics(boolean pbComputeStatistics) Indicates whether histogram statistics are computed for the mosaic dataset, if they are missing, upon successful completion of the overview generation process.
void	setGenerateMissingImages(boolean pbGenerateMissingImages) Indicates whether missing overview images are generated.
void	setGenerateStaleImages(boolean pbGenerateStaleImages) Indicates whether overview images for stale items are rengenerated.
void	setIgnoreValues(java.lang.Object vIgnoreValues) The ignore values for statistics.
void	setIsDatasetReadOnly(boolean pbIsDatasetReadOnly) Indicates whether the mosaic dataset is in read-only mode.
void	setNumThreads(int pNumThreads) The number of parallel threads that execute parts of the associated operation.
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	setServerName(java.lang.String pServerUrl) The URL to the server object name where parts of the operation may be remotely executed.
void	setXSkipFactor(int xSkipFactor) The X skip factor for statistics.
void	setYSkipFactor(int ySkipFactor) The Y skip factor for statistics.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerateOverviewsParameters

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

Constructs a GenerateOverviewsParameters using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GenerateOverviewsParameters

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

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

Deprecated. Internal use only.

Specified by:

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

release

public void release()

Release a GenerateOverviewsParameters.

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.

setGenerateMissingImages

public void setGenerateMissingImages(boolean pbGenerateMissingImages)
                              throws java.io.IOException,
                                     AutomationException

Indicates whether missing overview images are generated.

Specified by:

setGenerateMissingImages in interface IGenerateOverviewsParameters

Parameters:

pbGenerateMissingImages - The pbGenerateMissingImages (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isGenerateMissingImages

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

Indicates whether missing overview images are generated.

Specified by:

isGenerateMissingImages in interface IGenerateOverviewsParameters

Returns:

The pbGenerateMissingImages

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGenerateStaleImages

public void setGenerateStaleImages(boolean pbGenerateStaleImages)
                            throws java.io.IOException,
                                   AutomationException

Indicates whether overview images for stale items are rengenerated.

Specified by:

setGenerateStaleImages in interface IGenerateOverviewsParameters

Parameters:

pbGenerateStaleImages - The pbGenerateStaleImages (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isGenerateStaleImages

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

Indicates whether overview images for stale items are rengenerated.

Specified by:

isGenerateStaleImages in interface IGenerateOverviewsParameters

Returns:

The pbGenerateStaleImages

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setComputeStatistics

public void setComputeStatistics(boolean pbComputeStatistics)
                          throws java.io.IOException,
                                 AutomationException

Indicates whether histogram statistics are computed for the mosaic dataset, if they are missing, upon successful completion of the overview generation process.

Specified by:

setComputeStatistics in interface IGenerateOverviewsParameters2

Parameters:

pbComputeStatistics - The pbComputeStatistics (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isComputeStatistics

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

Indicates whether histogram statistics are computed for the mosaic dataset, if they are missing, upon successful completion of the overview generation process.

Specified by:

isComputeStatistics in interface IGenerateOverviewsParameters2

Returns:

The pbComputeStatistics

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getXSkipFactor

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

The X skip factor for statistics.

Specified by:

getXSkipFactor in interface ICalculateStatisticsParameters

Returns:

The xSkipFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setXSkipFactor

public void setXSkipFactor(int xSkipFactor)
                    throws java.io.IOException,
                           AutomationException

The X skip factor for statistics.

Specified by:

setXSkipFactor in interface ICalculateStatisticsParameters

Parameters:

xSkipFactor - The xSkipFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getYSkipFactor

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

The Y skip factor for statistics.

Specified by:

getYSkipFactor in interface ICalculateStatisticsParameters

Returns:

The ySkipFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setYSkipFactor

public void setYSkipFactor(int ySkipFactor)
                    throws java.io.IOException,
                           AutomationException

The Y skip factor for statistics.

Specified by:

setYSkipFactor in interface ICalculateStatisticsParameters

Parameters:

ySkipFactor - The ySkipFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIgnoreValues

public java.lang.Object getIgnoreValues()
                                 throws java.io.IOException,
                                        AutomationException

The ignore values for statistics.

Specified by:

getIgnoreValues in interface ICalculateStatisticsParameters

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIgnoreValues

public void setIgnoreValues(java.lang.Object vIgnoreValues)
                     throws java.io.IOException,
                            AutomationException

The ignore values for statistics.

Specified by:

setIgnoreValues in interface ICalculateStatisticsParameters

Parameters:

vIgnoreValues - A Variant (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.

setServerName

public void setServerName(java.lang.String pServerUrl)
                   throws java.io.IOException,
                          AutomationException

The URL to the server object name where parts of the operation may be remotely executed.

Specified by:

setServerName in interface IThreadedOperationParameters

Parameters:

pServerUrl - The pServerUrl (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerName

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

The URL to the server object name where parts of the operation may be remotely executed.

Specified by:

getServerName in interface IThreadedOperationParameters

Returns:

The pServerUrl

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNumThreads

public void setNumThreads(int pNumThreads)
                   throws java.io.IOException,
                          AutomationException

The number of parallel threads that execute parts of the associated operation.

Specified by:

setNumThreads in interface IThreadedOperationParameters

Parameters:

pNumThreads - The pNumThreads (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNumThreads

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

The number of parallel threads that execute parts of the associated operation.

Specified by:

getNumThreads in interface IThreadedOperationParameters

Returns:

The pNumThreads

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRecommendedNumThreads

public void getRecommendedNumThreads(int[] pRecommendedNumThreads)
                              throws java.io.IOException,
                                     AutomationException

The number of parallel threads of execution recommended by the system.

Specified by:

getRecommendedNumThreads in interface IThreadedOperationParameters

Parameters:

pRecommendedNumThreads - The pRecommendedNumThreads (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.