com.esri.arcgis.carto
Class RasterItemDescription

java.lang.Object
  com.esri.arcgis.carto.RasterItemDescription

All Implemented Interfaces:

IRasterItemDescription, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class RasterItemDescription
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterItemDescription, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable

An image service rendering rule class.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

RasterItemDescription()
Constructs a RasterItemDescription using ArcGIS Engine.

RasterItemDescription(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterItemDescription theRasterItemDescription = (RasterItemDescription) obj;

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
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.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
IPropertySet	getProperties() The raster item properties.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
String	getType() The raster item type, i.e.
int	hashCode() the hashcode for this object
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	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
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.
void	writeExternal(ObjectOutput out)

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

RasterItemDescription

public RasterItemDescription()
                      throws IOException,
                             UnknownHostException

Constructs a RasterItemDescription using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RasterItemDescription

public RasterItemDescription(Object obj)
                      throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

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

getDataFileNames

public IStringArray getDataFileNames()
                              throws IOException,
                                     AutomationException

The data file names.

Product Availability

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

Specified by:

getDataFileNames in interface IRasterItemDescription

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

public void setDataFileNamesByRef(IStringArray ppNames)
                           throws IOException,
                                  AutomationException

The data file names.

Product Availability

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

Specified by:

setDataFileNamesByRef in interface IRasterItemDescription

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

public IStringArray getDataFileURLs()
                             throws IOException,
                                    AutomationException

The data file URLs.

Product Availability

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

Specified by:

getDataFileURLs in interface IRasterItemDescription

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

public void setDataFileURLsByRef(IStringArray ppURLs)
                          throws IOException,
                                 AutomationException

The data file URLs.

Product Availability

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

Specified by:

setDataFileURLsByRef in interface IRasterItemDescription

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

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

Specified by:

getType in interface IRasterItemDescription

Returns:

The pType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

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

Specified by:

setType in interface IRasterItemDescription

Parameters:

pType - The pType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperties

public IPropertySet getProperties()
                           throws IOException,
                                  AutomationException

The raster item properties.

Product Availability

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

Specified by:

getProperties in interface IRasterItemDescription

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

public void setPropertiesByRef(IPropertySet ppProperties)
                        throws IOException,
                               AutomationException

The raster item properties.

Product Availability

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

Specified by:

setPropertiesByRef in interface IRasterItemDescription

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

public double getMinimumCellSizeFactor()
                                throws IOException,
                                       AutomationException

The minimum visible cell size factor.

Product Availability

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

Specified by:

getMinimumCellSizeFactor in interface IRasterItemDescription

Returns:

The pMinCellSizeFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumCellSizeFactor

public void setMinimumCellSizeFactor(double pMinCellSizeFactor)
                              throws IOException,
                                     AutomationException

The minimum visible cell size factor.

Product Availability

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

Specified by:

setMinimumCellSizeFactor in interface IRasterItemDescription

Parameters:

pMinCellSizeFactor - The pMinCellSizeFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumCellSizeFactor

public double getMaximumCellSizeFactor()
                                throws IOException,
                                       AutomationException

The maximum visible cell size factor.

Product Availability

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

Specified by:

getMaximumCellSizeFactor in interface IRasterItemDescription

Returns:

The pMaxCellSizeFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumCellSizeFactor

public void setMaximumCellSizeFactor(double pMaxCellSizeFactor)
                              throws IOException,
                                     AutomationException

The maximum visible cell size factor.

Product Availability

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

Specified by:

setMaximumCellSizeFactor in interface IRasterItemDescription

Parameters:

pMaxCellSizeFactor - The pMaxCellSizeFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeodataXform

public IGeodataXform getGeodataXform()
                              throws IOException,
                                     AutomationException

The georefencing of the raster item.

Product Availability

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

Specified by:

getGeodataXform in interface IRasterItemDescription

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

public void setGeodataXformByRef(IGeodataXform ppXf)
                          throws IOException,
                                 AutomationException

The georefencing of the raster item.

Product Availability

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

Specified by:

setGeodataXformByRef in interface IRasterItemDescription

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

public int getGeodataXformApplyMethod()
                               throws IOException,
                                      AutomationException

The method used for applying the GeodataXform.

Product Availability

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

Specified by:

getGeodataXformApplyMethod in interface IRasterItemDescription

Returns:

A com.esri.arcgis.datasourcesraster.esriGeodataXformApplyMethod constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeodataXformApplyMethod

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

Specified by:

setGeodataXformApplyMethod in interface IRasterItemDescription

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

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

Specified by:

setComputeStatistics in interface IRasterItemDescription

Parameters:

pvbComputeStatistics - The pvbComputeStatistics (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isComputeStatistics

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

Specified by:

isComputeStatistics in interface IRasterItemDescription

Returns:

The pvbComputeStatistics

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBuildPyramids

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

Specified by:

setBuildPyramids in interface IRasterItemDescription

Parameters:

pvbBuildPyramids - The pvbBuildPyramids (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBuildPyramids

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

Specified by:

isBuildPyramids in interface IRasterItemDescription

Returns:

The pvbBuildPyramids

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBuildThumbnail

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

Specified by:

setBuildThumbnail in interface IRasterItemDescription

Parameters:

pvbBuildThumbnail - The pvbBuildThumbnail (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBuildThumbnail

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

Specified by:

isBuildThumbnail in interface IRasterItemDescription

Returns:

The pvbBuildThumbnail

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException