com.esri.arcgis.carto
Interface IKmlConversion

All Superinterfaces:

Serializable

All Known Implementing Classes:

KmlConvertor

public interface IKmlConversion
extends Serializable

Provides access to stateless methods that convert Maps or Layers into KMZ files or streams.

Product Availability

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

Method Summary

IArray	getLayerIDListFromMap(IMap pMap) Get array of numerical layer IDs in hierarchical order from Map.
IArray	getLayerIDListFromMapServer(IMapServer pMapServer) Get array of numerical layer IDs in hierarchical order from MapServer.
byte[]	layerToArray(ILayer pLayer, IQueryFilter pQueryFilter, IPropertySet pKmlParameters) Converts a layer to KML and outputs a KMZ stream.
void	layerToFile(ILayer pLayer, IQueryFilter pQueryFilter, IPropertySet pKmlParameters, String filename) Converts a layer to KML and outputs a KMZ file.
byte[]	mapServerMapToArray(IMapServer pMapServer, IQueryFilter pQueryFilter, IPropertySet pKmlParameters, String[] pLayerIDs) Converts MapServer Map in server environment to KML and outputs a KMZ stream.
void	mapServerMapToFile(IMapServer pMapServer, IQueryFilter pQueryFilter, IPropertySet pKmlParameters, String[] pLayerIDs, String filename) Converts MapServer Map in server environment to KML and outputs a KMZ file.
byte[]	mapToArray(IMap pMap, IQueryFilter pQueryFilter, IPropertySet pKmlParameters, String[] pLayerIDs) Converts Map to KML and outputs a KMZ stream.
void	mapToFile(IMap pMap, IQueryFilter pQueryFilter, IPropertySet pKmlParameters, String[] pLayerIDs, String filename) Converts Map to KML and outputs a KMZ file.

Method Detail

layerToFile

void layerToFile(ILayer pLayer,
                 IQueryFilter pQueryFilter,
                 IPropertySet pKmlParameters,
                 String filename)
                 throws IOException,
                        AutomationException

Converts a layer to KML and outputs a KMZ file.

Product Availability

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

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

pQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

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

filename - The filename (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

layerToArray

byte[] layerToArray(ILayer pLayer,
                    IQueryFilter pQueryFilter,
                    IPropertySet pKmlParameters)
                    throws IOException,
                           AutomationException

Converts a layer to KML and outputs a KMZ stream.

Product Availability

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

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

pQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

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

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

mapToFile

void mapToFile(IMap pMap,
               IQueryFilter pQueryFilter,
               IPropertySet pKmlParameters,
               String[] pLayerIDs,
               String filename)
               throws IOException,
                      AutomationException

Converts Map to KML and outputs a KMZ file.

Product Availability

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

Parameters:

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

pQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

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

pLayerIDs - The pLayerIDs (in)

filename - The filename (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

mapToArray

byte[] mapToArray(IMap pMap,
                  IQueryFilter pQueryFilter,
                  IPropertySet pKmlParameters,
                  String[] pLayerIDs)
                  throws IOException,
                         AutomationException

Converts Map to KML and outputs a KMZ stream.

Product Availability

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

Parameters:

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

pQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

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

pLayerIDs - The pLayerIDs (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

mapServerMapToFile

void mapServerMapToFile(IMapServer pMapServer,
                        IQueryFilter pQueryFilter,
                        IPropertySet pKmlParameters,
                        String[] pLayerIDs,
                        String filename)
                        throws IOException,
                               AutomationException

Converts MapServer Map in server environment to KML and outputs a KMZ file.

Product Availability

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

Parameters:

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

pQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

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

pLayerIDs - The pLayerIDs (in)

filename - The filename (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

mapServerMapToArray

byte[] mapServerMapToArray(IMapServer pMapServer,
                           IQueryFilter pQueryFilter,
                           IPropertySet pKmlParameters,
                           String[] pLayerIDs)
                           throws IOException,
                                  AutomationException

Converts MapServer Map in server environment to KML and outputs a KMZ stream.

Product Availability

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

Parameters:

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

pQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

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

pLayerIDs - The pLayerIDs (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerIDListFromMap

IArray getLayerIDListFromMap(IMap pMap)
                             throws IOException,
                                    AutomationException

Get array of numerical layer IDs in hierarchical order from Map.

Product Availability

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

Parameters:

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

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.

getLayerIDListFromMapServer

IArray getLayerIDListFromMapServer(IMapServer pMapServer)
                                   throws IOException,
                                          AutomationException

Get array of numerical layer IDs in hierarchical order from MapServer.

Product Availability

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

Parameters:

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

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.