com.esri.arcgis.carto
Class RasterItemDescription

java.lang.Object
  extended by com.esri.arcgis.carto.RasterItemDescription
All Implemented Interfaces:
IRasterItemDescription, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

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

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

Description 'An image service rendering rule class.' 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
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.carto.IRasterItemDescription
IID, IIDe7a23083_b9bb_41bf_9253_c148b0ab033e, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Fields inherited from interface com.esri.arcgis.system.IXMLSerialize
IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport
IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy
 
Constructor Summary
RasterItemDescription()
          Constructs a RasterItemDescription using ArcGIS Engine.
RasterItemDescription(java.lang.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(java.lang.Object o)
          Compare this object with another
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.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.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 double getMaximumCellSizeFactor()
          The maximum visible cell size factor.
 double getMinimumCellSizeFactor()
          The minimum visible cell size factor.
 java.lang.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
 java.lang.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(java.io.ObjectInput in)
           
 void release()
          Release a RasterItemDescription.
 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(java.lang.String pType)
          The raster item type, i.e.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

RasterItemDescription

public RasterItemDescription()
                      throws java.io.IOException,
                             java.net.UnknownHostException
Constructs a RasterItemDescription using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

RasterItemDescription

public RasterItemDescription(java.lang.Object obj)
                      throws java.io.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:
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 RasterItemDescription.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getDataFileNames

public IStringArray getDataFileNames()
                              throws java.io.IOException,
                                     AutomationException
The data file names.

Specified by:
getDataFileNames in interface IRasterItemDescription
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataFileNamesByRef

public void setDataFileNamesByRef(IStringArray ppNames)
                           throws java.io.IOException,
                                  AutomationException
The data file names.

Specified by:
setDataFileNamesByRef in interface IRasterItemDescription
Parameters:
ppNames - A reference to a com.esri.arcgis.system.IStringArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataFileURLs

public IStringArray getDataFileURLs()
                             throws java.io.IOException,
                                    AutomationException
The data file URLs.

Specified by:
getDataFileURLs in interface IRasterItemDescription
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataFileURLsByRef

public void setDataFileURLsByRef(IStringArray ppURLs)
                          throws java.io.IOException,
                                 AutomationException
The data file URLs.

Specified by:
setDataFileURLsByRef in interface IRasterItemDescription
Parameters:
ppURLs - A reference to a com.esri.arcgis.system.IStringArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

public java.lang.String getType()
                         throws java.io.IOException,
                                AutomationException
The raster item type, i.e. a raster type name.

Specified by:
getType in interface IRasterItemDescription
Returns:
The pType
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setType

public void setType(java.lang.String pType)
             throws java.io.IOException,
                    AutomationException
The raster item type, i.e. a raster type name.

Specified by:
setType in interface IRasterItemDescription
Parameters:
pType - The pType (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProperties

public IPropertySet getProperties()
                           throws java.io.IOException,
                                  AutomationException
The raster item properties.

Specified by:
getProperties in interface IRasterItemDescription
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.

setPropertiesByRef

public void setPropertiesByRef(IPropertySet ppProperties)
                        throws java.io.IOException,
                               AutomationException
The raster item properties.

Specified by:
setPropertiesByRef in interface IRasterItemDescription
Parameters:
ppProperties - 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.

getMinimumCellSizeFactor

public double getMinimumCellSizeFactor()
                                throws java.io.IOException,
                                       AutomationException
The minimum visible cell size factor.

Specified by:
getMinimumCellSizeFactor in interface IRasterItemDescription
Returns:
The pMinCellSizeFactor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinimumCellSizeFactor

public void setMinimumCellSizeFactor(double pMinCellSizeFactor)
                              throws java.io.IOException,
                                     AutomationException
The minimum visible cell size factor.

Specified by:
setMinimumCellSizeFactor in interface IRasterItemDescription
Parameters:
pMinCellSizeFactor - The pMinCellSizeFactor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumCellSizeFactor

public double getMaximumCellSizeFactor()
                                throws java.io.IOException,
                                       AutomationException
The maximum visible cell size factor.

Specified by:
getMaximumCellSizeFactor in interface IRasterItemDescription
Returns:
The pMaxCellSizeFactor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumCellSizeFactor

public void setMaximumCellSizeFactor(double pMaxCellSizeFactor)
                              throws java.io.IOException,
                                     AutomationException
The maximum visible cell size factor.

Specified by:
setMaximumCellSizeFactor in interface IRasterItemDescription
Parameters:
pMaxCellSizeFactor - The pMaxCellSizeFactor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeodataXform

public IGeodataXform getGeodataXform()
                              throws java.io.IOException,
                                     AutomationException
The georefencing of the raster item.

Specified by:
getGeodataXform in interface IRasterItemDescription
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeodataXform
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGeodataXformByRef

public void setGeodataXformByRef(IGeodataXform ppXf)
                          throws java.io.IOException,
                                 AutomationException
The georefencing of the raster item.

Specified by:
setGeodataXformByRef in interface IRasterItemDescription
Parameters:
ppXf - A reference to a com.esri.arcgis.geodatabase.IGeodataXform (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeodataXformApplyMethod

public int getGeodataXformApplyMethod()
                               throws java.io.IOException,
                                      AutomationException
The method used for applying the GeodataXform.

Specified by:
getGeodataXformApplyMethod in interface IRasterItemDescription
Returns:
A com.esri.arcgis.datasourcesraster.esriGeodataXformApplyMethod constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGeodataXformApplyMethod

public void setGeodataXformApplyMethod(int pMethod)
                                throws java.io.IOException,
                                       AutomationException
The method used for applying the GeodataXform.

Specified by:
setGeodataXformApplyMethod in interface IRasterItemDescription
Parameters:
pMethod - A com.esri.arcgis.datasourcesraster.esriGeodataXformApplyMethod constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setComputeStatistics

public void setComputeStatistics(boolean pvbComputeStatistics)
                          throws java.io.IOException,
                                 AutomationException
Indicates whether histogram statistics are computed for the raster item.

Specified by:
setComputeStatistics in interface IRasterItemDescription
Parameters:
pvbComputeStatistics - The pvbComputeStatistics (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isComputeStatistics

public boolean isComputeStatistics()
                            throws java.io.IOException,
                                   AutomationException
Indicates whether histogram statistics are computed for the raster item.

Specified by:
isComputeStatistics in interface IRasterItemDescription
Returns:
The pvbComputeStatistics
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBuildPyramids

public void setBuildPyramids(boolean pvbBuildPyramids)
                      throws java.io.IOException,
                             AutomationException
Indicates whether pyramids are built for the raster item.

Specified by:
setBuildPyramids in interface IRasterItemDescription
Parameters:
pvbBuildPyramids - The pvbBuildPyramids (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 the raster item.

Specified by:
isBuildPyramids in interface IRasterItemDescription
Returns:
The pvbBuildPyramids
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBuildThumbnail

public void setBuildThumbnail(boolean pvbBuildThumbnail)
                       throws java.io.IOException,
                              AutomationException
Indicates whether thumbnails are built and saved for the raster item.

Specified by:
setBuildThumbnail in interface IRasterItemDescription
Parameters:
pvbBuildThumbnail - The pvbBuildThumbnail (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBuildThumbnail

public boolean isBuildThumbnail()
                         throws java.io.IOException,
                                AutomationException
Indicates whether thumbnails are built and saved for the raster item.

Specified by:
isBuildThumbnail in interface IRasterItemDescription
Returns:
The pvbBuildThumbnail
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

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

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
isDirty

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

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

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException
Serializes an object to XML.

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException
Deserializes an object from XML.

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public java.lang.String getMinNamespaceSupported()
                                          throws java.io.IOException,
                                                 AutomationException
The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:
getMinNamespaceSupported in interface IXMLVersionSupport
Returns:
The namespaceURI
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException