com.esri.arcgis.globecore
Interface IKmlConvertor

All Superinterfaces:

Serializable

All Known Subinterfaces:

IKmlConvertor2

All Known Implementing Classes:

KmlConvertor

public interface IKmlConvertor
extends Serializable

Provides access to the public Kml Convertor methods.

Product Availability

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

Method Summary

byte[]	convertToArray() The Convert method.
void	convertToFile(String filename) The Convert method.
IEnvelope	getBBox() The bounding box of the map.
int	getDPI() Get DPI property.
String	getEndPointUrl() Get EndPointUrl property.
int	getFeatureLimit() Get FeatureLimit value.
int	getIconSize() Get IconSize property.
IArray	getIDList() Returns Layer hierarchy.
int	getImageSize() Get ImageSize property.
IPropertySet	getKmlParameters() Get list of verious KML parameters.
String	getLayerIDs() Get layer ID string.
int	getPaletteSize() Get PaletteSize property.
double	getScale() Get Scale property.
String	getWorkingDirectory() Get WorkingDirectory property.
boolean	isComposite() Get Composite property.
boolean	isIgnoreScaleFactor() Get ignore scale factor property.
boolean	isIgnoreVisibility() Get ignore visibility property.
boolean	isVectorsToRasters() Get VectorsToRasters property.
void	setBBox(IEnvelope pArea) The bounding box of the map.
void	setComposite(boolean pComposite) Get Composite property.
void	setDPI(int pDpi) Get DPI property.
void	setEndPointUrl(String pUrl) Get EndPointUrl property.
void	setFeatureLimit(int pFeatureLimit) Get FeatureLimit value.
void	setIconSize(int psize) Get IconSize property.
void	setIgnoreScaleFactor(boolean pIgnoreScaleFactor) Get ignore scale factor property.
void	setIgnoreVisibility(boolean pIgnoreVisibility) Get ignore visibility property.
void	setImageSize(int psize) Get ImageSize property.
void	setKmlParameters(IPropertySet pProps) Get list of verious KML parameters.
void	setLayerIDs(String pLayerIDs) Get layer ID string.
void	setMap(IMap pMap) Intialize by IMap object.
void	setMapServer(IMapServer pMapServer) Intialize by IMapServer object.
void	setPaletteSize(int psize) Get PaletteSize property.
void	setScale(double pScale) Get Scale property.
void	setVectorsToRasters(boolean pVectorsToRasters) Get VectorsToRasters property.
void	setWorkingDirectory(String pWorkingDirectory) Get WorkingDirectory property.

Method Detail

setMap

void setMap(IMap pMap)
            throws IOException,
                   AutomationException

Intialize by IMap object.

Product Availability

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

Parameters:

pMap - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapServer

void setMapServer(IMapServer pMapServer)
                  throws IOException,
                         AutomationException

Intialize by IMapServer object.

Product Availability

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

Parameters:

pMapServer - A reference to a com.esri.arcgis.carto.IMapServer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkingDirectory

String getWorkingDirectory()
                           throws IOException,
                                  AutomationException

Get WorkingDirectory property.

Product Availability

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

Returns:

The pWorkingDirectory

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWorkingDirectory

void setWorkingDirectory(String pWorkingDirectory)
                         throws IOException,
                                AutomationException

Get WorkingDirectory property.

Product Availability

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

Parameters:

pWorkingDirectory - The pWorkingDirectory (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBBox

IEnvelope getBBox()
                  throws IOException,
                         AutomationException

The bounding box of the map.

Product Availability

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

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.

setBBox

void setBBox(IEnvelope pArea)
             throws IOException,
                    AutomationException

The bounding box of the map.

Product Availability

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

Parameters:

pArea - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToFile

void convertToFile(String filename)
                   throws IOException,
                          AutomationException

The Convert method.

Product Availability

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

Parameters:

filename - The filename (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToArray

byte[] convertToArray()
                      throws IOException,
                             AutomationException

The Convert method.

Product Availability

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

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerIDs

String getLayerIDs()
                   throws IOException,
                          AutomationException

Get layer ID string.

Product Availability

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

Returns:

The pLayerIDs

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerIDs

void setLayerIDs(String pLayerIDs)
                 throws IOException,
                        AutomationException

Get layer ID string.

Product Availability

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

Parameters:

pLayerIDs - The pLayerIDs (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isComposite

boolean isComposite()
                    throws IOException,
                           AutomationException

Get Composite property.

Product Availability

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

Returns:

The pComposite

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setComposite

void setComposite(boolean pComposite)
                  throws IOException,
                         AutomationException

Get Composite property.

Product Availability

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

Parameters:

pComposite - The pComposite (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVectorsToRasters

boolean isVectorsToRasters()
                           throws IOException,
                                  AutomationException

Get VectorsToRasters property.

Product Availability

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

Returns:

The pVectorsToRasters

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVectorsToRasters

void setVectorsToRasters(boolean pVectorsToRasters)
                         throws IOException,
                                AutomationException

Get VectorsToRasters property.

Product Availability

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

Parameters:

pVectorsToRasters - The pVectorsToRasters (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageSize

int getImageSize()
                 throws IOException,
                        AutomationException

Get ImageSize property.

Product Availability

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

Returns:

The psize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setImageSize

void setImageSize(int psize)
                  throws IOException,
                         AutomationException

Get ImageSize property.

Product Availability

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

Parameters:

psize - The psize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPaletteSize

int getPaletteSize()
                   throws IOException,
                          AutomationException

Get PaletteSize property.

Product Availability

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

Returns:

The psize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPaletteSize

void setPaletteSize(int psize)
                    throws IOException,
                           AutomationException

Get PaletteSize property.

Product Availability

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

Parameters:

psize - The psize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIconSize

int getIconSize()
                throws IOException,
                       AutomationException

Get IconSize property.

Product Availability

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

Returns:

The psize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIconSize

void setIconSize(int psize)
                 throws IOException,
                        AutomationException

Get IconSize property.

Product Availability

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

Parameters:

psize - The psize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getScale

double getScale()
                throws IOException,
                       AutomationException

Get Scale property.

Product Availability

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

Returns:

The pScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setScale

void setScale(double pScale)
              throws IOException,
                     AutomationException

Get Scale property.

Product Availability

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

Parameters:

pScale - The pScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDPI

int getDPI()
           throws IOException,
                  AutomationException

Get DPI property.

Product Availability

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

Returns:

The pDpi

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDPI

void setDPI(int pDpi)
            throws IOException,
                   AutomationException

Get DPI property.

Product Availability

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

Parameters:

pDpi - The pDpi (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndPointUrl

String getEndPointUrl()
                      throws IOException,
                             AutomationException

Get EndPointUrl property.

Product Availability

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

Returns:

The pUrl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndPointUrl

void setEndPointUrl(String pUrl)
                    throws IOException,
                           AutomationException

Get EndPointUrl property.

Product Availability

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

Parameters:

pUrl - The pUrl (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIgnoreScaleFactor

boolean isIgnoreScaleFactor()
                            throws IOException,
                                   AutomationException

Get ignore scale factor property.

Product Availability

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

Returns:

The pIgnoreScaleFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIgnoreScaleFactor

void setIgnoreScaleFactor(boolean pIgnoreScaleFactor)
                          throws IOException,
                                 AutomationException

Get ignore scale factor property.

Product Availability

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

Parameters:

pIgnoreScaleFactor - The pIgnoreScaleFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIgnoreVisibility

boolean isIgnoreVisibility()
                           throws IOException,
                                  AutomationException

Get ignore visibility property.

Product Availability

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

Returns:

The pIgnoreVisibility

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIgnoreVisibility

void setIgnoreVisibility(boolean pIgnoreVisibility)
                         throws IOException,
                                AutomationException

Get ignore visibility property.

Product Availability

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

Parameters:

pIgnoreVisibility - The pIgnoreVisibility (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureLimit

int getFeatureLimit()
                    throws IOException,
                           AutomationException

Get FeatureLimit value.

Product Availability

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

Returns:

The pFeatureLimit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureLimit

void setFeatureLimit(int pFeatureLimit)
                     throws IOException,
                            AutomationException

Get FeatureLimit value.

Product Availability

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

Parameters:

pFeatureLimit - The pFeatureLimit (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKmlParameters

IPropertySet getKmlParameters()
                              throws IOException,
                                     AutomationException

Get list of verious KML parameters.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKmlParameters

void setKmlParameters(IPropertySet pProps)
                      throws IOException,
                             AutomationException

Get list of verious KML parameters.

Product Availability

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

Parameters:

pProps - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIDList

IArray getIDList()
                 throws IOException,
                        AutomationException

Returns Layer hierarchy.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.