com.esri.arcgis.carto
Class MapReader

java.lang.Object
  com.esri.arcgis.carto.MapReader

All Implemented Interfaces:

IMapReader, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class MapReader
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMapReader, ISupportErrorInfo

COM Class 'MapReader'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'The MapReader component provides programmatic access to the contents of 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.carto.IMapReader

IID, IIDf543891f_8c43_487d_839e_83d1cd4af33c, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

MapReader()
Constructs a MapReader using ArcGIS Engine.

MapReader(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MapReader theMapReader = (MapReader) obj;

Method Summary

void	close() Clears out all of the map objects in memory.
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
IPropertySet	getDocumentInfo() A set of name-value pairs for properties set for the map document (mxd only).
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use 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.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
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.
void	release() Release a MapReader.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapReader

public MapReader()
          throws java.io.IOException,
                 java.net.UnknownHostException

Constructs a MapReader using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MapReader

public MapReader(java.lang.Object obj)
          throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MapReader theMapReader = (MapReader) obj;

Construct a MapReader using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MapReader.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a MapReader.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

open

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

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

Specified by:

open in interface IMapReader

Parameters:

filePath - The filePath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

close

public 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.

Specified by:

close in interface IMapReader

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapCount

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

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

Specified by:

getMapCount in interface IMapReader

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMap

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

The map object at the specified index.

Specified by:

getMap in interface IMapReader

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

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

The PageLayout object.

Specified by:

getPageLayout in interface IMapReader

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

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

The thumbnail stored in the map document.

Specified by:

getThumbnail in interface IMapReader

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

public 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.

Specified by:

getDocumentInfo in interface IMapReader

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

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

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

Specified by:

isAccessInternalObjects in interface IMapReader

Returns:

The bAccess

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.