com.esri.arcgis.datasourcesraster
Class ExportItemsParameters

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

All Implemented Interfaces:

IBuildPyramidsParameters, IBuildPyramidsParameters2, ICalculateStatisticsParameters, IExportItemsParameters, IMosaicDatasetOperationParameters, ISelectionParameters, IThreadedOperationParameters, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class ExportItemsParameters
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicDatasetOperationParameters, IExportItemsParameters, IBuildPyramidsParameters, IBuildPyramidsParameters2, ICalculateStatisticsParameters, ISelectionParameters, IThreadedOperationParameters

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

Description 'An object that controls how items in a mosaic dataset are exported.' 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.IExportItemsParameters

IID, IIDdb45460e_82a8_426f_90fe_67a8454101ef, xxDummy

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

IID, IIDa4a2e058_841d_43fc_a6b6_0783e5473a84, xxDummy

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

IID, IIDd686e327_7f25_4840_bd11_a91a072c7044, xxDummy

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

ExportItemsParameters()
Constructs a ExportItemsParameters using ArcGIS Engine.

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

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getBaseName() The basename.
IPoint	getCellSize() The cellsize.
IGeometry	getClippingGeometry() The clipping geometry.
static java.lang.String	getClsid() getClsid.
int	getCompressionQuality() The pyramid compression quality.
int	getCompressionType() The pyramid compression type.
IEnvelope	getExtent() The extent.
java.lang.String	getFormat() The output format.
java.lang.Object	getIgnoreValues() The ignore values for statistics.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getNoData() The nodata.
int	getNumThreads() The number of parallel threads that execute parts of the associated operation.
java.lang.String	getOutputFolder() The output folder.
IPropertySet	getParameters() All parameters associated with the mosaic dataset operation.
IProgressor	getProgressor() The external progressor object associated with the mosaic dataset operation.
int	getPyramidLevel() The number of pyramid levels.
int	getPyramidResampleType() The method used for pyramid resampling.
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.
int	getResamplingType() The resampling type.
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.
IRaster	getSnapRaster() The reference raster whose bottom-left corner (XMin, YMin) is used for snapping the output raster's bottom-left corner.
ISpatialReference	getSpatialRef() The spatial reference.
IRasterStorageDef	getStorageDef() The storagedef.
int	getXSkipFactor() The X skip factor for statistics.
int	getYSkipFactor() The Y skip factor for statistics.
int	hashCode() the hashcode for this object
boolean	isBuildPyramids() Indicates whether pyramids are built for each raster dataset associated with each selected catalog item.
boolean	isComputeStatistics() Indicates whether histogram statistics are computed for each raster dataset associated with each selected catalog item.
boolean	isDatasetReadOnly() Indicates whether the mosaic dataset is in read-only mode.
boolean	isSkipFirstLevel() Indicates whether pyramids are built with the first level skipped.
void	release() Release a ExportItemsParameters.
void	setBaseName(java.lang.String pName) The basename.
void	setBuildPyramids(boolean pbBuildPyramids) Indicates whether pyramids are built for each raster dataset associated with each selected catalog item.
void	setCellSizeByRef(IPoint ppCellsize) The cellsize.
void	setClippingGeometryByRef(IGeometry ppGeometry) The clipping geometry.
void	setCompressionQuality(int value) The pyramid compression quality.
void	setCompressionType(int pType) The pyramid compression type.
void	setComputeStatistics(boolean pbComputeStatistics) Indicates whether histogram statistics are computed for each raster dataset associated with each selected catalog item.
void	setExtentByRef(IEnvelope ppExtent) The extent.
void	setFormat(java.lang.String pFormat) The output format.
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	setNoData(java.lang.String pNodata) The nodata.
void	setNumThreads(int pNumThreads) The number of parallel threads that execute parts of the associated operation.
void	setOutputFolder(java.lang.String pFolder) The output folder.
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	setPyramidLevel(int pLevel) The number of pyramid levels.
void	setPyramidResampleType(int pMethod) The method used for pyramid resampling.
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	setResamplingType(int pType) The resampling type.
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	setSkipFirstLevel(boolean pbSkipFirstLevel) Indicates whether pyramids are built with the first level skipped.
void	setSnapRasterByRef(IRaster ppRaster) The reference raster whose bottom-left corner (XMin, YMin) is used for snapping the output raster's bottom-left corner.
void	setSpatialRefByRef(ISpatialReference ppSR) The spatial reference.
void	setStorageDefByRef(IRasterStorageDef ppDef) The storagedef.
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

ExportItemsParameters

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

Constructs a ExportItemsParameters using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ExportItemsParameters

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

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

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

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

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.

setOutputFolder

public void setOutputFolder(java.lang.String pFolder)
                     throws java.io.IOException,
                            AutomationException

The output folder.

Specified by:

setOutputFolder in interface IExportItemsParameters

Parameters:

pFolder - The pFolder (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputFolder

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

The output folder.

Specified by:

getOutputFolder in interface IExportItemsParameters

Returns:

The pFolder

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFormat

public void setFormat(java.lang.String pFormat)
               throws java.io.IOException,
                      AutomationException

The output format.

Specified by:

setFormat in interface IExportItemsParameters

Parameters:

pFormat - The pFormat (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFormat

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

The output format.

Specified by:

getFormat in interface IExportItemsParameters

Returns:

The pFormat

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBaseName

public void setBaseName(java.lang.String pName)
                 throws java.io.IOException,
                        AutomationException

The basename.

Specified by:

setBaseName in interface IExportItemsParameters

Parameters:

pName - The pName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBaseName

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

The basename.

Specified by:

getBaseName in interface IExportItemsParameters

Returns:

The pName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialRefByRef

public void setSpatialRefByRef(ISpatialReference ppSR)
                        throws java.io.IOException,
                               AutomationException

The spatial reference.

Specified by:

setSpatialRefByRef in interface IExportItemsParameters

Parameters:

ppSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpatialRef

public ISpatialReference getSpatialRef()
                                throws java.io.IOException,
                                       AutomationException

The spatial reference.

Specified by:

getSpatialRef in interface IExportItemsParameters

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStorageDefByRef

public void setStorageDefByRef(IRasterStorageDef ppDef)
                        throws java.io.IOException,
                               AutomationException

The storagedef.

Specified by:

setStorageDefByRef in interface IExportItemsParameters

Parameters:

ppDef - A reference to a com.esri.arcgis.geodatabase.IRasterStorageDef (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStorageDef

public IRasterStorageDef getStorageDef()
                                throws java.io.IOException,
                                       AutomationException

The storagedef.

Specified by:

getStorageDef in interface IExportItemsParameters

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResamplingType

public void setResamplingType(int pType)
                       throws java.io.IOException,
                              AutomationException

The resampling type.

Specified by:

setResamplingType in interface IExportItemsParameters

Parameters:

pType - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResamplingType

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

The resampling type.

Specified by:

getResamplingType in interface IExportItemsParameters

Returns:

A com.esri.arcgis.geodatabase.rstResamplingTypes constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExtentByRef

public void setExtentByRef(IEnvelope ppExtent)
                    throws java.io.IOException,
                           AutomationException

The extent.

Specified by:

setExtentByRef in interface IExportItemsParameters

Parameters:

ppExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

The extent.

Specified by:

getExtent in interface IExportItemsParameters

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setClippingGeometryByRef

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

The clipping geometry.

Specified by:

setClippingGeometryByRef in interface IExportItemsParameters

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.

getClippingGeometry

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

The clipping geometry.

Specified by:

getClippingGeometry in interface IExportItemsParameters

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.

setCellSizeByRef

public void setCellSizeByRef(IPoint ppCellsize)
                      throws java.io.IOException,
                             AutomationException

The cellsize.

Specified by:

setCellSizeByRef in interface IExportItemsParameters

Parameters:

ppCellsize - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCellSize

public IPoint getCellSize()
                   throws java.io.IOException,
                          AutomationException

The cellsize.

Specified by:

getCellSize in interface IExportItemsParameters

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNoData

public void setNoData(java.lang.String pNodata)
               throws java.io.IOException,
                      AutomationException

The nodata.

Specified by:

setNoData in interface IExportItemsParameters

Parameters:

pNodata - The pNodata (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNoData

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

The nodata.

Specified by:

getNoData in interface IExportItemsParameters

Returns:

The pNodata

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 each raster dataset associated with each selected catalog item.

Specified by:

setComputeStatistics in interface IExportItemsParameters

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 each raster dataset associated with each selected catalog item.

Specified by:

isComputeStatistics in interface IExportItemsParameters

Returns:

The pbComputeStatistics

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBuildPyramids

public void setBuildPyramids(boolean pbBuildPyramids)
                      throws java.io.IOException,
                             AutomationException

Indicates whether pyramids are built for each raster dataset associated with each selected catalog item.

Specified by:

setBuildPyramids in interface IExportItemsParameters

Parameters:

pbBuildPyramids - The pbBuildPyramids (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isBuildPyramids

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

Indicates whether pyramids are built for each raster dataset associated with each selected catalog item.

Specified by:

isBuildPyramids in interface IExportItemsParameters

Returns:

The pbBuildPyramids

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSnapRasterByRef

public void setSnapRasterByRef(IRaster ppRaster)
                        throws java.io.IOException,
                               AutomationException

The reference raster whose bottom-left corner (XMin, YMin) is used for snapping the output raster's bottom-left corner.

Specified by:

setSnapRasterByRef in interface IExportItemsParameters

Parameters:

ppRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSnapRaster

public IRaster getSnapRaster()
                      throws java.io.IOException,
                             AutomationException

The reference raster whose bottom-left corner (XMin, YMin) is used for snapping the output raster's bottom-left corner.

Specified by:

getSnapRaster in interface IExportItemsParameters

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPyramidResampleType

public void setPyramidResampleType(int pMethod)
                            throws java.io.IOException,
                                   AutomationException

The method used for pyramid resampling.

Specified by:

setPyramidResampleType in interface IBuildPyramidsParameters

Parameters:

pMethod - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPyramidResampleType

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

The method used for pyramid resampling.

Specified by:

getPyramidResampleType in interface IBuildPyramidsParameters

Returns:

A com.esri.arcgis.geodatabase.rstResamplingTypes constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPyramidLevel

public void setPyramidLevel(int pLevel)
                     throws java.io.IOException,
                            AutomationException

The number of pyramid levels.

Specified by:

setPyramidLevel in interface IBuildPyramidsParameters

Parameters:

pLevel - The pLevel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPyramidLevel

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

The number of pyramid levels.

Specified by:

getPyramidLevel in interface IBuildPyramidsParameters

Returns:

The pLevel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCompressionType

public void setCompressionType(int pType)
                        throws java.io.IOException,
                               AutomationException

The pyramid compression type.

Specified by:

setCompressionType in interface IBuildPyramidsParameters

Parameters:

pType - A com.esri.arcgis.geodatabase.esriRasterCompressionType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCompressionType

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

The pyramid compression type.

Specified by:

getCompressionType in interface IBuildPyramidsParameters

Returns:

A com.esri.arcgis.geodatabase.esriRasterCompressionType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCompressionQuality

public void setCompressionQuality(int value)
                           throws java.io.IOException,
                                  AutomationException

The pyramid compression quality.

Specified by:

setCompressionQuality in interface IBuildPyramidsParameters

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCompressionQuality

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

The pyramid compression quality.

Specified by:

getCompressionQuality in interface IBuildPyramidsParameters

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSkipFirstLevel

public void setSkipFirstLevel(boolean pbSkipFirstLevel)
                       throws java.io.IOException,
                              AutomationException

Indicates whether pyramids are built with the first level skipped.

Specified by:

setSkipFirstLevel in interface IBuildPyramidsParameters2

Parameters:

pbSkipFirstLevel - The pbSkipFirstLevel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSkipFirstLevel

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

Indicates whether pyramids are built with the first level skipped.

Specified by:

isSkipFirstLevel in interface IBuildPyramidsParameters2

Returns:

The pbSkipFirstLevel

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.