com.esri.arcgis.carto
Interface IRasterItemDescription

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterItemDescription

public interface IRasterItemDescription
extends Serializable

Provides access to the properties of a raster item description for adding a raster.

Product Availability

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

Method Summary

IStringArray	getDataFileNames() The data file names.
IStringArray	getDataFileURLs() The data file URLs.
IGeodataXform	getGeodataXform() The georefencing of the raster item.
int	getGeodataXformApplyMethod() The method used for applying the GeodataXform.
double	getMaximumCellSizeFactor() The maximum visible cell size factor.
double	getMinimumCellSizeFactor() The minimum visible cell size factor.
IPropertySet	getProperties() The raster item properties.
String	getType() The raster item type, i.e.
boolean	isBuildPyramids() Indicates whether pyramids are built for the raster item.
boolean	isBuildThumbnail() Indicates whether thumbnails are built and saved for the raster item.
boolean	isComputeStatistics() Indicates whether histogram statistics are computed for the raster item.
void	setBuildPyramids(boolean pvbBuildPyramids) Indicates whether pyramids are built for the raster item.
void	setBuildThumbnail(boolean pvbBuildThumbnail) Indicates whether thumbnails are built and saved for the raster item.
void	setComputeStatistics(boolean pvbComputeStatistics) Indicates whether histogram statistics are computed for the raster item.
void	setDataFileNamesByRef(IStringArray ppNames) The data file names.
void	setDataFileURLsByRef(IStringArray ppURLs) The data file URLs.
void	setGeodataXformApplyMethod(int pMethod) The method used for applying the GeodataXform.
void	setGeodataXformByRef(IGeodataXform ppXf) The georefencing of the raster item.
void	setMaximumCellSizeFactor(double pMaxCellSizeFactor) The maximum visible cell size factor.
void	setMinimumCellSizeFactor(double pMinCellSizeFactor) The minimum visible cell size factor.
void	setPropertiesByRef(IPropertySet ppProperties) The raster item properties.
void	setType(String pType) The raster item type, i.e.

Method Detail

getDataFileNames

IStringArray getDataFileNames()
                              throws IOException,
                                     AutomationException

The data file names.

Product Availability

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

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.

setDataFileNamesByRef

void setDataFileNamesByRef(IStringArray ppNames)
                           throws IOException,
                                  AutomationException

The data file names.

Product Availability

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

Parameters:

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

getDataFileURLs

IStringArray getDataFileURLs()
                             throws IOException,
                                    AutomationException

The data file URLs.

Product Availability

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

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.

setDataFileURLsByRef

void setDataFileURLsByRef(IStringArray ppURLs)
                          throws IOException,
                                 AutomationException

The data file URLs.

Product Availability

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

Parameters:

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

getType

String getType()
               throws IOException,
                      AutomationException

The raster item type, i.e. a raster type name.

Product Availability

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

Returns:

The pType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

void setType(String pType)
             throws IOException,
                    AutomationException

The raster item type, i.e. a raster type name.

Product Availability

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

Parameters:

pType - The pType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperties

IPropertySet getProperties()
                           throws IOException,
                                  AutomationException

The raster item properties.

Product Availability

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

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.

setPropertiesByRef

void setPropertiesByRef(IPropertySet ppProperties)
                        throws IOException,
                               AutomationException

The raster item properties.

Product Availability

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

Parameters:

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

getMinimumCellSizeFactor

double getMinimumCellSizeFactor()
                                throws IOException,
                                       AutomationException

The minimum visible cell size factor.

Product Availability

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

Returns:

The pMinCellSizeFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumCellSizeFactor

void setMinimumCellSizeFactor(double pMinCellSizeFactor)
                              throws IOException,
                                     AutomationException

The minimum visible cell size factor.

Product Availability

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

Parameters:

pMinCellSizeFactor - The pMinCellSizeFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumCellSizeFactor

double getMaximumCellSizeFactor()
                                throws IOException,
                                       AutomationException

The maximum visible cell size factor.

Product Availability

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

Returns:

The pMaxCellSizeFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumCellSizeFactor

void setMaximumCellSizeFactor(double pMaxCellSizeFactor)
                              throws IOException,
                                     AutomationException

The maximum visible cell size factor.

Product Availability

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

Parameters:

pMaxCellSizeFactor - The pMaxCellSizeFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeodataXform

IGeodataXform getGeodataXform()
                              throws IOException,
                                     AutomationException

The georefencing of the raster item.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeodataXformByRef

void setGeodataXformByRef(IGeodataXform ppXf)
                          throws IOException,
                                 AutomationException

The georefencing of the raster item.

Product Availability

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

Parameters:

ppXf - A reference to a com.esri.arcgis.geodatabase.IGeodataXform (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeodataXformApplyMethod

int getGeodataXformApplyMethod()
                               throws IOException,
                                      AutomationException

The method used for applying the GeodataXform.

Product Availability

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

Returns:

A com.esri.arcgis.datasourcesraster.esriGeodataXformApplyMethod constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeodataXformApplyMethod

void setGeodataXformApplyMethod(int pMethod)
                                throws IOException,
                                       AutomationException

The method used for applying the GeodataXform.

Product Availability

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

Parameters:

pMethod - A com.esri.arcgis.datasourcesraster.esriGeodataXformApplyMethod constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setComputeStatistics

void setComputeStatistics(boolean pvbComputeStatistics)
                          throws IOException,
                                 AutomationException

Indicates whether histogram statistics are computed for the raster item.

Product Availability

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

Parameters:

pvbComputeStatistics - The pvbComputeStatistics (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isComputeStatistics

boolean isComputeStatistics()
                            throws IOException,
                                   AutomationException

Indicates whether histogram statistics are computed for the raster item.

Product Availability

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

Returns:

The pvbComputeStatistics

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBuildPyramids

void setBuildPyramids(boolean pvbBuildPyramids)
                      throws IOException,
                             AutomationException

Indicates whether pyramids are built for the raster item.

Product Availability

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

Parameters:

pvbBuildPyramids - The pvbBuildPyramids (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBuildPyramids

boolean isBuildPyramids()
                        throws IOException,
                               AutomationException

Indicates whether pyramids are built for the raster item.

Product Availability

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

Returns:

The pvbBuildPyramids

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBuildThumbnail

void setBuildThumbnail(boolean pvbBuildThumbnail)
                       throws IOException,
                              AutomationException

Indicates whether thumbnails are built and saved for the raster item.

Product Availability

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

Parameters:

pvbBuildThumbnail - The pvbBuildThumbnail (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBuildThumbnail

boolean isBuildThumbnail()
                         throws IOException,
                                AutomationException

Indicates whether thumbnails are built and saved for the raster item.

Product Availability

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

Returns:

The pvbBuildThumbnail

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.