com.esri.arcgis.carto
Interface IMapReader

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMapReaderProxy, MapReader

public interface IMapReader
extends java.io.Serializable

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

Description: 'Provides access to members that support reading a map document.' 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	IIDf543891f_8c43_487d_839e_83d1cd4af33c
static int	xxDummy Deprecated. Internal use only

Method Summary

void	close() Clears out all of the map objects in memory.
IPropertySet	getDocumentInfo() A set of name-value pairs for properties set for the map document (mxd only).
IMap	getMap(int index) The map object at the specified index.
int	getMapCount() The number of maps (data frames) in the document.
IPageLayout	getPageLayout() The PageLayout object.
Picture	getThumbnail() The thumbnail stored in the map document.
boolean	isAccessInternalObjects() Indicates whether the internal objects of the map can be exposed to external clients.
void	open(java.lang.String filePath) Opens an mxd or pmf file stored at the specified path.

Field Detail

IIDf543891f_8c43_487d_839e_83d1cd4af33c

static final int IIDf543891f_8c43_487d_839e_83d1cd4af33c

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

open

void open(java.lang.String filePath)
          throws java.io.IOException,
                 AutomationException

Opens an mxd or pmf file stored at the specified path.

Parameters:

filePath - The filePath (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

close

void close()
           throws java.io.IOException,
                  AutomationException

Clears out all of the map objects in memory. The client must call the Open method again before attempting any other operations.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapCount

int getMapCount()
                throws java.io.IOException,
                       AutomationException

The number of maps (data frames) in the document.

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMap

IMap getMap(int index)
            throws java.io.IOException,
                   AutomationException

The map object at the specified index.

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.carto.IMap

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPageLayout

IPageLayout getPageLayout()
                          throws java.io.IOException,
                                 AutomationException

The PageLayout object.

Returns:

A reference to a com.esri.arcgis.carto.IPageLayout

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThumbnail

Picture getThumbnail()
                     throws java.io.IOException,
                            AutomationException

The thumbnail stored in the map document.

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentInfo

IPropertySet getDocumentInfo()
                             throws java.io.IOException,
                                    AutomationException

A set of name-value pairs for properties set for the map document (mxd only). These properties are string values set in the map document's Map Properties dialog and include: Title, Subject, Author, Category, Keywords and Comments.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAccessInternalObjects

boolean isAccessInternalObjects()
                                throws java.io.IOException,
                                       AutomationException

Indicates whether the internal objects of the map can be exposed to external clients.

Returns:

The bAccess

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.