UGCMapProviderSetting

java.lang.Object
- com.supermap.services.components.spi.MapProviderSetting
- - com.supermap.services.providers.UGCMapProviderSetting

所有已实现的接口:

ConfigValidatable, MultiInstanceSupported, java.io.Serializable
```
public class UGCMapProviderSetting
extends MapProviderSetting
implements java.io.Serializable, ConfigValidatable, MultiInstanceSupported
```
SuperMap 地图服务提供者设置类。

用于设置 SuperMap 地图服务提供者的信息。

另请参阅:

序列化表格

字段概要
- 从类继承的字段 com.supermap.services.components.spi.MapProviderSetting
  dataPrjCoordSysType, watermark

构造器概要

构造器
构造器和说明
`UGCMapProviderSetting()` 默认构造函数。
`UGCMapProviderSetting(UGCMapProviderSetting mapSetting)` 通过 SuperMap 地图服务提供者配置信息构造一个 UGCMapProviderSetting 对象。

方法概要

方法
限定符和类型	方法和说明
`UGCMapProviderSetting`	`clone()`
`boolean`	`equals(java.lang.Object obj)` 判断两个对象是否相等。
`FilteredDatasourceInfo[]`	`getDatasourceInfos()` 返回数据源信息。
`double`	`getDpi()` 获取地图的dpi
`ExcludedFieldsInMap[]`	`getExcludedFieldsInMaps()`
`Style`	`getHighlightLineStyle(java.lang.String mapName)` 获取指定地图的线地物的高亮风格。
`Style`	`getHighlightPointStyle(java.lang.String mapName)` 获取指定地图的点地物的高亮风格。
`Style`	`getHighlightRegionStyle(java.lang.String mapName)` 获取指定地图的面地物的高亮风格。
`int`	`getLayerCountPerDataType()` 返回针对每类数据类型动态制作的最大的图层个数。
`Point2D`	`getLeftTopCorner()` 获取地图切片的起算点。
`ExcludedFieldsInMap`	`getMapFieldExcluded(java.lang.String mapName)`
`java.util.List<java.lang.String>`	`getMapNames()` 获取要发布的地图名称列表。
`java.lang.String`	`getMaps()` 获取发布的地图名称列表。
`MetaTileSetting`	`getMetaTile()`
`int`	`getPoolSize()` 获取地图对象池大小。
`java.lang.String`	`getPreferedPNGType()` 获取使用 PNG 缓存时首选 PNG 图片类型。
`int`	`getQueryExpectCount()` 获取查询期望返回的记录数。
`java.util.List<UGCMapSetting>`	`getUgcMapSettings()` 获取 SuperMap 地图设置信息。
`java.lang.String`	`getVectorTileOutputPath()`
`java.lang.String`	`getWorkspacePath()` 获取 SuperMap 工作空间路径。
`int`	`hashCode()` 获取对象实例的哈希值
`boolean`	`isCacheDisabled()` 返回是否禁用缓存，默认不禁用
`boolean`	`isExtractCacheToFile()` 设置是否在从大文件中提取缓存时生成新的图片文件，该选项目前只支持4.0缓存，且需要设置使用紧凑型缓存为TRUE。
`boolean`	`isFullLabelEnabled()`
`boolean`	`isIgnoreHashcodeWhenUseCache()` 在使用缓存时是否忽略Hashcode，该选项目前支持4.0和5.0缓存
`boolean`	`isInflatDisabled()` 已过时。
`boolean`	`isMapEditable()` 返回地图是否可编辑。
`boolean`	`isMultiInstance()` 返回当前服务提供者是否启用多实例
`boolean`	`isMultiThread()` 获取多线程模式标识。
`boolean`	`isTileCacheReadOnly()`
`boolean`	`isUseCompactCache()` 设置是否在使用紧凑型缓存（即多个缓存图片通过算法集中存储在几个文件中），该选项需要首先设置启用缓存。
`boolean`	`isVectorTileCacheDisabled()`
`boolean`	`isVectorTileCacheReadOnly()`
`void`	`setCacheDisabled(boolean cacheDisabled)` 设置是否禁用缓存，默认不禁用
`void`	`setDatasourceInfos(FilteredDatasourceInfo[] datasourceInfos)` 设置数据源信息。
`void`	`setDpi(double dpi)` 设置地图的dpi
`void`	`setExcludedFieldsInMaps(ExcludedFieldsInMap[] excludedFieldsInMaps)`
`void`	`setExtractCacheToFile(boolean extracCacheToFile)` 设置是否从大文件中提取缓存为图片文件（如果设置为false则提取为二进制内容），该选项目前只支持4.0缓存，且需要设置使用紧凑型缓存为TRUE。
`void`	`setFullLabelEnabled(boolean fullLabelEnabled)`
`void`	`setHighlightLineStyle(java.lang.String mapName, Style lineStyle)` 设置指定地图的线地物的高亮风格。
`void`	`setHighlightPointStyle(java.lang.String mapName, Style pointStyle)` 设置指定地图的点地物的高亮风格。
`void`	`setHighlightRegionStyle(java.lang.String mapName, Style regionStyle)` 设置指定地图的面地物的高亮风格。
`void`	`setIgnoreHashcodeWhenUseCache(boolean ignoreHashcodeWhenUseCache)` 设置在使用缓存时是否忽略Hashcode，该选项目前支持4.0和5.0缓存
`void`	`setInflatDisabled(boolean inflatDisabled)` 已过时。
`void`	`setLayerCountPerDataType(int layerCountPerDataType)` 设置返回针对每类数据类型动态制作的最大的图层个数。
`void`	`setLeftTopCorner(Point2D leftTopCorner)` 设置地图切片的起算点。
`void`	`setMapEditable(boolean mapEditable)` 设置地图是否可编辑。
`void`	`setMaps(java.lang.String maps)` 设置需要发布的地图，若为 null 则发布所有地图。
`void`	`setMetaTile(MetaTileSetting metaTile)`
`void`	`setMultiInstance(boolean isMultiInstance)` 设置当前服务提供者是否启用多实例
`void`	`setMultiThread(boolean multiThread)` 设置使用多线程模式。
`void`	`setPoolSize(int poolSize)` 设置地图对象池大小。
`void`	`setPreferedPNGType(java.lang.String preferedPNGType)` 设置使用 PNG 缓存时首选 PNG 图片类型，目前支持 PNG 及 PNG8，若为 null 则默认使用 PNG。
`void`	`setQueryExpectCount(int queryExpectCount)` 设置查询期望返回的记录数。
`void`	`setTileCacheReadOnly(boolean tileCacheReadOnly)`
`void`	`setUgcMapSettings(java.util.List<UGCMapSetting> ugcMapSettings)` 设置 SuperMap 地图设置信息。
`void`	`setUseCompactCache(boolean useCompactCache)` 设置是否使用紧凑型缓存（即多个缓存图片通过算法集中存储在几个文件中），该选项需要首先设置启用缓存。
`void`	`setVectorTileCacheDisabled(boolean vectorTileCacheDisabled)`
`void`	`setVectorTileCacheReadOnly(boolean vectorTileCacheReadOnly)`
`void`	`setVectorTileOutputPath(java.lang.String vectorTileOutputPath)`
`void`	`setWorkspacePath(java.lang.String workspacePath)` 设置 SuperMap 工作空间路径。
`void`	`validate()` 对配置进行校验

从类继承的方法 com.supermap.services.components.spi.MapProviderSetting
getCacheMode, getCacheVersion, getName, getOutputPath, getOutputSite, getWatermark, setCacheMode, setCacheVersion, setName, setOutputPath, setOutputSite, setWatermark

从类继承的方法 java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - UGCMapProviderSetting
```
public UGCMapProviderSetting()
```
    默认构造函数。
  - UGCMapProviderSetting
```
public UGCMapProviderSetting(UGCMapProviderSetting mapSetting)
```
    通过 SuperMap 地图服务提供者配置信息构造一个 UGCMapProviderSetting 对象。
    
    参数:
    
    mapSetting - SuperMap 地图服务提供者配置信息。
- 方法详细资料
  - getDatasourceInfos
```
public FilteredDatasourceInfo[] getDatasourceInfos()
```
    返回数据源信息。该属性在workspacePath为空时起作用。将根据指定的数据源信息动态创建地图对象，并发布之。
    
    返回:
    
    从以下版本开始:
    
    9.0.0
  - setDatasourceInfos
```
public void setDatasourceInfos(FilteredDatasourceInfo[] datasourceInfos)
```
    设置数据源信息。该属性在workspacePath为空时起作用。将根据指定的数据源信息动态创建地图对象，并发布之。
    
    参数:
    
    datasourceInfos -
    
    从以下版本开始:
    
    9.0.0
  - getLayerCountPerDataType
```
public int getLayerCountPerDataType()
```
    返回针对每类数据类型动态制作的最大的图层个数。如该值为2，则动态制作的地图中，最多包含两个点图层，两个线图层，两个面图层以及两个栅格图层。
    
    返回:
    
    从以下版本开始:
    
    9.0.0
  - setLayerCountPerDataType
```
public void setLayerCountPerDataType(int layerCountPerDataType)
```
    设置返回针对每类数据类型动态制作的最大的图层个数。如该值为2，则动态制作的地图中，最多包含两个点图层，两个线图层，两个面图层以及两个栅格图层。
    
    从以下版本开始:
    
    9.0.0
  - getLeftTopCorner
```
public Point2D getLeftTopCorner()
```
    获取地图切片的起算点。
    
    返回:
  - setLeftTopCorner
```
public void setLeftTopCorner(Point2D leftTopCorner)
```
    设置地图切片的起算点。
  - isMapEditable
```
public boolean isMapEditable()
```
    返回地图是否可编辑。
    为true时允许编辑工作空间中的地图并持久化到磁盘。
    
    返回:
    
    从以下版本开始:
    
    9.1.0
  - setMapEditable
```
public void setMapEditable(boolean mapEditable)
```
    设置地图是否可编辑。
    为true时允许编辑工作空间中的地图并持久化到磁盘。
    
    从以下版本开始:
    
    9.1.0
  - isInflatDisabled
```
@Deprecated
public boolean isInflatDisabled()
```
    已过时。
    
    返回是否在出图是禁用扩大查询，默认为false，即默认开启扩大查询。
    
    返回:
    
    从以下版本开始:
    
    8.1.1
  - setInflatDisabled
```
@Deprecated
public void setInflatDisabled(boolean inflatDisabled)
```
    已过时。
    
    设置是否在出图是禁用扩大查询，默认为false，即默认开启扩大查询。
    
    参数:
    
    inflatDisabled -
    
    从以下版本开始:
    
    8.1.1
  - getWorkspacePath
```
public java.lang.String getWorkspacePath()
```
    获取 SuperMap 工作空间路径。
    
    返回:
    
    SuperMap 工作空间路径。
  - setWorkspacePath
```
public void setWorkspacePath(java.lang.String workspacePath)
```
    设置 SuperMap 工作空间路径。
    
    参数:
    
    workspacePath - SuperMap 工作空间路径。
  - getHighlightPointStyle
```
public Style getHighlightPointStyle(java.lang.String mapName)
```
    获取指定地图的点地物的高亮风格。
    
    参数:
    
    mapName - 地图名称。
    
    返回:
    
    点地物的高亮风格。
  - setHighlightPointStyle
```
public void setHighlightPointStyle(java.lang.String mapName,
                          Style pointStyle)
```
    设置指定地图的点地物的高亮风格。
    
    参数:
    
    mapName - 地图名称。
    
    pointStyle - 点地物的高亮风格。
  - getHighlightLineStyle
```
public Style getHighlightLineStyle(java.lang.String mapName)
```
    获取指定地图的线地物的高亮风格。
    
    参数:
    
    mapName - 地图名称。
    
    返回:
    
    线地物的高亮风格。
  - setHighlightLineStyle
```
public void setHighlightLineStyle(java.lang.String mapName,
                         Style lineStyle)
```
    设置指定地图的线地物的高亮风格。
    
    参数:
    
    mapName - 地图名称。
    
    lineStyle - 线地物的高亮风格。
  - getHighlightRegionStyle
```
public Style getHighlightRegionStyle(java.lang.String mapName)
```
    获取指定地图的面地物的高亮风格。
    
    参数:
    
    mapName - 地图名称。
    
    返回:
    
    面地物的高亮风格。
  - setHighlightRegionStyle
```
public void setHighlightRegionStyle(java.lang.String mapName,
                           Style regionStyle)
```
    设置指定地图的面地物的高亮风格。
    
    参数:
    
    mapName - 地图名称。
    
    regionStyle - 面地物的高亮风格。
  - getMaps
```
public java.lang.String getMaps()
```
    获取发布的地图名称列表。
    
    返回:
    
    地图名称列表。
  - setMaps
```
public void setMaps(java.lang.String maps)
```
    设置需要发布的地图，若为 null 则发布所有地图。多个地图之间以","号隔开。
    
    参数:
    
    maps - 地图名称列表。
  - getMapNames
```
public java.util.List<java.lang.String> getMapNames()
```
    获取要发布的地图名称列表。
    
    返回:
    
    地图名称列表。
  - getUgcMapSettings
```
public java.util.List<UGCMapSetting> getUgcMapSettings()
```
    获取 SuperMap 地图设置信息。
    
    返回:
    
    SuperMap 地图设置信息。
  - setUgcMapSettings
```
public void setUgcMapSettings(java.util.List<UGCMapSetting> ugcMapSettings)
```
    设置 SuperMap 地图设置信息。
    
    参数:
    
    ugcMapSettings - SuperMap 地图设置信息。
  - getDpi
```
public double getDpi()
```
    获取地图的dpi
    
    返回:
    
    从以下版本开始:
    
    10.0.0
  - setDpi
```
public void setDpi(double dpi)
```
    设置地图的dpi
    
    参数:
    
    dpi -
    
    从以下版本开始:
    
    10.0.0
  - hashCode
```
public int hashCode()
```
    获取对象实例的哈希值
    
    覆盖:
    
    hashCode 在类中 java.lang.Object
    
    返回:
    
    哈希值
  - equals
```
public boolean equals(java.lang.Object obj)
```
    判断两个对象是否相等。
    
    覆盖:
    
    equals 在类中 java.lang.Object
    
    参数:
    
    obj - 待比较的对象。
    
    返回:
    
    是否相等的标识，true表示两个对象相等。
  - isMultiThread
```
public boolean isMultiThread()
```
    获取多线程模式标识。
    
    返回:
    
    多线程模式标识，默认为true。
  - setMultiThread
```
public void setMultiThread(boolean multiThread)
```
    设置使用多线程模式。
    
    参数:
    
    multiThread - 多线程标识
  - getPoolSize
```
public int getPoolSize()
```
    获取地图对象池大小。
    
    返回:
    
    地图对象池大小。
  - setPoolSize
```
public void setPoolSize(int poolSize)
```
    设置地图对象池大小。
    
    参数:
    
    poolSize - 地图对象池大小。
  - getPreferedPNGType
```
public java.lang.String getPreferedPNGType()
```
    获取使用 PNG 缓存时首选 PNG 图片类型。
    
    返回:
    
    使用 PNG 缓存时首选 PNG 图片类型。
  - setPreferedPNGType
```
public void setPreferedPNGType(java.lang.String preferedPNGType)
```
    设置使用 PNG 缓存时首选 PNG 图片类型，目前支持 PNG 及 PNG8，若为 null 则默认使用 PNG。目前仅对5.0缓存有效。
    
    参数:
    
    preferedPNGType - 首选 PNG 图片类型。
  - getQueryExpectCount
```
public int getQueryExpectCount()
```
    获取查询期望返回的记录数。
    
    返回:
    
    查询期望返回的记录数。
  - setQueryExpectCount
```
public void setQueryExpectCount(int queryExpectCount)
```
    设置查询期望返回的记录数。
    
    参数:
    
    queryExpectCount -
  - isUseCompactCache
```
public boolean isUseCompactCache()
```
    设置是否在使用紧凑型缓存（即多个缓存图片通过算法集中存储在几个文件中），该选项需要首先设置启用缓存。
    
    返回:
    
    是否使用紧凑型缓存标识。
  - setUseCompactCache
```
public void setUseCompactCache(boolean useCompactCache)
```
    设置是否使用紧凑型缓存（即多个缓存图片通过算法集中存储在几个文件中），该选项需要首先设置启用缓存。
    
    参数:
    
    useCompactCache - 是否使用紧凑型缓存。
  - isExtractCacheToFile
```
public boolean isExtractCacheToFile()
```
    设置是否在从大文件中提取缓存时生成新的图片文件，该选项目前只支持4.0缓存，且需要设置使用紧凑型缓存为TRUE。
    
    返回:
    
    是否从大文件中提取缓存为图片文件标识。
  - setExtractCacheToFile
```
public void setExtractCacheToFile(boolean extracCacheToFile)
```
    设置是否从大文件中提取缓存为图片文件（如果设置为false则提取为二进制内容），该选项目前只支持4.0缓存，且需要设置使用紧凑型缓存为TRUE。
    
    参数:
    
    extracCacheToFile - 是否从大文件中提取缓存为图片文件。
  - isIgnoreHashcodeWhenUseCache
```
public boolean isIgnoreHashcodeWhenUseCache()
```
    在使用缓存时是否忽略Hashcode，该选项目前支持4.0和5.0缓存
    
    返回:
    
    是否忽略Hashcode。
    
    从以下版本开始:
    
    6.1.3
  - setIgnoreHashcodeWhenUseCache
```
public void setIgnoreHashcodeWhenUseCache(boolean ignoreHashcodeWhenUseCache)
```
    设置在使用缓存时是否忽略Hashcode，该选项目前支持4.0和5.0缓存
    
    参数:
    
    ignoreHashcodeWhenUseCache - 是否忽略Hashcode。
    
    从以下版本开始:
    
    6.1.3
  - isCacheDisabled
```
public boolean isCacheDisabled()
```
    返回是否禁用缓存，默认不禁用
    
    返回:
    
    从以下版本开始:
    
    6.1.3
  - setCacheDisabled
```
public void setCacheDisabled(boolean cacheDisabled)
```
    设置是否禁用缓存，默认不禁用
    
    从以下版本开始:
    
    6.1.3
  - validate
```
public void validate()
              throws InvalidConfigException
```
    从接口复制的说明: ConfigValidatable
    
    对配置进行校验
    
    指定者:
    
    validate 在接口中 ConfigValidatable
    
    抛出:
    
    InvalidConfigException
  - isMultiInstance
```
public boolean isMultiInstance()
```
    从接口复制的说明: MultiInstanceSupported
    
    返回当前服务提供者是否启用多实例
    
    指定者:
    
    isMultiInstance 在接口中 MultiInstanceSupported
    
    返回:
  - setMultiInstance
```
public void setMultiInstance(boolean isMultiInstance)
```
    从接口复制的说明: MultiInstanceSupported
    
    设置当前服务提供者是否启用多实例
    
    指定者:
    
    setMultiInstance 在接口中 MultiInstanceSupported
  - getMapFieldExcluded
```
public ExcludedFieldsInMap getMapFieldExcluded(java.lang.String mapName)
```
  - getExcludedFieldsInMaps
```
public ExcludedFieldsInMap[] getExcludedFieldsInMaps()
```
  - setExcludedFieldsInMaps
```
public void setExcludedFieldsInMaps(ExcludedFieldsInMap[] excludedFieldsInMaps)
```
  - getMetaTile
```
public MetaTileSetting getMetaTile()
```
  - setMetaTile
```
public void setMetaTile(MetaTileSetting metaTile)
```
  - isFullLabelEnabled
```
public boolean isFullLabelEnabled()
```
  - setFullLabelEnabled
```
public void setFullLabelEnabled(boolean fullLabelEnabled)
```
  - isTileCacheReadOnly
```
public boolean isTileCacheReadOnly()
```
  - setTileCacheReadOnly
```
public void setTileCacheReadOnly(boolean tileCacheReadOnly)
```
  - isVectorTileCacheDisabled
```
public boolean isVectorTileCacheDisabled()
```
  - setVectorTileCacheDisabled
```
public void setVectorTileCacheDisabled(boolean vectorTileCacheDisabled)
```
  - isVectorTileCacheReadOnly
```
public boolean isVectorTileCacheReadOnly()
```
  - setVectorTileCacheReadOnly
```
public void setVectorTileCacheReadOnly(boolean vectorTileCacheReadOnly)
```
  - setVectorTileOutputPath
```
public void setVectorTileOutputPath(java.lang.String vectorTileOutputPath)
```
  - getVectorTileOutputPath
```
public java.lang.String getVectorTileOutputPath()
```
  - clone
```
public UGCMapProviderSetting clone()
```
    覆盖:
    
    clone 在类中 java.lang.Object

类 UGCMapProviderSetting

字段概要

从类继承的字段 com.supermap.services.components.spi.MapProviderSetting

构造器概要

方法概要

从类继承的方法 com.supermap.services.components.spi.MapProviderSetting

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

构造器详细资料

UGCMapProviderSetting

UGCMapProviderSetting

方法详细资料

getDatasourceInfos

setDatasourceInfos

getLayerCountPerDataType

setLayerCountPerDataType

getLeftTopCorner

setLeftTopCorner

isMapEditable

setMapEditable

isInflatDisabled

setInflatDisabled

getWorkspacePath

setWorkspacePath

getHighlightPointStyle

setHighlightPointStyle

getHighlightLineStyle

setHighlightLineStyle

getHighlightRegionStyle

setHighlightRegionStyle

getMaps

setMaps

getMapNames

getUgcMapSettings

setUgcMapSettings

getDpi

setDpi

hashCode

equals

isMultiThread

setMultiThread

getPoolSize

setPoolSize

getPreferedPNGType

setPreferedPNGType

getQueryExpectCount

setQueryExpectCount

isUseCompactCache

setUseCompactCache

isExtractCacheToFile

setExtractCacheToFile

isIgnoreHashcodeWhenUseCache

setIgnoreHashcodeWhenUseCache

isCacheDisabled

setCacheDisabled

validate

isMultiInstance

setMultiInstance

getMapFieldExcluded

getExcludedFieldsInMaps

setExcludedFieldsInMaps

getMetaTile

setMetaTile

isFullLabelEnabled

setFullLabelEnabled

isTileCacheReadOnly

setTileCacheReadOnly

isVectorTileCacheDisabled

setVectorTileCacheDisabled

isVectorTileCacheReadOnly

setVectorTileCacheReadOnly

setVectorTileOutputPath

getVectorTileOutputPath

clone