com.supermap.services.components.commontypes

类 ClearCacheParam

java.lang.Object

com.supermap.services.components.commontypes.ClearCacheParam

所有已实现的接口:

java.io.Serializable

public class ClearCacheParam
extends java.lang.Object
implements java.io.Serializable

清除缓存参数。

该类用于设置清除缓存时要用到的参数。在进行清除缓存操作时，必须设置地图名称 mapName，清除缓存操作将清除指定地图的缓存中满足合法参数条件的缓存图片。

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
Rectangle2D	bounds 要清除的缓存的地图范围。
java.lang.String	cacheMode 缓存模式。
java.lang.String	customParams 自定义参数。
java.lang.String	mapName 地图名称。
double[]	mapScales 要清除的缓存的显示比例尺数组。
int	picHeight 要清除的缓存图片的高度，单位：像素。
int	picWidth 要清除的缓存图片的宽度, 单位：像素。

构造器概要

构造器

构造器和说明
ClearCacheParam() 构造函数。
ClearCacheParam(ClearCacheParam clearCacheParam) 构造函数。

方法概要

方法

限定符和类型	方法和说明
boolean	equals(java.lang.Object obj) 比较指定对象与当前 ClearCacheParam 对象是否相等。
int	hashCode() 获取清除缓存参数对象的哈希码值。

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

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

字段详细资料

mapName

public java.lang.String mapName

地图名称。

必设字段。如果不设置地图名称将不会进行清除缓存操作。默认值为 NULL。

如果只设置地图名称，而 ClearCacheParam 的其他参数都为空或者设置非法，则清除指定地图名称的所有缓存。

bounds

public Rectangle2D bounds

要清除的缓存的地图范围。

1、如果只设置了合法的 bounds 参数，没有设置 mapScales、picWidth 和 picHeight 参数，则清除指定地图的地图范围；

2、如果设置了合法的 bounds 和 mapScales 参数，那么在指定地图的缓存中，同时满足 bounds 和 mapScales 的缓存将被清除；

3、如果设置了合法的 bounds、picWidth 和 picHeight 参数，那么在指定地图的缓存中，同时满足 bounds、picWidth 和 picHeight 的缓存将被清除；

4、如果设置了合法的 bounds、mapScales、picWidth 和 picHeight 参数，那么在指定地图的缓存中，同时满足这四个参数条件的缓存将被清除。

默认值为 NULL。

当该参数非空，并且 bounds.leftBottom 和 bounds.rightTop 同时不为空时，该参数合法。

mapScales

public double[] mapScales

要清除的缓存的显示比例尺数组。

1、如果设置了合法的 mapScales 参数，没有设置 bounds、picWidth 和 picHeight 参数，则清除指定地图在该比例尺下的缓存；

2、如果设置了合法的 bounds 和 mapScales 参数，那么在指定地图的缓存中，同时满足 bounds 和 mapScales 的缓存将被清除；

3、如果设置了合法的 mapScales、picWidth 和 picHeight 参数，那么在指定地图的缓存中，同时满足 mapScales、picWidth 和 picHeight 的缓存将被清除；

4、如果设置了合法的 bounds、mapScales、picWidth 和 picHeight 参数，那么在指定地图的缓存中，同时满足这四个参数条件的缓存将被清除。

默认值为 NULL。

当该比例尺数组的长度大于0并且每一个值大于0时，该参数合法。

picWidth

public int picWidth

要清除的缓存图片的宽度, 单位：像素。

该参数必须与 picHeight 参数同时设置。

1、如果设置了合法的 picWidth 和 picHeight 参数，没有设置 bounds 和 mapScales 参数，则清除指定地图的图片大小为 picWidth 和 picHeight 的缓存；

2、如果设置了合法的 picWidth、picHeight 和 bounds 参数，那么在指定地图的缓存中，同时满足 picWidth、picHeight 和 bounds 的缓存将被清除；

3、如果设置了合法的 picWidth、picHeight 和 mapScales 参数，那么在指定地图的缓存中，同时满足 picWidth、picHeight 和 mapScales 的缓存将被清除；

4、如果设置了合法的 bounds、mapScales、picWidth 和 picHeight 参数，那么在指定地图的缓存中，同时满足这四个参数条件的缓存将被清除。

默认值为-1。

当该参数的值大于0时，该参数合法。

picHeight

public int picHeight

要清除的缓存图片的高度，单位：像素。

该参数必须与 picWidth 参数同时设置。

1、如果设置了合法的 picWidth 和 picHeight 参数，没有设置 bounds、picWidth 和 picHeight 参数，则清除指定地图的图片大小为 picWidth 和 picHeight 的缓存；

2、如果设置了合法的 picWidth、picHeight 和 bounds 参数，那么在指定地图的缓存中，同时满足 picWidth、picHeight 和 bounds 的缓存将被清除；

3、如果设置了合法的 picWidth、picHeight 和 mapScales 参数，那么在指定地图的缓存中，同时满足 picWidth、picHeight 和 mapScales 的缓存将被清除；

4、如果设置了合法的 bounds、mapScales、picWidth 和 picHeight 参数，那么在指定地图的缓存中，同时满足这四个参数条件的缓存将被清除。

默认值为-1。

当该参数的值大于0时，该参数合法。

customParams

public java.lang.String customParams

自定义参数。

cacheMode

public java.lang.String cacheMode

缓存模式。

构造器详细资料

ClearCacheParam

public ClearCacheParam()

构造函数。

ClearCacheParam

public ClearCacheParam(ClearCacheParam clearCacheParam)

构造函数。

参数:

clearCacheParam - 清除缓存参数对象。

抛出:

java.lang.IllegalArgumentException - 当清除缓存参数对象为 Null 时抛出异常。

方法详细资料

hashCode

public int hashCode()

获取清除缓存参数对象的哈希码值。

覆盖:

hashCode 在类中 java.lang.Object

返回:

哈希码值。

equals

public boolean equals(java.lang.Object obj)

比较指定对象与当前 ClearCacheParam 对象是否相等。

覆盖:

equals 在类中 java.lang.Object

参数:

obj - 与当前 ClearCacheParam 对象进行比较的对象。

返回:

如果指定对象跟清除缓存参数对象相等，则返回 true，否则，返回 false。