com.esri.arcgis.carto
Interface IImageServerInit2

All Superinterfaces:

IImageServerInit, Serializable

All Known Subinterfaces:

IImageServerInit3

All Known Implementing Classes:

ImageServer

public interface IImageServerInit2
extends IImageServerInit, Serializable

Provides access to members that control initialization of an image server.

Description

This interface is new at ArcGIS 10.

Remarks

IImageServerInit2 interface is used to initialize a local image service and set configratuion parameters: MaxRecordCount, MaxImageWidth, MaxImageHeight, AllowedCompressions, AllowedMosaicMethods, AllowedItemMetadata, etc.

Product Availability

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

Method Summary

String	getAllowedCompressions() The list of allowed compressions, None, LZ77, and JPEG.
String	getAllowedFields() The list of allowed field names.
String	getAllowedItemMetadata() The allowed metadata, None, Basic, and Full.
String	getAllowedMosaicMethods() The list of allowed mosaic methods.
String	getDownloadDirectory() The physical directory for downloadable files.
String	getDynamicImageWorkspace() The workspace used for adding rasters.
String	getExcludedFields() The list of excluded field names.
int	getMaxImageHeight() The maximum height in pixels of an image request.
int	getMaxImageWidth() The maximum width in pixels of an image request.
int	getMaxRecordCount() The maximum number of records returned for query results (GetCatalog).
String	getOutputDirectory() The physical directory for output files.
String	getVirtualDownloadDirectory() The virtual directory for downloading files.
String	getVirtualOutputDirectory() The virtual directory for output files.
void	setAllowedCompressions(String pAllowedCompressions) The list of allowed compressions, None, LZ77, and JPEG.
void	setAllowedFields(String pAllowedFields) The list of allowed field names.
void	setAllowedItemMetadata(String pAllowedItemMetadata) The allowed metadata, None, Basic, and Full.
void	setAllowedMosaicMethods(String pAllowedMosaicMethods) The list of allowed mosaic methods.
void	setDownloadDirectory(String pPath) The physical directory for downloadable files.
void	setDynamicImageWorkspace(String pPath) The workspace used for adding rasters.
void	setExcludedFields(String pExcludedFields) The list of excluded field names.
void	setMaxImageHeight(int height) The maximum height in pixels of an image request.
void	setMaxImageWidth(int width) The maximum width in pixels of an image request.
void	setMaxRecordCount(int count) The maximum number of records returned for query results (GetCatalog).
void	setOutputDirectory(String pPath) The physical directory for output files.
void	setVirtualDownloadDirectory(String pPath) The virtual directory for downloading files.
void	setVirtualOutputDirectory(String pPath) The virtual directory for output files.

Methods inherited from interface com.esri.arcgis.carto.IImageServerInit

getImageDataSourceName, initialize, initializeFromDataset, initializeFromServiceURL, setImageDataSourceNameByRef

Method Detail

setOutputDirectory

void setOutputDirectory(String pPath)
                        throws IOException,
                               AutomationException

The physical directory for output files.

Product Availability

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

Parameters:

pPath - The pPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputDirectory

String getOutputDirectory()
                          throws IOException,
                                 AutomationException

The physical directory for output files.

Product Availability

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

Returns:

The pPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVirtualOutputDirectory

void setVirtualOutputDirectory(String pPath)
                               throws IOException,
                                      AutomationException

The virtual directory for output files.

Product Availability

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

Parameters:

pPath - The pPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVirtualOutputDirectory

String getVirtualOutputDirectory()
                                 throws IOException,
                                        AutomationException

The virtual directory for output files.

Product Availability

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

Returns:

The pPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDownloadDirectory

void setDownloadDirectory(String pPath)
                          throws IOException,
                                 AutomationException

The physical directory for downloadable files.

Product Availability

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

Parameters:

pPath - The pPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDownloadDirectory

String getDownloadDirectory()
                            throws IOException,
                                   AutomationException

The physical directory for downloadable files.

Product Availability

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

Returns:

The pPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVirtualDownloadDirectory

void setVirtualDownloadDirectory(String pPath)
                                 throws IOException,
                                        AutomationException

The virtual directory for downloading files.

Product Availability

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

Parameters:

pPath - The pPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVirtualDownloadDirectory

String getVirtualDownloadDirectory()
                                   throws IOException,
                                          AutomationException

The virtual directory for downloading files.

Product Availability

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

Returns:

The pPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDynamicImageWorkspace

void setDynamicImageWorkspace(String pPath)
                              throws IOException,
                                     AutomationException

The workspace used for adding rasters.

Product Availability

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

Parameters:

pPath - The pPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDynamicImageWorkspace

String getDynamicImageWorkspace()
                                throws IOException,
                                       AutomationException

The workspace used for adding rasters.

Product Availability

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

Returns:

The pPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExcludedFields

void setExcludedFields(String pExcludedFields)
                       throws IOException,
                              AutomationException

The list of excluded field names.

Product Availability

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

Parameters:

pExcludedFields - The pExcludedFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExcludedFields

String getExcludedFields()
                         throws IOException,
                                AutomationException

The list of excluded field names.

Product Availability

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

Returns:

The pExcludedFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxRecordCount

int getMaxRecordCount()
                      throws IOException,
                             AutomationException

The maximum number of records returned for query results (GetCatalog).

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxRecordCount

void setMaxRecordCount(int count)
                       throws IOException,
                              AutomationException

The maximum number of records returned for query results (GetCatalog).

Product Availability

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

Parameters:

count - The count (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxImageWidth

int getMaxImageWidth()
                     throws IOException,
                            AutomationException

The maximum width in pixels of an image request.

Product Availability

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

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxImageWidth

void setMaxImageWidth(int width)
                      throws IOException,
                             AutomationException

The maximum width in pixels of an image request.

Product Availability

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

Parameters:

width - The width (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxImageHeight

int getMaxImageHeight()
                      throws IOException,
                             AutomationException

The maximum height in pixels of an image request.

Product Availability

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

Returns:

The height

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxImageHeight

void setMaxImageHeight(int height)
                       throws IOException,
                              AutomationException

The maximum height in pixels of an image request.

Product Availability

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

Parameters:

height - The height (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllowedFields

void setAllowedFields(String pAllowedFields)
                      throws IOException,
                             AutomationException

The list of allowed field names.

Remarks

Use a comma delimited string for multiple allowed fields.

Product Availability

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

Parameters:

pAllowedFields - The pAllowedFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllowedFields

String getAllowedFields()
                        throws IOException,
                               AutomationException

The list of allowed field names.

Product Availability

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

Returns:

The pAllowedFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllowedCompressions

void setAllowedCompressions(String pAllowedCompressions)
                            throws IOException,
                                   AutomationException

The list of allowed compressions, None, LZ77, and JPEG.

Remarks

Available compressions include: "None", "JPEG", "LZ77". The AllowedCompressions property takes a comma delimited string for multiple compressions, e.g. "None,JPEG,LZ77". The first one in the list is default compression.

Product Availability

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

Parameters:

pAllowedCompressions - The pAllowedCompressions (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllowedCompressions

String getAllowedCompressions()
                              throws IOException,
                                     AutomationException

The list of allowed compressions, None, LZ77, and JPEG.

Product Availability

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

Returns:

The pAllowedCompressions

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllowedMosaicMethods

void setAllowedMosaicMethods(String pAllowedMosaicMethods)
                             throws IOException,
                                    AutomationException

The list of allowed mosaic methods.

Remarks

Available mosaic methods include: "Center","Nadir","NorthWest","Viewpoint","Seamline","ByAttribute","LockRaster". The AllowedMosaicMethods property takes a comma delimited string for multiple methods, e.g. "Center,LockRaster". The first one in the list is default mosaic method.

Product Availability

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

Parameters:

pAllowedMosaicMethods - The pAllowedMosaicMethods (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllowedMosaicMethods

String getAllowedMosaicMethods()
                               throws IOException,
                                      AutomationException

The list of allowed mosaic methods.

Product Availability

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

Returns:

The pAllowedMosaicMethods

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllowedItemMetadata

void setAllowedItemMetadata(String pAllowedItemMetadata)
                            throws IOException,
                                   AutomationException

The allowed metadata, None, Basic, and Full.

Remarks

The AllowedItemMetadata property takes one from the following: "None", "Basic", "Full".

Product Availability

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

Parameters:

pAllowedItemMetadata - The pAllowedItemMetadata (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllowedItemMetadata

String getAllowedItemMetadata()
                              throws IOException,
                                     AutomationException

The allowed metadata, None, Basic, and Full.

Product Availability

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

Returns:

The pAllowedItemMetadata

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.