com.supermap.data
类 Maps

java.lang.Object
  com.supermap.data.Maps

public class Maps
extends java.lang.Object

地图集合类。

存储地图集合对象所在的工作空间里保存的所有地图，但通过该类只能访问到当前工作空间中包含的地图的名称。对地图的访问和操作必须通过 SuperMap.Mapping 包的 Map 类来进行。

该类用于管理一个工作空间中的所有地图，包括添加、删除、修改工作空间中的地图等操作。其中地图的名称是唯一标识，不可以重复。即使地图所引用的数据或者是数据源被删除，图层仍然存在于工作空间中，只是图层不显示内容，但是当把地图连接到其他的数据源，地图仍然可以显示。

方法摘要

int	add(java.lang.String name, java.lang.String xml) 添加地图到此地图集合对象中。
int	add(java.lang.String name, java.lang.String xml, WorkspaceVersion version) 添加地图到此地图集合对象中，此方法需要指定该地图所在工作空间的版本信息。
void	addAddedListener(MapAddedListener l) 添加一个用于接收添加地图结束事件（MapAddedEvent）的监听器。
void	addClearedListener(MapClearedListener l) 添加一个用于接收清除地图结束事件（MapClearedEvent）的监听器。
void	addClearingListener(MapClearingListener l) 添加一个用于接收地图清除事件（MapClearingEvent）的监听器。
void	addRemovedListener(MapRemovedListener l) 添加一个用于接收地图删除结束事件（MapRemovedEvent）的监听器。
void	addRemovingListener(MapRemovingListener l) 添加一个用于接收地图删除事件（MapRemovingEvent）的监听器。
void	addRenamedListener(MapRenamedListener l) 添加一个用于接收地图名称修改结束事件（MapRenamedEvent）的监听器。
void	addRenamingListener(MapRenamingListener l) 添加一个用于接收地图名称修改事件（MapRenamingEvent）的监听器。
void	clear() 删除此地图集合对象中的所有地图，即工作空间保存的所有地图。
java.lang.String	get(int index) 返回地图集合对象中指定序号的地图的名字。
java.lang.String	getAvailableMapName(java.lang.String name) 根据给定的名称生成合法的与地图集合里其他地图不重名的唯一的使用的地图名称。
int	getCount() 返回当前地图集合中地图对象的总数。
java.lang.String	getMapXML(int index) 从工作空间中返回指定序号的地图的表示地图的 XML 字符串。
java.lang.String	getMapXML(java.lang.String name) 返回地图集合中指定名称的地图的 XML 字符串。
int	indexOf(java.lang.String name) 返回当前地图集合对象中指定名称的地图的序号。
boolean	insert(int index, java.lang.String name, java.lang.String xml) 在地图集合中，在指定序号的位置处添加一个地图，地图的内容由 XML 字符串来确定。
boolean	insert(int index, java.lang.String name, java.lang.String xml, WorkspaceVersion version) 在地图集合中，在指定序号的位置处添加一个地图，地图的内容由 XML 字符串来确定，同时该方法需要指定该地图所在工作空间的版本信息。
boolean	remove(int index) 删除此地图集合对象中指定序号的地图。
boolean	remove(java.lang.String name) 删除此地图集合对象中指定名称的地图。
void	removeAddedListener(MapAddedListener l) 移除一个用于接收添加地图结束事件（MapAddedEvent）的监听器。
void	removeClearedListener(MapClearedListener l) 移除一个用于接收清除地图结束事件（MapClearedEvent）的监听器。
void	removeClearingListener(MapClearingListener l) 移除一个用于接收地图清除事件（MapClearingEvent）的监听器。
void	removeRemovedListener(MapRemovedListener l) 移除一个用于接收地图删除结束事件（MapRemovedEvent）的监听器。
void	removeRemovingListener(MapRemovingListener l) 移除一个用于接收地图删除事件（MapRemovingEvent）的监听器。
void	removeRenamedListener(MapRenamedListener l) 移除一个用于接收地图名称修改结束事件（MapRenamedEvent）的监听器。
void	removeRenamingListener(MapRenamingListener l) 移除一个用于接收地图名称修改事件（MapRenamingEvent）的监听器。
boolean	rename(java.lang.String oldName, java.lang.String newName) 修改地图的名称， 即用新的名称代替地图的旧的名称。
boolean	setMapXML(int index, java.lang.String xml) 将指定的 XML 字符串表示的地图替换地图集合对象中指定序号的地图。
boolean	setMapXML(int index, java.lang.String xml, WorkspaceVersion version) 将指定的 XML 字符串表示的地图替换地图集合对象中指定序号的地图，同时，需要指定新地图所在工作空间的版本信息。
boolean	setMapXML(java.lang.String name, java.lang.String xml) 将指定的 XML 字符串表示的地图替换地图集合对象中指定名称的地图。
boolean	setMapXML(java.lang.String name, java.lang.String xml, WorkspaceVersion version) 将指定的 XML 字符串表示的地图替换地图集合对象中指定名称的地图，同时，需要指定新地图所在工作空间的版本信息。

从类 java.lang.Object 继承的方法

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

方法详细信息

getCount

public int getCount()

返回当前地图集合中地图对象的总数。

返回：

当前地图集合中地图对象的总数。

默认值:

默认值为 0。

get

public java.lang.String get(int index)

返回地图集合对象中指定序号的地图的名字。

参数：

index - 指定地图的序号。

返回：

地图集合对象中指定序号的地图的名字。

抛出：

java.lang.IndexOutOfBoundsException - 如果 index 小于 0 或 index 大于或等于 count 时，其中 count 是地图集合中地图的总数。

add

public int add(java.lang.String name,
               java.lang.String xml)

添加地图到此地图集合对象中。XML 字符串包括地图所有的配置信息（包括地图的名称、背景透明与否、属性信息、图层信息、专题图信息等），主要从 Map 对象的 ToXML 方法中得到中得到，如果想保存地图，需要先用 ToXML 方法将地图转换成 XML 字符串，然后用 Maps 对象的该方法将表示地图的 XML 字符串存储到 Maps 对象中，从而实现将地图添加到地图集合中。

参数：

name - 添加到地图集合中的地图的名称。该名称不区分大小写。

xml - 表示要添加的地图的 XML 字符串。

返回：

新添加的地图在此地图集合对象中的序号。

add

public int add(java.lang.String name,
               java.lang.String xml,
               WorkspaceVersion version)

添加地图到此地图集合对象中，此方法需要指定该地图所在工作空间的版本信息。XML 字符串包括地图所有的配置信息（包括地图的名称、背景透明与否、属性信息、图层信息、专题图信息等），主要从 Map 对象的 ToXML 方法中得到中得到，如果想保存地图，需要先用 ToXML 方法将地图转换成 XML 字符串，然后用 Maps 对象的该方法将表示地图的 XML 字符串存储到 Maps 对象中，从而实现将地图添加到地图集合中。

参数：

name - 添加到地图集合中的地图的名称。该名称不区分大小写。

xml - 表示要添加的地图的 XML 字符串。

version - 地图所在工作空间的版本，从而可以正确解析描述地图的 XML 字符串。

返回：

新添加的地图在此地图集合对象中的序号。

insert

public boolean insert(int index,
                      java.lang.String name,
                      java.lang.String xml)

在地图集合中，在指定序号的位置处添加一个地图，地图的内容由 XML 字符串来确定。

参数：

index - 指定的序号。

name - 指定的地图名称。该名称不区分大小写。

xml - 用来表示待插入地图的 XML 字符串。

返回：

如果插入地图成功，返回 true；否则返回 false。

抛出：

java.lang.IndexOutOfBoundsException - 如果 index 小于0或 index 大于 count 时，其中 count 是地图集合中地图的总数。

insert

public boolean insert(int index,
                      java.lang.String name,
                      java.lang.String xml,
                      WorkspaceVersion version)

在地图集合中，在指定序号的位置处添加一个地图，地图的内容由 XML 字符串来确定，同时该方法需要指定该地图所在工作空间的版本信息。

参数：

index - 指定的序号。

name - 指定的地图名称。该名称不区分大小写。

xml - 用来表示待插入地图的 XML 字符串。

version - 地图所在工作空间的版本，从而可以正确解析描述地图的 XML 字符串。

返回：

如果插入地图成功，返回 true；否则返回 false。

setMapXML

public boolean setMapXML(int index,
                         java.lang.String xml)

将指定的 XML 字符串表示的地图替换地图集合对象中指定序号的地图。

参数：

index - 指定的序号。

xml - 用来替换指定地图的新地图的 XML 字符串表示。

返回：

如果操作成功，返回 true；否则返回 false。

抛出：

java.lang.IndexOutOfBoundsException - 如果 index 小于0或 index 大于等于 count 时，其中 count 是地图集合中地图的总数。

setMapXML

public boolean setMapXML(int index,
                         java.lang.String xml,
                         WorkspaceVersion version)

将指定的 XML 字符串表示的地图替换地图集合对象中指定序号的地图，同时，需要指定新地图所在工作空间的版本信息。

参数：

index - index 指定的序号。

xml - 用来替换指定地图的新地图的 XML 字符串表示。

version - 新地图所在工作空间的版本，从而可以正确解析描述地图的 XML 字符串。

返回：

如果操作成功，返回 true；否则返回 false。

setMapXML

public boolean setMapXML(java.lang.String name,
                         java.lang.String xml)

将指定的 XML 字符串表示的地图替换地图集合对象中指定名称的地图。

参数：

name - 指定的地图名称。该名称不区分大小写。

xml - 指定新地图的 XML 字符串。

返回：

如果操作成功，返回 true；否则返回 false。

setMapXML

public boolean setMapXML(java.lang.String name,
                         java.lang.String xml,
                         WorkspaceVersion version)

将指定的 XML 字符串表示的地图替换地图集合对象中指定名称的地图，同时，需要指定新地图所在工作空间的版本信息。

参数：

name - 指定的地图名称。该名称不区分大小写。

xml - 指定新地图的 XML 字符串。

version - 新地图所在工作空间的版本，从而可以正确解析描述地图的 XML 字符串。

返回：

如果操作成功，返回 true；否则返回 false。

getMapXML

public java.lang.String getMapXML(int index)

从工作空间中返回指定序号的地图的表示地图的 XML 字符串。

参数：

index - 指定的序号。

返回：

地图集合中指定序号的地图的 XML 字符串。

抛出：

java.lang.IndexOutOfBoundsException - 如果 index 小于0或 index 大于等于 count 时，其中 count 是地图集合中地图的总数。

getMapXML

public java.lang.String getMapXML(java.lang.String name)

返回地图集合中指定名称的地图的 XML 字符串。

参数：

name - 指定的地图名称。该名称不区分大小写。

返回：

地图集合中指定名称的地图的 XML 字符串。

remove

public boolean remove(int index)

删除此地图集合对象中指定序号的地图。成功返回 true，否则返回 false。

参数：

index - 待删除地图的序号。

返回：

删除成功，返回 true；否则返回 false。

抛出：

java.lang.IndexOutOfBoundsException - 如果 index 小于0或 index 大于等于 count 时，其中 count 是地图集合中地图的总数。

remove

public boolean remove(java.lang.String name)

删除此地图集合对象中指定名称的地图。成功返回 true，否则返回 false。

参数：

name - 待删除地图的名称。该名称不区分大小写。

返回：

如果删除成功，返回 true；否则返回 false。

clear

public void clear()

删除此地图集合对象中的所有地图，即工作空间保存的所有地图。

indexOf

public int indexOf(java.lang.String name)

返回当前地图集合对象中指定名称的地图的序号。

参数：

name - 指定的地图名称。该名称不区分大小写。

返回：

当前地图集合对象中指定名称的地图的序号。

getAvailableMapName

public java.lang.String getAvailableMapName(java.lang.String name)

根据给定的名称生成合法的与地图集合里其他地图不重名的唯一的使用的地图名称。

地图的名称在同一个地图集合对象或工作空间中必须唯一，否则不能添加新的地图，可以使用该方法返回一个合法的名称，但是该方法得到的名称不能保证一定符合您的最佳要求。

参数：

name - 给定的地图名称。该名称不区分大小写。

返回：

一个合法的与地图集合里其他地图不重名的唯一的使用的地图名称。

rename

public boolean rename(java.lang.String oldName,
                      java.lang.String newName)

修改地图的名称， 即用新的名称代替地图的旧的名称。修改的名称不能与此地图集合对象中已有地图的名称重名，必须合法并且在次地图集合对象中唯一。

参数：

oldName - 需要修改名称的地图的名称。该名称不区分大小写。

newName - 给定的地图的新名称。该名称不区分大小写。

返回：

重命名成功，返回 true；否则返回 false。

addRenamingListener

public void addRenamingListener(MapRenamingListener l)

添加一个用于接收地图名称修改事件（MapRenamingEvent）的监听器。

参数：

l - 一个用于接收地图名称修改事件的监听器。

removeRenamingListener

public void removeRenamingListener(MapRenamingListener l)

移除一个用于接收地图名称修改事件（MapRenamingEvent）的监听器。

参数：

l - 一个用于接收地图名称修改事件的监听器。

addRenamedListener

public void addRenamedListener(MapRenamedListener l)

添加一个用于接收地图名称修改结束事件（MapRenamedEvent）的监听器。

参数：

l - 一个用于接收地图名称修改结束事件的监听器。

removeRenamedListener

public void removeRenamedListener(MapRenamedListener l)

移除一个用于接收地图名称修改结束事件（MapRenamedEvent）的监听器。

参数：

l - 一个用于接收地图名称修改结束事件的监听器。

addRemovingListener

public void addRemovingListener(MapRemovingListener l)

添加一个用于接收地图删除事件（MapRemovingEvent）的监听器。

参数：

l - 一个用于接收地图删除事件的监听器。

removeRemovingListener

public void removeRemovingListener(MapRemovingListener l)

移除一个用于接收地图删除事件（MapRemovingEvent）的监听器。

参数：

l - 一个用于接收地图删除事件的监听器。

addRemovedListener

public void addRemovedListener(MapRemovedListener l)

添加一个用于接收地图删除结束事件（MapRemovedEvent）的监听器。

参数：

l - 一个用于接收地图删除结束事件的监听器。

removeRemovedListener

public void removeRemovedListener(MapRemovedListener l)

移除一个用于接收地图删除结束事件（MapRemovedEvent）的监听器。

参数：

l - 一个用于接收地图删除结束事件的监听器。

addAddedListener

public void addAddedListener(MapAddedListener l)

添加一个用于接收添加地图结束事件（MapAddedEvent）的监听器。

参数：

l - 一个用于接收添加地图结束事件的监听器。

removeAddedListener

public void removeAddedListener(MapAddedListener l)

移除一个用于接收添加地图结束事件（MapAddedEvent）的监听器。

参数：

l - 一个用于接收添加地图结束事件的监听器。

addClearingListener

public void addClearingListener(MapClearingListener l)

添加一个用于接收地图清除事件（MapClearingEvent）的监听器。

参数：

l - 一个用于接收地图清除事件的监听器。

removeClearingListener

public void removeClearingListener(MapClearingListener l)

移除一个用于接收地图清除事件（MapClearingEvent）的监听器。

参数：

l - 一个用于接收地图清除事件的监听器。

addClearedListener

public void addClearedListener(MapClearedListener l)

添加一个用于接收清除地图结束事件（MapClearedEvent）的监听器。

参数：

l - 一个用于接收清除地图结束事件的监听器。

removeClearedListener

public void removeClearedListener(MapClearedListener l)

移除一个用于接收清除地图结束事件（MapClearedEvent）的监听器。

参数：

l - 一个用于接收清除地图结束事件的监听器。