com.esri.arcgis.datasourcesraster
Class CellSizeLevel

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

All Implemented Interfaces:

ICellSizeLevel, ICellSizeLevel2, IItemURI, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class CellSizeLevel
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ICellSizeLevel, ICellSizeLevel2, IItemURI

A cell size level object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

CellSizeLevel()
Constructs a CellSizeLevel using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
IStringArray	getAuxiliaryPaths() Paths to all auxiliary data source items that aid in the construction of this item.
int	getCategory() The category associated with the cell size level.
double	getCellSize() The cell size value assocated with the level.
static String	getClsid() getClsid.
String	getDisplayName() The friendly-name identifying this item in the mosaic dataset.
IGeometry	getGeometry() The geometry defining the boundary of the cell size level.
String	getGroup() The name of the collection to which the item belongs.
int	getID() The unique ID associated with the cell size level.
String	getKey() A phrase that uniquely identifies the item's data source in the mosaic dataset.
double	getMaximumCellSize() The maximum cell size value associated with the level.
double	getMinimumCellSize() The minimum cell size value associated with the level.
String	getProductName() The name of the sensor product associated with the item's data source.
Date	getSourceTimeStamp() The timestamp associated with the data source referenced by this item URI.
String	getTag() The unique identifier of the item within a group.
int	hashCode() the hashcode for this object
void	setAuxiliaryPathsByRef(IStringArray ppAuxiliaryPaths) Paths to all auxiliary data source items that aid in the construction of this item.
void	setCategory(int pCategory) The category associated with the cell size level.
void	setCellSize(double pCellsize) The cell size value assocated with the level.
void	setDisplayName(String pDisplayName) The friendly-name identifying this item in the mosaic dataset.
void	setGeometryByRef(IGeometry ppLevelBoundary) The geometry defining the boundary of the cell size level.
void	setGroup(String pItemGroup) The name of the collection to which the item belongs.
void	setID(int pDescriptionID) The unique ID associated with the cell size level.
void	setKey(String pKeyString) A phrase that uniquely identifies the item's data source in the mosaic dataset.
void	setMaximumCellSize(double pMaximumCellSize) The maximum cell size value associated with the level.
void	setMinimumCellSize(double pMinimumCellSize) The minimum cell size value associated with the level.
void	setProductName(String pProductName) The name of the sensor product associated with the item's data source.
void	setSourceTimeStamp(Date pSourceTimeStamp) The timestamp associated with the data source referenced by this item URI.
void	setTag(String pItemTag) The unique identifier of the item within a group.

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

CellSizeLevel

public CellSizeLevel()
              throws IOException,
                     UnknownHostException

Constructs a CellSizeLevel using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

CellSizeLevel

public CellSizeLevel(Object obj)
              throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems CellSizeLevel theCellSizeLevel = (CellSizeLevel) 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

setCellSize

public void setCellSize(double pCellsize)
                 throws IOException,
                        AutomationException

The cell size value assocated with the level.

Product Availability

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

Specified by:

setCellSize in interface ICellSizeLevel

Parameters:

pCellsize - The pCellsize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellSize

public double getCellSize()
                   throws IOException,
                          AutomationException

The cell size value assocated with the level.

Product Availability

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

Specified by:

getCellSize in interface ICellSizeLevel

Returns:

The pCellsize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometryByRef

public void setGeometryByRef(IGeometry ppLevelBoundary)
                      throws IOException,
                             AutomationException

The geometry defining the boundary of the cell size level.

Product Availability

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

Specified by:

setGeometryByRef in interface ICellSizeLevel

Parameters:

ppLevelBoundary - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometry

public IGeometry getGeometry()
                      throws IOException,
                             AutomationException

The geometry defining the boundary of the cell size level.

Product Availability

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

Specified by:

getGeometry in interface ICellSizeLevel

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumCellSize

public void setMinimumCellSize(double pMinimumCellSize)
                        throws IOException,
                               AutomationException

The minimum cell size value associated with the level.

Product Availability

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

Specified by:

setMinimumCellSize in interface ICellSizeLevel

Parameters:

pMinimumCellSize - The pMinimumCellSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumCellSize

public double getMinimumCellSize()
                          throws IOException,
                                 AutomationException

The minimum cell size value associated with the level.

Product Availability

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

Specified by:

getMinimumCellSize in interface ICellSizeLevel

Returns:

The pMinimumCellSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumCellSize

public void setMaximumCellSize(double pMaximumCellSize)
                        throws IOException,
                               AutomationException

The maximum cell size value associated with the level.

Product Availability

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

Specified by:

setMaximumCellSize in interface ICellSizeLevel

Parameters:

pMaximumCellSize - The pMaximumCellSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumCellSize

public double getMaximumCellSize()
                          throws IOException,
                                 AutomationException

The maximum cell size value associated with the level.

Product Availability

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

Specified by:

getMaximumCellSize in interface ICellSizeLevel

Returns:

The pMaximumCellSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setID

public void setID(int pDescriptionID)
           throws IOException,
                  AutomationException

The unique ID associated with the cell size level.

Product Availability

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

Specified by:

setID in interface ICellSizeLevel

Parameters:

pDescriptionID - The pDescriptionID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

public int getID()
          throws IOException,
                 AutomationException

The unique ID associated with the cell size level.

Product Availability

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

Specified by:

getID in interface ICellSizeLevel

Returns:

The pDescriptionID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(int pCategory)
                 throws IOException,
                        AutomationException

The category associated with the cell size level.

Product Availability

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

Specified by:

setCategory in interface ICellSizeLevel2

Parameters:

pCategory - A com.esri.arcgis.datasourcesraster.esriCellSizeLevelCategory constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

public int getCategory()
                throws IOException,
                       AutomationException

The category associated with the cell size level.

Product Availability

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

Specified by:

getCategory in interface ICellSizeLevel2

Returns:

A com.esri.arcgis.datasourcesraster.esriCellSizeLevelCategory constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKey

public void setKey(String pKeyString)
            throws IOException,
                   AutomationException

A phrase that uniquely identifies the item's data source in the mosaic dataset. The value in this property is used for computing a 'signature' that appears in the URIHash field of the mosaic catalog.

Product Availability

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

Specified by:

setKey in interface IItemURI

Parameters:

pKeyString - The pKeyString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKey

public String getKey()
              throws IOException,
                     AutomationException

A phrase that uniquely identifies the item's data source in the mosaic dataset. The value in this property is used for computing a 'signature' that appears in the URIHash field of the mosaic catalog.

Product Availability

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

Specified by:

getKey in interface IItemURI

Returns:

The pKeyString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTag

public void setTag(String pItemTag)
            throws IOException,
                   AutomationException

The unique identifier of the item within a group. The value in this property appears in the Tag field of the mosaic catalog.

Product Availability

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

Specified by:

setTag in interface IItemURI

Parameters:

pItemTag - The pItemTag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTag

public String getTag()
              throws IOException,
                     AutomationException

The unique identifier of the item within a group. The value in this property appears in the Tag field of the mosaic catalog.

Product Availability

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

Specified by:

getTag in interface IItemURI

Returns:

The pItemTag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGroup

public void setGroup(String pItemGroup)
              throws IOException,
                     AutomationException

The name of the collection to which the item belongs. The value in this property appears in the GroupName field of the mosaic catalog.

Product Availability

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

Specified by:

setGroup in interface IItemURI

Parameters:

pItemGroup - The pItemGroup (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGroup

public String getGroup()
                throws IOException,
                       AutomationException

The name of the collection to which the item belongs. The value in this property appears in the GroupName field of the mosaic catalog.

Product Availability

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

Specified by:

getGroup in interface IItemURI

Returns:

The pItemGroup

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayName

public void setDisplayName(String pDisplayName)
                    throws IOException,
                           AutomationException

The friendly-name identifying this item in the mosaic dataset. The value in this property appears in the Name field of the mosaic catalog.

Product Availability

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

Specified by:

setDisplayName in interface IItemURI

Parameters:

pDisplayName - The pDisplayName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayName

public String getDisplayName()
                      throws IOException,
                             AutomationException

The friendly-name identifying this item in the mosaic dataset. The value in this property appears in the Name field of the mosaic catalog.

Product Availability

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

Specified by:

getDisplayName in interface IItemURI

Returns:

The pDisplayName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProductName

public void setProductName(String pProductName)
                    throws IOException,
                           AutomationException

The name of the sensor product associated with the item's data source. The value in this property appears in the ProductName field of the mosaic catalog.

Product Availability

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

Specified by:

setProductName in interface IItemURI

Parameters:

pProductName - The pProductName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProductName

public String getProductName()
                      throws IOException,
                             AutomationException

The name of the sensor product associated with the item's data source. The value in this property appears in the ProductName field of the mosaic catalog.

Product Availability

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

Specified by:

getProductName in interface IItemURI

Returns:

The pProductName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceTimeStamp

public void setSourceTimeStamp(Date pSourceTimeStamp)
                        throws IOException,
                               AutomationException

The timestamp associated with the data source referenced by this item URI.

Product Availability

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

Specified by:

setSourceTimeStamp in interface IItemURI

Parameters:

pSourceTimeStamp - The pSourceTimeStamp (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceTimeStamp

public Date getSourceTimeStamp()
                        throws IOException,
                               AutomationException

The timestamp associated with the data source referenced by this item URI.

Product Availability

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

Specified by:

getSourceTimeStamp in interface IItemURI

Returns:

The pSourceTimeStamp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAuxiliaryPathsByRef

public void setAuxiliaryPathsByRef(IStringArray ppAuxiliaryPaths)
                            throws IOException,
                                   AutomationException

Paths to all auxiliary data source items that aid in the construction of this item.

Product Availability

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

Specified by:

setAuxiliaryPathsByRef in interface IItemURI

Parameters:

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

getAuxiliaryPaths

public IStringArray getAuxiliaryPaths()
                               throws IOException,
                                      AutomationException

Paths to all auxiliary data source items that aid in the construction of this item.

Product Availability

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

Specified by:

getAuxiliaryPaths in interface IItemURI

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.