com.esri.arcgis.carto
Class ImageServiceInfo

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

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

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

Description 'A class that provides information on an ArcGIS server image service.' 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.IImageServiceInfo3
IID, IID021909fc_59e7_4082_900c_5bbef737c92c, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IImageServiceInfo2
IIDe569c393_70b6_497c_b999_bb246d00a8b7
 
Fields inherited from interface com.esri.arcgis.carto.IImageServiceInfo
IIDbfcd28a7_b02f_4c5d_aa7e_d0ba474d5192
 
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
ImageServiceInfo()
          Constructs a ImageServiceInfo using ArcGIS Engine.
ImageServiceInfo(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ImageServiceInfo theImageServiceInfo = (ImageServiceInfo) obj;
 
Method Summary
 java.lang.Object convertToSupportedObject(int docVersion)
          Convert the object to another object that is supported.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(java.lang.Object o)
          Compare this object with another
 java.lang.String getAllowedCompressions()
          The list of allowed client controllable transmition compressions.
 java.lang.String getAllowedFields()
          The list of visible field names.
 java.lang.String getAllowedItemMetadata()
          The level of item metadata details.
 java.lang.String getAllowedMosaicMethods()
          The list of allowed client controllable mosaic methods.
 int getBandCount()
          The number of bands.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 IRasterColormap getColormap()
          The raster colormap.
 java.lang.String getCopyrightText()
          Copyright information associated with the image service.
 java.lang.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.
 java.lang.String getDefaultServiceProperties()
          The default service properties.
 java.lang.String getDescription()
          The description of the image service.
 java.lang.String getEndTimeFieldName()
          The end time field name.
 IEnvelope getExtent()
          The extent of the image service.
 IRasterHistogram getHistogram(int iBand)
          Get the histogram of a given band.
 IRasterHistograms getHistograms()
          The histogram of a given band.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 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 getMaxScale()
          The maximum visible scale for the service.
 java.lang.String getMensurationCapabilities()
          The list of available mensuration capabilities.
 double getMinimumPixelSize()
          The minimum visible pixel size.
 java.lang.String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 double getMinScale()
          The minimum visible scale for the service.
 java.lang.String getName()
          The name of the image service.
 java.lang.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.
 IRasterFunctionInfos getRasterFunctions()
          The list of available server raster functions.
 IRasterTypeInfos getRasterTypes()
          The list of allowed raster type names for adding rasters.
 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.
 java.lang.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.
 java.lang.String getTimeValueFormat()
          The time value format.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 boolean isHasRasterAttributeTable()
          Indicates if a raster attribute table exists.
 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(java.io.ObjectInput in)
           
 void release()
          Release a ImageServiceInfo.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setAllowedCompressions(java.lang.String pAllowedCompressions)
          The list of allowed client controllable transmition compressions.
 void setAllowedFields(java.lang.String pAllowedFields)
          The list of visible field names.
 void setAllowedItemMetadata(java.lang.String pLOD)
          The level of item metadata details.
 void setAllowedMosaicMethods(java.lang.String pAllowedMethods)
          The list of allowed client controllable mosaic methods.
 void setCopyrightText(java.lang.String pCopyright)
          Copyright information associated with the image service.
 void setDefaultCompression(java.lang.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(java.lang.String pServiceProperties)
          The default service properties.
 void setEndTimeFieldName(java.lang.String pFieldName)
          The end time field name.
 void setHasRasterAttributeTable(boolean pHasTable)
          Indicates if a raster attribute table exists.
 void setMaxDownloadImageCount(int pCount)
          The maximum number of images allowed for download.
 void setMaximumPixelSize(double rhs1)
          The maximum visible pixel size for the service.
 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 setMaxScale(double scale)
          The maximum visible scale for the service.
 void setMensurationCapabilities(java.lang.String pCapabilities)
          The list of available mensuration capabilities.
 void setMinimumPixelSize(double rhs1)
          The minimum visible pixel size for the service.
 void setMinScale(double scale)
          The minimum visible scale for the service.
 void setRasterFunctionsByRef(IRasterFunctionInfos ppFunctionInfos)
          The list of available server raster functions.
 void setRasterTypesByRef(IRasterTypeInfos ppTypeInfos)
          The list of allowed raster type names for adding rasters.
 void setServiceDataType(int pDataType)
          The data type of the image service.
 void setServiceSourceType(int pServiceSourceType)
          The image service data source type.
 void setStartTimeFieldName(java.lang.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(java.lang.String pTimeFormat)
          The time value format.
 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

ImageServiceInfo

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

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

ImageServiceInfo

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

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

getName

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

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

getDescription

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

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

getSpatialReference

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

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

getExtent

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

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

getPixelSize

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

Specified by:
getPixelSize in interface IImageServiceInfo
Parameters:
pDx - The pDx (out: use single element array)
pDy - The pDy (out: use single element array)
Throws:
java.io.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 java.io.IOException,
                          AutomationException
Gets the statistics of a given band.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBandCount

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

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

getPixelType

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

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

getNoData

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

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

getMaximumPixelSize

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

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

getMinimumPixelSize

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

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

getCopyrightText

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

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

setCopyrightText

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

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

getServiceDataType

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

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

setServiceDataType

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

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

setDefaultServiceProperties

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

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

getDefaultServiceProperties

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

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

getMaxNCols

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

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

getMaxNRows

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

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

getServiceSourceType

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

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

setServiceSourceType

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

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

getAllowedFields

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

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

setAllowedFields

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

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

getAllowedCompressions

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

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

setAllowedCompressions

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

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

getAllowedMosaicMethods

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

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

setAllowedMosaicMethods

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

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

getAllowedItemMetadata

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

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

setAllowedItemMetadata

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

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

getMaxRecordCount

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

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

setMaxRecordCount

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

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

getMaxDownloadImageCount

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

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

setMaxDownloadImageCount

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

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

getMaxMosaicImageCount

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

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

setMaxMosaicImageCount

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

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

setMaxNCols

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

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

setMaxNRows

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

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

getDefaultCompression

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

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

setDefaultCompression

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

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

getDefaultCompressionQuality

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

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

setDefaultCompressionQuality

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

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

getDefaultResamplingMethod

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

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

setDefaultResamplingMethod

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

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

getDefaultMosaicMethod

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

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

setDefaultMosaicMethod

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

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

isSupportBSQ

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

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

setSupportBSQ

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

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

isSupportsTime

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

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

setSupportsTime

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

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

getStartTimeFieldName

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

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

setStartTimeFieldName

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

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

getEndTimeFieldName

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

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

setEndTimeFieldName

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

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

getTimeValueFormat

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

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

setTimeValueFormat

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

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

getTimeReference

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

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

setTimeReferenceByRef

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

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

getTimeExtent

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

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

setTimeExtentByRef

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

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

getHistograms

public IRasterHistograms getHistograms()
                                throws java.io.IOException,
                                       AutomationException
The histogram of a given band.

Specified by:
getHistograms in interface IImageServiceInfo3
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IRasterHistograms
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColormap

public IRasterColormap getColormap()
                            throws java.io.IOException,
                                   AutomationException
The raster colormap.

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

getHistogram

public IRasterHistogram getHistogram(int iBand)
                              throws java.io.IOException,
                                     AutomationException
Get the histogram of a given band.

Specified by:
getHistogram in interface IImageServiceInfo3
Parameters:
iBand - The iBand (in)
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IRasterHistogram
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRasterFunctions

public IRasterFunctionInfos getRasterFunctions()
                                        throws java.io.IOException,
                                               AutomationException
The list of available server raster functions.

Specified by:
getRasterFunctions in interface IImageServiceInfo3
Returns:
A reference to a com.esri.arcgis.carto.IRasterFunctionInfos
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterFunctionsByRef

public void setRasterFunctionsByRef(IRasterFunctionInfos ppFunctionInfos)
                             throws java.io.IOException,
                                    AutomationException
The list of available server raster functions.

Specified by:
setRasterFunctionsByRef in interface IImageServiceInfo3
Parameters:
ppFunctionInfos - A reference to a com.esri.arcgis.carto.IRasterFunctionInfos (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRasterTypes

public IRasterTypeInfos getRasterTypes()
                                throws java.io.IOException,
                                       AutomationException
The list of allowed raster type names for adding rasters.

Specified by:
getRasterTypes in interface IImageServiceInfo3
Returns:
A reference to a com.esri.arcgis.carto.IRasterTypeInfos
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterTypesByRef

public void setRasterTypesByRef(IRasterTypeInfos ppTypeInfos)
                         throws java.io.IOException,
                                AutomationException
The list of allowed raster type names for adding rasters.

Specified by:
setRasterTypesByRef in interface IImageServiceInfo3
Parameters:
ppTypeInfos - A reference to a com.esri.arcgis.carto.IRasterTypeInfos (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMensurationCapabilities

public java.lang.String getMensurationCapabilities()
                                            throws java.io.IOException,
                                                   AutomationException
The list of available mensuration capabilities.

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

setMensurationCapabilities

public void setMensurationCapabilities(java.lang.String pCapabilities)
                                throws java.io.IOException,
                                       AutomationException
The list of available mensuration capabilities.

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

isHasRasterAttributeTable

public boolean isHasRasterAttributeTable()
                                  throws java.io.IOException,
                                         AutomationException
Indicates if a raster attribute table exists.

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

setHasRasterAttributeTable

public void setHasRasterAttributeTable(boolean pHasTable)
                                throws java.io.IOException,
                                       AutomationException
Indicates if a raster attribute table exists.

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

getMinScale

public double getMinScale()
                   throws java.io.IOException,
                          AutomationException
The minimum visible scale for the service.

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

setMinScale

public void setMinScale(double scale)
                 throws java.io.IOException,
                        AutomationException
The minimum visible scale for the service.

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

getMaxScale

public double getMaxScale()
                   throws java.io.IOException,
                          AutomationException
The maximum visible scale for the service.

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

setMaxScale

public void setMaxScale(double scale)
                 throws java.io.IOException,
                        AutomationException
The maximum visible scale for the service.

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

setMinimumPixelSize

public void setMinimumPixelSize(double rhs1)
                         throws java.io.IOException,
                                AutomationException
The minimum visible pixel size for the service.

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

setMaximumPixelSize

public void setMaximumPixelSize(double rhs1)
                         throws java.io.IOException,
                                AutomationException
The maximum visible pixel size for the service.

Specified by:
setMaximumPixelSize in interface IImageServiceInfo3
Parameters:
rhs1 - The rhs1 (in)
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.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.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:
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