com.esri.arcgis.carto
Class ImageServiceInfo

java.lang.Object
  extended by com.esri.arcgis.carto.ImageServiceInfo
All Implemented Interfaces:
IImageServiceInfo, IImageServiceInfo2, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class ImageServiceInfo
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IImageServiceInfo, IImageServiceInfo2, IPersist, IPersistStream, IDocumentVersionSupportGEN, IXMLSerialize, IXMLVersionSupport, Externalizable

A class that provides information on an ArcGIS server image service.

Description

This object is new at ArcGIS 9.3.

Remarks

ImageServerInfo is a value object returned from IImageServer::ServiceInfo, and it supports IImageServiceInfo interface. It contains information that describes an image service. The interface provides access to image service information, such as native spatial reference, extent, cellsize, band statistics and etc, about an image service. There is no colormap, histogram, and attribute table.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
ImageServiceInfo()
          Constructs a ImageServiceInfo using ArcGIS Engine.
ImageServiceInfo(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ImageServiceInfo theImageServiceInfo = (ImageServiceInfo) obj;
 
Method Summary
 Object convertToSupportedObject(int docVersion)
          Convert the object to another object that is supported.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(Object o)
          Compare this object with another
 String getAllowedCompressions()
          The list of allowed client controllable transmition compressions.
 String getAllowedFields()
          The list of visible field names.
 String getAllowedItemMetadata()
          The level of item metadata details.
 String getAllowedMosaicMethods()
          The list of allowed client controllable mosaic methods.
 int getBandCount()
          The number of bands.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 String getCopyrightText()
          Copyright information associated with the image service.
 String getDefaultCompression()
          The default transmission compression, None, LZ77, JPEG.
 int getDefaultCompressionQuality()
          The default transmission compression quality (1-100).
 int getDefaultMosaicMethod()
          The default mosaic method.
 int getDefaultResamplingMethod()
          The default resampling method.
 String getDefaultServiceProperties()
          The default service properties.
 String getDescription()
          The description of the image service.
 String getEndTimeFieldName()
          The end time field name.
 IEnvelope getExtent()
          The extent of the image service.
 int getMaxDownloadImageCount()
          The maximum number of images allowed for download.
 double getMaximumPixelSize()
          The maximum visible pixel size.
 int getMaxMosaicImageCount()
          The maximum number of images allowed for mosaic.
 int getMaxNCols()
          The maximum number of colums this service supports.
 int getMaxNRows()
          The maximum number of rows this service supports.
 int getMaxRecordCount()
          The maximum number of records returned for query results.
 double getMinimumPixelSize()
          The minimum visible pixel size.
 String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 String getName()
          The name of the image service.
 Object getNoData()
          The NoData (background) value of the image service.
 void getPixelSize(double[] pDx, double[] pDy)
          Gets the pxiel size of the image service, in its native units.
 int getPixelType()
          The pixel type of the image service.
 int getServiceDataType()
          The data type of the image service.
 int getServiceSourceType()
          The image service data source type.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 ISpatialReference getSpatialReference()
          The spatial reference of the image service.
 String getStartTimeFieldName()
          The start time field name.
 void getStatistics(int iBand, double[] pMin, double[] pMax, double[] pMean, double[] pStdv)
          Gets the statistics of a given band.
 ITimeExtent getTimeExtent()
          The time extent.
 ITimeReference getTimeReference()
          The time reference.
 String getTimeValueFormat()
          The time value format.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 boolean isSupportBSQ()
          Indicates if output can be generated in BSQ pixel interleave format.
 boolean isSupportedAtVersion(int docVersion)
          Is this object valid at the given document version.
 boolean isSupportsTime()
          Indicates if time is supported.
 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 setAllowedCompressions(String pAllowedCompressions)
          The list of allowed client controllable transmition compressions.
 void setAllowedFields(String pAllowedFields)
          The list of visible field names.
 void setAllowedItemMetadata(String pLOD)
          The level of item metadata details.
 void setAllowedMosaicMethods(String pAllowedMethods)
          The list of allowed client controllable mosaic methods.
 void setCopyrightText(String pCopyright)
          Copyright information associated with the image service.
 void setDefaultCompression(String pCompression)
          The default transmission compression, None, LZ77, JPEG.
 void setDefaultCompressionQuality(int pQuality)
          The default transmission compression quality (1-100).
 void setDefaultMosaicMethod(int pMosaicMethod)
          The default mosaic method.
 void setDefaultResamplingMethod(int pResamplingMethod)
          The default resampling method.
 void setDefaultServiceProperties(String pServiceProperties)
          The default service properties.
 void setEndTimeFieldName(String pFieldName)
          The end time field name.
 void setMaxDownloadImageCount(int pCount)
          The maximum number of images allowed for download.
 void setMaxMosaicImageCount(int pCount)
          The maximum number of images allowed for mosaic.
 void setMaxNCols(int rhs1)
          The maximum number of colums this service supports.
 void setMaxNRows(int rhs1)
          The maximum number of rows this service supports.
 void setMaxRecordCount(int pCount)
          The maximum number of records returned for query results.
 void setServiceDataType(int pDataType)
          The data type of the image service.
 void setServiceSourceType(int pServiceSourceType)
          The image service data source type.
 void setStartTimeFieldName(String pFieldName)
          The start time field name.
 void setSupportBSQ(boolean pBSQ)
          Indicates if output can be generated in BSQ pixel interleave format.
 void setSupportsTime(boolean supports)
          Indicates if time is supported.
 void setTimeExtentByRef(ITimeExtent ppTimeExtent)
          The time extent.
 void setTimeReferenceByRef(ITimeReference ppTimeReference)
          The time reference.
 void setTimeValueFormat(String pTimeFormat)
          The time value format.
 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

ImageServiceInfo

public ImageServiceInfo()
                 throws IOException,
                        UnknownHostException
Constructs a ImageServiceInfo using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

ImageServiceInfo

public ImageServiceInfo(Object obj)
                 throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ImageServiceInfo theImageServiceInfo = (ImageServiceInfo) obj;

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

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

getName

public String getName()
               throws IOException,
                      AutomationException
The name of the image service.

Product Availability

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

Specified by:
getName in interface IImageServiceInfo
Returns:
The pName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException
The description of the image service.

Product Availability

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

Specified by:
getDescription in interface IImageServiceInfo
Returns:
The pDescrition
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException
The spatial reference of the image service.

Product Availability

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

Specified by:
getSpatialReference in interface IImageServiceInfo
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The extent of the image service.

Product Availability

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

Specified by:
getExtent in interface IImageServiceInfo
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPixelSize

public void getPixelSize(double[] pDx,
                         double[] pDy)
                  throws IOException,
                         AutomationException
Gets the pxiel size of the image service, in its native units.

Product Availability

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

Specified by:
getPixelSize in interface IImageServiceInfo
Parameters:
pDx - The pDx (out: use single element array)
pDy - The pDy (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStatistics

public void getStatistics(int iBand,
                          double[] pMin,
                          double[] pMax,
                          double[] pMean,
                          double[] pStdv)
                   throws IOException,
                          AutomationException
Gets the statistics of a given band.

Product Availability

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

Specified by:
getStatistics in interface IImageServiceInfo
Parameters:
iBand - The iBand (in)
pMin - The pMin (out: use single element array)
pMax - The pMax (out: use single element array)
pMean - The pMean (out: use single element array)
pStdv - The pStdv (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBandCount

public int getBandCount()
                 throws IOException,
                        AutomationException
The number of bands.

Product Availability

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

Specified by:
getBandCount in interface IImageServiceInfo
Returns:
The pBandCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPixelType

public int getPixelType()
                 throws IOException,
                        AutomationException
The pixel type of the image service.

Product Availability

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

Specified by:
getPixelType in interface IImageServiceInfo
Returns:
A com.esri.arcgis.geodatabase.rstPixelType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNoData

public Object getNoData()
                 throws IOException,
                        AutomationException
The NoData (background) value of the image service.

Remarks

The NoData (background) value of the image service. The variant data type does not have to match the pixel type. It can be empty or outside the pixel value range. This indicates the service does not have a predefined NoData value, and will not fill NoData pixels with a predefined value.

Product Availability

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

Specified by:
getNoData in interface IImageServiceInfo
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumPixelSize

public double getMaximumPixelSize()
                           throws IOException,
                                  AutomationException
The maximum visible pixel size.

Product Availability

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

Specified by:
getMaximumPixelSize in interface IImageServiceInfo
Returns:
The pMaxPixelSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinimumPixelSize

public double getMinimumPixelSize()
                           throws IOException,
                                  AutomationException
The minimum visible pixel size.

Product Availability

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

Specified by:
getMinimumPixelSize in interface IImageServiceInfo
Returns:
The pMinPixelSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCopyrightText

public String getCopyrightText()
                        throws IOException,
                               AutomationException
Copyright information associated with the image service.

Product Availability

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

Specified by:
getCopyrightText in interface IImageServiceInfo
Returns:
The pCopyright
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCopyrightText

public void setCopyrightText(String pCopyright)
                      throws IOException,
                             AutomationException
Copyright information associated with the image service.

Product Availability

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

Specified by:
setCopyrightText in interface IImageServiceInfo
Parameters:
pCopyright - The pCopyright (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServiceDataType

public int getServiceDataType()
                       throws IOException,
                              AutomationException
The data type of the image service.

Product Availability

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

Specified by:
getServiceDataType in interface IImageServiceInfo
Returns:
A com.esri.arcgis.carto.esriImageServiceDataType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setServiceDataType

public void setServiceDataType(int pDataType)
                        throws IOException,
                               AutomationException
The data type of the image service.

Product Availability

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

Specified by:
setServiceDataType in interface IImageServiceInfo
Parameters:
pDataType - A com.esri.arcgis.carto.esriImageServiceDataType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultServiceProperties

public void setDefaultServiceProperties(String pServiceProperties)
                                 throws IOException,
                                        AutomationException
The default service properties.

Product Availability

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

Specified by:
setDefaultServiceProperties in interface IImageServiceInfo
Parameters:
pServiceProperties - The pServiceProperties (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultServiceProperties

public String getDefaultServiceProperties()
                                   throws IOException,
                                          AutomationException
The default service properties.

Product Availability

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

Specified by:
getDefaultServiceProperties in interface IImageServiceInfo
Returns:
The pServiceProperties
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxNCols

public int getMaxNCols()
                throws IOException,
                       AutomationException
The maximum number of colums this service supports.

Product Availability

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

Specified by:
getMaxNCols in interface IImageServiceInfo
Returns:
The pMaxNCols
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxNRows

public int getMaxNRows()
                throws IOException,
                       AutomationException
The maximum number of rows this service supports.

Product Availability

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

Specified by:
getMaxNRows in interface IImageServiceInfo
Returns:
The pMaxNRows
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServiceSourceType

public int getServiceSourceType()
                         throws IOException,
                                AutomationException
The image service data source type.

Product Availability

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

Specified by:
getServiceSourceType in interface IImageServiceInfo
Returns:
A com.esri.arcgis.carto.esriImageServiceSourceType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setServiceSourceType

public void setServiceSourceType(int pServiceSourceType)
                          throws IOException,
                                 AutomationException
The image service data source type.

Product Availability

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

Specified by:
setServiceSourceType in interface IImageServiceInfo
Parameters:
pServiceSourceType - A com.esri.arcgis.carto.esriImageServiceSourceType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAllowedFields

public String getAllowedFields()
                        throws IOException,
                               AutomationException
The list of visible field names.

Product Availability

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

Specified by:
getAllowedFields in interface IImageServiceInfo2
Returns:
The pAllowedFields
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAllowedFields

public void setAllowedFields(String pAllowedFields)
                      throws IOException,
                             AutomationException
The list of visible field names.

Product Availability

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

Specified by:
setAllowedFields in interface IImageServiceInfo2
Parameters:
pAllowedFields - The pAllowedFields (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAllowedCompressions

public String getAllowedCompressions()
                              throws IOException,
                                     AutomationException
The list of allowed client controllable transmition compressions.

Product Availability

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

Specified by:
getAllowedCompressions in interface IImageServiceInfo2
Returns:
The pAllowedCompressions
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAllowedCompressions

public void setAllowedCompressions(String pAllowedCompressions)
                            throws IOException,
                                   AutomationException
The list of allowed client controllable transmition compressions.

Product Availability

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

Specified by:
setAllowedCompressions in interface IImageServiceInfo2
Parameters:
pAllowedCompressions - The pAllowedCompressions (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAllowedMosaicMethods

public String getAllowedMosaicMethods()
                               throws IOException,
                                      AutomationException
The list of allowed client controllable mosaic methods.

Product Availability

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

Specified by:
getAllowedMosaicMethods in interface IImageServiceInfo2
Returns:
The pAllowedMethods
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAllowedMosaicMethods

public void setAllowedMosaicMethods(String pAllowedMethods)
                             throws IOException,
                                    AutomationException
The list of allowed client controllable mosaic methods.

Product Availability

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

Specified by:
setAllowedMosaicMethods in interface IImageServiceInfo2
Parameters:
pAllowedMethods - The pAllowedMethods (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAllowedItemMetadata

public String getAllowedItemMetadata()
                              throws IOException,
                                     AutomationException
The level of item metadata details.

Product Availability

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

Specified by:
getAllowedItemMetadata in interface IImageServiceInfo2
Returns:
The pLOD
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAllowedItemMetadata

public void setAllowedItemMetadata(String pLOD)
                            throws IOException,
                                   AutomationException
The level of item metadata details.

Product Availability

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

Specified by:
setAllowedItemMetadata in interface IImageServiceInfo2
Parameters:
pLOD - The pLOD (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxRecordCount

public int getMaxRecordCount()
                      throws IOException,
                             AutomationException
The maximum number of records returned for query results.

Product Availability

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

Specified by:
getMaxRecordCount in interface IImageServiceInfo2
Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxRecordCount

public void setMaxRecordCount(int pCount)
                       throws IOException,
                              AutomationException
The maximum number of records returned for query results.

Product Availability

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

Specified by:
setMaxRecordCount in interface IImageServiceInfo2
Parameters:
pCount - The pCount (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxDownloadImageCount

public int getMaxDownloadImageCount()
                             throws IOException,
                                    AutomationException
The maximum number of images allowed for download.

Product Availability

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

Specified by:
getMaxDownloadImageCount in interface IImageServiceInfo2
Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxDownloadImageCount

public void setMaxDownloadImageCount(int pCount)
                              throws IOException,
                                     AutomationException
The maximum number of images allowed for download.

Product Availability

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

Specified by:
setMaxDownloadImageCount in interface IImageServiceInfo2
Parameters:
pCount - The pCount (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxMosaicImageCount

public int getMaxMosaicImageCount()
                           throws IOException,
                                  AutomationException
The maximum number of images allowed for mosaic.

Product Availability

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

Specified by:
getMaxMosaicImageCount in interface IImageServiceInfo2
Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxMosaicImageCount

public void setMaxMosaicImageCount(int pCount)
                            throws IOException,
                                   AutomationException
The maximum number of images allowed for mosaic.

Product Availability

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

Specified by:
setMaxMosaicImageCount in interface IImageServiceInfo2
Parameters:
pCount - The pCount (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxNCols

public void setMaxNCols(int rhs1)
                 throws IOException,
                        AutomationException
The maximum number of colums this service supports.

Product Availability

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

Specified by:
setMaxNCols in interface IImageServiceInfo2
Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxNRows

public void setMaxNRows(int rhs1)
                 throws IOException,
                        AutomationException
The maximum number of rows this service supports.

Product Availability

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

Specified by:
setMaxNRows in interface IImageServiceInfo2
Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultCompression

public String getDefaultCompression()
                             throws IOException,
                                    AutomationException
The default transmission compression, None, LZ77, JPEG.

Product Availability

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

Specified by:
getDefaultCompression in interface IImageServiceInfo2
Returns:
The pCompression
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultCompression

public void setDefaultCompression(String pCompression)
                           throws IOException,
                                  AutomationException
The default transmission compression, None, LZ77, JPEG.

Product Availability

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

Specified by:
setDefaultCompression in interface IImageServiceInfo2
Parameters:
pCompression - The pCompression (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultCompressionQuality

public int getDefaultCompressionQuality()
                                 throws IOException,
                                        AutomationException
The default transmission compression quality (1-100).

Product Availability

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

Specified by:
getDefaultCompressionQuality in interface IImageServiceInfo2
Returns:
The pQuality
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultCompressionQuality

public void setDefaultCompressionQuality(int pQuality)
                                  throws IOException,
                                         AutomationException
The default transmission compression quality (1-100).

Product Availability

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

Specified by:
setDefaultCompressionQuality in interface IImageServiceInfo2
Parameters:
pQuality - The pQuality (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultResamplingMethod

public int getDefaultResamplingMethod()
                               throws IOException,
                                      AutomationException
The default resampling method.

Product Availability

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

Specified by:
getDefaultResamplingMethod in interface IImageServiceInfo2
Returns:
A com.esri.arcgis.geodatabase.rstResamplingTypes constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultResamplingMethod

public void setDefaultResamplingMethod(int pResamplingMethod)
                                throws IOException,
                                       AutomationException
The default resampling method.

Product Availability

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

Specified by:
setDefaultResamplingMethod in interface IImageServiceInfo2
Parameters:
pResamplingMethod - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultMosaicMethod

public int getDefaultMosaicMethod()
                           throws IOException,
                                  AutomationException
The default mosaic method.

Product Availability

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

Specified by:
getDefaultMosaicMethod in interface IImageServiceInfo2
Returns:
A com.esri.arcgis.datasourcesraster.esriMosaicMethod constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultMosaicMethod

public void setDefaultMosaicMethod(int pMosaicMethod)
                            throws IOException,
                                   AutomationException
The default mosaic method.

Product Availability

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

Specified by:
setDefaultMosaicMethod in interface IImageServiceInfo2
Parameters:
pMosaicMethod - A com.esri.arcgis.datasourcesraster.esriMosaicMethod constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportBSQ

public boolean isSupportBSQ()
                     throws IOException,
                            AutomationException
Indicates if output can be generated in BSQ pixel interleave format.

Product Availability

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

Specified by:
isSupportBSQ in interface IImageServiceInfo2
Returns:
The pBSQ
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSupportBSQ

public void setSupportBSQ(boolean pBSQ)
                   throws IOException,
                          AutomationException
Indicates if output can be generated in BSQ pixel interleave format.

Product Availability

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

Specified by:
setSupportBSQ in interface IImageServiceInfo2
Parameters:
pBSQ - The pBSQ (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportsTime

public boolean isSupportsTime()
                       throws IOException,
                              AutomationException
Indicates if time is supported.

Product Availability

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

Specified by:
isSupportsTime in interface IImageServiceInfo2
Returns:
The supports
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSupportsTime

public void setSupportsTime(boolean supports)
                     throws IOException,
                            AutomationException
Indicates if time is supported.

Product Availability

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

Specified by:
setSupportsTime in interface IImageServiceInfo2
Parameters:
supports - The supports (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStartTimeFieldName

public String getStartTimeFieldName()
                             throws IOException,
                                    AutomationException
The start time field name.

Product Availability

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

Specified by:
getStartTimeFieldName in interface IImageServiceInfo2
Returns:
The pFieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStartTimeFieldName

public void setStartTimeFieldName(String pFieldName)
                           throws IOException,
                                  AutomationException
The start time field name.

Product Availability

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

Specified by:
setStartTimeFieldName in interface IImageServiceInfo2
Parameters:
pFieldName - The pFieldName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEndTimeFieldName

public String getEndTimeFieldName()
                           throws IOException,
                                  AutomationException
The end time field name.

Product Availability

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

Specified by:
getEndTimeFieldName in interface IImageServiceInfo2
Returns:
The pFieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEndTimeFieldName

public void setEndTimeFieldName(String pFieldName)
                         throws IOException,
                                AutomationException
The end time field name.

Product Availability

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

Specified by:
setEndTimeFieldName in interface IImageServiceInfo2
Parameters:
pFieldName - The pFieldName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeValueFormat

public String getTimeValueFormat()
                          throws IOException,
                                 AutomationException
The time value format.

Product Availability

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

Specified by:
getTimeValueFormat in interface IImageServiceInfo2
Returns:
The pTimeFormat
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeValueFormat

public void setTimeValueFormat(String pTimeFormat)
                        throws IOException,
                               AutomationException
The time value format.

Product Availability

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

Specified by:
setTimeValueFormat in interface IImageServiceInfo2
Parameters:
pTimeFormat - The pTimeFormat (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeReference

public ITimeReference getTimeReference()
                                throws IOException,
                                       AutomationException
The time reference.

Product Availability

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

Specified by:
getTimeReference in interface IImageServiceInfo2
Returns:
A reference to a com.esri.arcgis.system.ITimeReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeReferenceByRef

public void setTimeReferenceByRef(ITimeReference ppTimeReference)
                           throws IOException,
                                  AutomationException
The time reference.

Product Availability

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

Specified by:
setTimeReferenceByRef in interface IImageServiceInfo2
Parameters:
ppTimeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeExtent

public ITimeExtent getTimeExtent()
                          throws IOException,
                                 AutomationException
The time extent.

Product Availability

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

Specified by:
getTimeExtent in interface IImageServiceInfo2
Returns:
A reference to a com.esri.arcgis.system.ITimeExtent
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeExtentByRef

public void setTimeExtentByRef(ITimeExtent ppTimeExtent)
                        throws IOException,
                               AutomationException
The time extent.

Product Availability

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

Specified by:
setTimeExtentByRef in interface IImageServiceInfo2
Parameters:
ppTimeExtent - A reference to a com.esri.arcgis.system.ITimeExtent (in)
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.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException
Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:
isSupportedAtVersion in interface IDocumentVersionSupportGEN
Parameters:
docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Returns:
The supported
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException
Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:
convertToSupportedObject in interface IDocumentVersionSupportGEN
Parameters:
docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Returns:
A Variant
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