com.fr.base

类 MapXMLHelper

java.lang.Object

com.fr.config.Configuration

com.fr.base.MapXMLHelper

所有已实现的接口:

MapHelper, FCloneable, java.lang.Cloneable

public class MapXMLHelper
extends Configuration
implements MapHelper

地图辅助, 储存地图的一些固定属性 以便于多模板, 同工程协作, 在保存或者打开模板时 需要读取以下内容, 保持和工程同步.

版本:

创建时间：2012-10-29 下午05:08:51

作者:

kunsnat E-mail:kunsnat@gmail.com

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	MAP_CATEGORY_CUSTOMER
static java.lang.String	MAP_CATEGORY_NATION
static java.lang.String	MAP_CATEGORY_PROVINCE
static java.lang.String	MAP_CATEGORY_WORLD

构造器概要

构造器

构造器和说明
MapXMLHelper()

方法概要

方法

限定符和类型	方法和说明
void	addCateNames(java.lang.String cateName, java.lang.Object value) 按照分类添加名称
JSONArray	asJsonOfCategoriedMaps() 将地图 按照四个分类 对应数组 输出到JSON对象中.
void	clearCateNames() 清空地图存储中的默认列表.
boolean	containsMapName(java.lang.String name) 判断是否包含名称为name的地图属性@MapAttr
static MapXMLHelper	getInstance() 返回唯一初始化的地图辅助配置信息实例
java.lang.Object	getMapAttr(java.lang.String name) 根据名字取得地图属性@MapAttr
java.util.List	getNamesListWithCateName(java.lang.Object name) 返回对应名称的地图列表, 默认分为四个列表: 世界, 国家, 省市, 自定义.
java.lang.String	getNameSpace() 配置类的自定义前缀（配置类的命名空间），需要自己实现
static boolean	hasLoadMap() 判断是否加载了地图.
java.lang.String[]	mapAllNames() 按照基础的中文拼音顺序, 获取所有地图名称的列表数组.
void	pushMapAttr(java.lang.String name, java.lang.Object mapAttr) 按照名字 存放地图属性@MapAttr
void	removeMapAttr(java.lang.String name) 移除相关地图 remove the mapAttr
void	reset() 重置清空属性.
void	setCateMaps(java.util.Map map)
void	setMapAttra(java.util.Map map)
void	writerMapSourceWhenEditMap()

从类继承的方法 com.fr.config.Configuration

clone, initialize, mirror

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

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

字段详细资料

MAP_CATEGORY_WORLD

public static final java.lang.String MAP_CATEGORY_WORLD

MAP_CATEGORY_NATION

public static final java.lang.String MAP_CATEGORY_NATION

MAP_CATEGORY_PROVINCE

public static final java.lang.String MAP_CATEGORY_PROVINCE

MAP_CATEGORY_CUSTOMER

public static final java.lang.String MAP_CATEGORY_CUSTOMER

构造器详细资料

MapXMLHelper

public MapXMLHelper()

方法详细资料

getInstance

public static MapXMLHelper getInstance()

返回唯一初始化的地图辅助配置信息实例

hasLoadMap

public static boolean hasLoadMap()

判断是否加载了地图.

返回:

boolean 是否加载地图 true 表示已加载.

getNameSpace

public java.lang.String getNameSpace()

从类复制的说明: Configuration

配置类的自定义前缀（配置类的命名空间），需要自己实现

指定者:

getNameSpace 在类中 Configuration

返回:

setMapAttra

public void setMapAttra(java.util.Map map)

setCateMaps

public void setCateMaps(java.util.Map map)

addCateNames

public void addCateNames(java.lang.String cateName,
                java.lang.Object value)

按照分类添加名称

指定者:

addCateNames 在接口中 MapHelper

参数:

cateName - 分类名

value - 值.

getNamesListWithCateName

public java.util.List getNamesListWithCateName(java.lang.Object name)

返回对应名称的地图列表, 默认分为四个列表: 世界, 国家, 省市, 自定义.

指定者:

getNamesListWithCateName 在接口中 MapHelper

参数:

name - 地图中四个分类的名字

返回:

List

clearCateNames

public void clearCateNames()

清空地图存储中的默认列表.

指定者:

clearCateNames 在接口中 MapHelper

reset

public void reset()

重置清空属性.

pushMapAttr

public void pushMapAttr(java.lang.String name,
               java.lang.Object mapAttr)

按照名字 存放地图属性@MapAttr

参数:

name - 地图名称

mapAttr - 地图对应属性.

getMapAttr

public java.lang.Object getMapAttr(java.lang.String name)

根据名字取得地图属性@MapAttr

参数:

name - 地图名称.

removeMapAttr

public void removeMapAttr(java.lang.String name)

移除相关地图 remove the mapAttr

参数:

name - 地图名称.

asJsonOfCategoriedMaps

public JSONArray asJsonOfCategoriedMaps()
                                 throws JSONException

将地图 按照四个分类 对应数组 输出到JSON对象中.

返回:

JSONArray 返回json数组

抛出:

JSONException - 抛出json错误

containsMapName

public boolean containsMapName(java.lang.String name)

判断是否包含名称为name的地图属性@MapAttr

参数:

name - 地图名称.

返回:

boolean 是否包含地图名

mapAllNames

public java.lang.String[] mapAllNames()

按照基础的中文拼音顺序, 获取所有地图名称的列表数组.

返回:

返回排序之后的数组.

writerMapSourceWhenEditMap

public void writerMapSourceWhenEditMap()