com.esri.arcgis.carto
Interface IKmlConversion

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IKmlConversionProxy, KmlConvertor

public interface IKmlConversion
extends java.io.Serializable

COM Interface 'IKmlConversion'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to stateless methods that convert Maps or Layers into KMZ files or streams.' 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 =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDda7f107f_ae0c_4684_90d1_68b3570560e7
           
static int xxDummy
          Deprecated. Internal use only
 
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, java.lang.String filename)
          Converts a layer to KML and outputs a KMZ file.
 byte[] mapServerMapToArray(IMapServer pMapServer, IQueryFilter pQueryFilter, IPropertySet pKmlParameters, java.lang.String[] pLayerIDs)
          Converts MapServer Map in server environment to KML and outputs a KMZ stream.
 void mapServerMapToFile(IMapServer pMapServer, IQueryFilter pQueryFilter, IPropertySet pKmlParameters, java.lang.String[] pLayerIDs, java.lang.String filename)
          Converts MapServer Map in server environment to KML and outputs a KMZ file.
 byte[] mapToArray(IMap pMap, IQueryFilter pQueryFilter, IPropertySet pKmlParameters, java.lang.String[] pLayerIDs)
          Converts Map to KML and outputs a KMZ stream.
 void mapToFile(IMap pMap, IQueryFilter pQueryFilter, IPropertySet pKmlParameters, java.lang.String[] pLayerIDs, java.lang.String filename)
          Converts Map to KML and outputs a KMZ file.
 

Field Detail

IIDda7f107f_ae0c_4684_90d1_68b3570560e7

static final int IIDda7f107f_ae0c_4684_90d1_68b3570560e7
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

layerToFile

void layerToFile(ILayer pLayer,
                 IQueryFilter pQueryFilter,
                 IPropertySet pKmlParameters,
                 java.lang.String filename)
                 throws java.io.IOException,
                        AutomationException
Converts a layer to KML and outputs a KMZ file.

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

layerToArray

byte[] layerToArray(ILayer pLayer,
                    IQueryFilter pQueryFilter,
                    IPropertySet pKmlParameters)
                    throws java.io.IOException,
                           AutomationException
Converts a layer to KML and outputs a KMZ stream.

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

mapToFile

void mapToFile(IMap pMap,
               IQueryFilter pQueryFilter,
               IPropertySet pKmlParameters,
               java.lang.String[] pLayerIDs,
               java.lang.String filename)
               throws java.io.IOException,
                      AutomationException
Converts Map to KML and outputs a KMZ file.

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

mapToArray

byte[] mapToArray(IMap pMap,
                  IQueryFilter pQueryFilter,
                  IPropertySet pKmlParameters,
                  java.lang.String[] pLayerIDs)
                  throws java.io.IOException,
                         AutomationException
Converts Map to KML and outputs a KMZ stream.

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

mapServerMapToFile

void mapServerMapToFile(IMapServer pMapServer,
                        IQueryFilter pQueryFilter,
                        IPropertySet pKmlParameters,
                        java.lang.String[] pLayerIDs,
                        java.lang.String filename)
                        throws java.io.IOException,
                               AutomationException
Converts MapServer Map in server environment to KML and outputs a KMZ file.

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

mapServerMapToArray

byte[] mapServerMapToArray(IMapServer pMapServer,
                           IQueryFilter pQueryFilter,
                           IPropertySet pKmlParameters,
                           java.lang.String[] pLayerIDs)
                           throws java.io.IOException,
                                  AutomationException
Converts MapServer Map in server environment to KML and outputs a KMZ stream.

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

getLayerIDListFromMap

IArray getLayerIDListFromMap(IMap pMap)
                             throws java.io.IOException,
                                    AutomationException
Get array of numerical layer IDs in hierarchical order from Map.

Parameters:
pMap - A reference to a com.esri.arcgis.carto.IMap (in)
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerIDListFromMapServer

IArray getLayerIDListFromMapServer(IMapServer pMapServer)
                                   throws java.io.IOException,
                                          AutomationException
Get array of numerical layer IDs in hierarchical order from MapServer.

Parameters:
pMapServer - A reference to a com.esri.arcgis.carto.IMapServer (in)
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.