com.esri.arcgis.carto
Class MapServerInfo

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

All Implemented Interfaces:

IMapServerInfo, IMapServerInfo2, IMapServerInfo3, IMapServerInfo4, IMapServerInfoAdmin, IMapServerTimeInfo, IMapServerTimeInfo2, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class MapServerInfo
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMapServerInfo, IMapServerInfo2, IXMLSerialize, IPersistStream, IPersist, IMapServerInfo3, IMapServerTimeInfo, IMapServerTimeInfo2, IMapServerInfo4, IMapServerInfoAdmin, java.io.Externalizable

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

Description 'The Map Server Info coclass provides read-only information about a map.' 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

static long

serialVersionUID

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

IID, IID47dd2772_2f22_44df_919b_0d16d8672626, xxDummy

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

IID, IID9211306c_970e_420a_b1a6_b79bf4b49676, xxDummy

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

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

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

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

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

IID0000010c_0000_0000_c000_000000000046

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

IID, IID012a4036_5c4d_4677_bb19_ed4e3ded3d75, xxDummy

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

IID, IIDbf21cba1_c295_48ae_b3d5_e275701bce96, xxDummy

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

IID, IIDef4d782c_e696_4916_a8fe_72ba5652cacc, xxDummy

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

IID, IIDc1a99e4d_3441_4d75_808d_e8f24dcbcbb5, xxDummy

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

IID, IID53b97c0c_74a6_4f78_8ca3_d27f51b80ce8, xxDummy

Constructor Summary

MapServerInfo()
Constructs a MapServerInfo using ArcGIS Engine.

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

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
IColor	getBackgroundColor() The background color of the map (data frame).
IFillSymbol	getBackgroundSymbol() Background symbol of the map (data frame).
IMapServerBookmarks	getBookmarks() The published bookmarks for the map.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getCopyrightText() Copyright information associated with the layer.
IMapDescription	getDefaultMapDescription() The default map settings.
double	getDefaultTimeInterval() The recommended default time interval to be used to animate the layer/table in the service.
int	getDefaultTimeIntervalUnits() The recommended default time interval units to be used to animate the layer/table in the service.
double	getDefaultTimeWindow() The recommended time window expressed in the same units as the time interval for the service.
java.lang.String	getDescription() The description of the map (data frame).
IEnvelope	getExtent() The current extent of the map (data frame).
IEnvelope	getFullExtent() The full extent of the map (data frame).
ITimeExtent	getFullTimeExtent() TimeExtent of interest that the map as been authored.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IMapLayerInfos	getMapLayerInfos() A collection of Map Layer Info objects, each containing information about a layer in the map (data frame).
int	getMapUnits() The units for the map (data frame).
double	getMaxScale() The maximum visible scale for the service.
double	getMinScale() The minimum visible scale for the service.
java.lang.String	getName() The name of the map (data frame).
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IStandaloneTableDescriptions	getStandaloneTableDescriptions() Standalone tables descriptions that can passed in to other methods.
IStandaloneTableInfos	getStandaloneTableInfos() Standalone tables infromation in a given map.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isHasLiveData() Indicates whether the service is being updated frequently with new data.
boolean	isSupportsDynamicLayers() Indicates if this server supports per-request modification to layer properties.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a MapServerInfo.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setMapLayerInfosByRef(IMapLayerInfos rhs1) A collection of Map Layer Info objects, each containing information about a layer in the map (data frame).
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

MapServerInfo

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

Constructs a MapServerInfo using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MapServerInfo

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

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

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

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

Specified by:

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

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the map (data frame).

Specified by:

getName in interface IMapServerInfo

Specified by:

getName in interface IMapServerInfo2

Specified by:

getName in interface IMapServerInfo3

Specified by:

getName in interface IMapServerInfo4

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

The description of the map (data frame). This property is set in the General tab of the Data Frame Properties dialog.

Specified by:

getDescription in interface IMapServerInfo

Specified by:

getDescription in interface IMapServerInfo2

Specified by:

getDescription in interface IMapServerInfo3

Specified by:

getDescription in interface IMapServerInfo4

Returns:

The desc

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFullExtent

public IEnvelope getFullExtent()
                        throws java.io.IOException,
                               AutomationException

The full extent of the map (data frame).

Specified by:

getFullExtent in interface IMapServerInfo

Specified by:

getFullExtent in interface IMapServerInfo2

Specified by:

getFullExtent in interface IMapServerInfo3

Specified by:

getFullExtent in interface IMapServerInfo4

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

The current extent of the map (data frame).

Specified by:

getExtent in interface IMapServerInfo

Specified by:

getExtent in interface IMapServerInfo2

Specified by:

getExtent in interface IMapServerInfo3

Specified by:

getExtent in interface IMapServerInfo4

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapLayerInfos

public IMapLayerInfos getMapLayerInfos()
                                throws java.io.IOException,
                                       AutomationException

A collection of Map Layer Info objects, each containing information about a layer in the map (data frame).

Specified by:

getMapLayerInfos in interface IMapServerInfo

Specified by:

getMapLayerInfos in interface IMapServerInfo2

Specified by:

getMapLayerInfos in interface IMapServerInfo3

Specified by:

getMapLayerInfos in interface IMapServerInfo4

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

public IColor getBackgroundColor()
                          throws java.io.IOException,
                                 AutomationException

The background color of the map (data frame).

Specified by:

getBackgroundColor in interface IMapServerInfo

Specified by:

getBackgroundColor in interface IMapServerInfo2

Specified by:

getBackgroundColor in interface IMapServerInfo3

Specified by:

getBackgroundColor in interface IMapServerInfo4

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBookmarks

public IMapServerBookmarks getBookmarks()
                                 throws java.io.IOException,
                                        AutomationException

The published bookmarks for the map.

Specified by:

getBookmarks in interface IMapServerInfo

Specified by:

getBookmarks in interface IMapServerInfo2

Specified by:

getBookmarks in interface IMapServerInfo3

Specified by:

getBookmarks in interface IMapServerInfo4

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultMapDescription

public IMapDescription getDefaultMapDescription()
                                         throws java.io.IOException,
                                                AutomationException

The default map settings.

Specified by:

getDefaultMapDescription in interface IMapServerInfo

Specified by:

getDefaultMapDescription in interface IMapServerInfo2

Specified by:

getDefaultMapDescription in interface IMapServerInfo3

Specified by:

getDefaultMapDescription in interface IMapServerInfo4

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapUnits

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

The units for the map (data frame).

Specified by:

getMapUnits in interface IMapServerInfo

Specified by:

getMapUnits in interface IMapServerInfo2

Specified by:

getMapUnits in interface IMapServerInfo3

Specified by:

getMapUnits in interface IMapServerInfo4

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackgroundSymbol

public IFillSymbol getBackgroundSymbol()
                                throws java.io.IOException,
                                       AutomationException

Background symbol of the map (data frame).

Specified by:

getBackgroundSymbol in interface IMapServerInfo2

Specified by:

getBackgroundSymbol in interface IMapServerInfo3

Specified by:

getBackgroundSymbol in interface IMapServerInfo4

Returns:

A reference to a com.esri.arcgis.display.IFillSymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCopyrightText

public java.lang.String getCopyrightText()
                                  throws java.io.IOException,
                                         AutomationException

Copyright information associated with the layer.

Specified by:

getCopyrightText in interface IMapServerInfo2

Specified by:

getCopyrightText in interface IMapServerInfo3

Specified by:

getCopyrightText in interface IMapServerInfo4

Returns:

The copyright

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStandaloneTableInfos

public IStandaloneTableInfos getStandaloneTableInfos()
                                              throws java.io.IOException,
                                                     AutomationException

Standalone tables infromation in a given map.

Specified by:

getStandaloneTableInfos in interface IMapServerInfo3

Specified by:

getStandaloneTableInfos in interface IMapServerInfo4

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStandaloneTableDescriptions

public IStandaloneTableDescriptions getStandaloneTableDescriptions()
                                                            throws java.io.IOException,
                                                                   AutomationException

Standalone tables descriptions that can passed in to other methods.

Specified by:

getStandaloneTableDescriptions in interface IMapServerInfo3

Specified by:

getStandaloneTableDescriptions in interface IMapServerInfo4

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFullTimeExtent

public ITimeExtent getFullTimeExtent()
                              throws java.io.IOException,
                                     AutomationException

TimeExtent of interest that the map as been authored.

Specified by:

getFullTimeExtent in interface IMapServerTimeInfo

Specified by:

getFullTimeExtent in interface IMapServerTimeInfo2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultTimeInterval

public double getDefaultTimeInterval()
                              throws java.io.IOException,
                                     AutomationException

The recommended default time interval to be used to animate the layer/table in the service.

Specified by:

getDefaultTimeInterval in interface IMapServerTimeInfo

Specified by:

getDefaultTimeInterval in interface IMapServerTimeInfo2

Returns:

The interval

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultTimeIntervalUnits

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

The recommended default time interval units to be used to animate the layer/table in the service.

Specified by:

getDefaultTimeIntervalUnits in interface IMapServerTimeInfo

Specified by:

getDefaultTimeIntervalUnits in interface IMapServerTimeInfo2

Returns:

A com.esri.arcgis.system.esriTimeUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultTimeWindow

public double getDefaultTimeWindow()
                            throws java.io.IOException,
                                   AutomationException

The recommended time window expressed in the same units as the time interval for the service.

Specified by:

getDefaultTimeWindow in interface IMapServerTimeInfo

Specified by:

getDefaultTimeWindow in interface IMapServerTimeInfo2

Returns:

The duration

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasLiveData

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

Indicates whether the service is being updated frequently with new data.

Specified by:

isHasLiveData in interface IMapServerTimeInfo2

Returns:

The hasLiveData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsDynamicLayers

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

Indicates if this server supports per-request modification to layer properties.

Specified by:

isSupportsDynamicLayers in interface IMapServerInfo4

Returns:

The supportsDynamicLayers

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinScale

public double getMinScale()
                   throws java.io.IOException,
                          AutomationException

The minimum visible scale for the service.

Specified by:

getMinScale in interface IMapServerInfo4

Returns:

The scale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxScale

public double getMaxScale()
                   throws java.io.IOException,
                          AutomationException

The maximum visible scale for the service.

Specified by:

getMaxScale in interface IMapServerInfo4

Returns:

The scale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapLayerInfosByRef

public void setMapLayerInfosByRef(IMapLayerInfos rhs1)
                           throws java.io.IOException,
                                  AutomationException

A collection of Map Layer Info objects, each containing information about a layer in the map (data frame).

Specified by:

setMapLayerInfosByRef in interface IMapServerInfoAdmin

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.IMapLayerInfos (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException