ChartEnvironment (iObjects Java Help)

java.lang.Object
- com.supermap.data.InternalHandle
- - com.supermap.data.InternalHandleDisposable
  - - com.supermap.chart.ChartEnvironment

所有已实现的接口:

IDisposable
```
public class ChartEnvironment
extends com.supermap.data.InternalHandleDisposable
```
海图环境配置类。用于通过管理 ChartConfig.xml 配置文件，从而实现增加和删除显示风格、获取和设置字典文件路径等功能。
ChartConfig.xml 中存储了海图的各种显示风格、字典文件路径等信息。通过 ChartEnvironment 提供的各种属性、方法，可以读取和修改此配置文件。如下图所示：

通过该类可以管理海图的显示风格和字典文件路径。

1. <Display></Display>标签中列举了已有的显示风格，显示风格对应于 <Style></Style> 标签，每个显示风格又由查找表和颜色表信息构成，分别对应 <LookupTables></LookupTables> 标签和 <ColorTables></ColorTables> 标签；查找表的信息包含点、线、面三种类型的查找表文件路径信息。如上面的配置文件中，包含 ENC 和 PaperChart 两种显示风格，通过该类可以增加和删除一种显示风格；

2. <Dictionary></Dictionary> 标签中包含 S57Object、S57Attribute、Agency、S57ObjectSpecs 及 S57InfoSpecs 等字典文件路径信息，通过该类可以读取或修改这些字典文件路径。

构造器概要

构造器
构造器和说明

ChartEnvironment()
构造一个新的 ChartEnvironment 对象。

构造器
构造器和说明
`ChartEnvironment()` 构造一个新的 ChartEnvironment 对象。

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`addNewDisplayStyle(String newDisplayStyleName, ChartDisplayStyleType displayStyleType)` 在配置文件中增加一种新的显示风格。
`void`	`dispose()` 释放 ChartEnvironment 所占有的本地资源。
`String`	`getAgencyFile()` 返回机构编码字典文件路径。
`String`	`getAreaLookupFile(String displayStyleName, boolean isSymbolized)` 根据指定的参数获取面对象风格查找表文件路径。
`String`	`getColourTable(String displayStyleName, ColourModeChart colourMode)` 根据指定的参数获取颜色表文件路径。
`String[]`	`getDisplayStyleNames()` 从配置文件中获取所有已设置的显示风格的名称。
`ChartDisplayStyleType`	`getDisplayStyleType(String displayStyleName)` 通过指定显示风格的名称获取对应的显示风格类型。
`static long`	`getHandle(com.supermap.data.InternalHandle obj)`
`String`	`getLineLookupFile(String displayStyleName)` 通过指定显示风格的名称获取线对象风格查找表文件路径。
`String`	`getPointLookupFile(String displayStyleName, boolean isSimplified)` 根据指定的参数获取点对象风格查找表文件路径。
`String`	`getS57AttributeFile()` 返回 S-57 属性字典文件路径。
`String`	`getS57ObjectFile()` 返回 S-57 物标字典文件路径。
`String`	`getS57SpecsInfoFile()` 返回 S-57 产品规范基本信息文件路径。
`String`	`getS57SpecsObjectFile()` 返回 S-57 产品规范物标字典文件路径。
`boolean`	`removeDisplayStyle(String displayStyleName)` 通过指定显示风格名称移除配置文件中对应的显示风格类型。
`void`	`setAgencyFile(String value)` 设置机构编码字典文件路径。
`boolean`	`setAreaLookupFile(String value, String displayStyleName, boolean isSymbolized)` 设置面对象风格查找表文件路径。
`boolean`	`setColourTable(String value, String displayStyleName, ColourModeChart colourMode)` 设置颜色表文件路径。
`static void`	`setHandle(com.supermap.data.InternalHandle obj, long handle)`
`static void`	`setIsDisposable(com.supermap.data.InternalHandleDisposable obj, boolean disposable)`
`boolean`	`setLineLookupFile(String value, String displayStyleName)` 设置线对象风格查找表文件路径。
`boolean`	`setPointLookupFile(String value, String displayStyleName, boolean isSimplified)` 设置点对象风格查找表文件路径。
`void`	`setS57AttributeFile(String value)` 设置S-57 属性字典文件路径。
`void`	`setS57ObjectFile(String value)` 设置 S-57 物标字典文件路径。
`void`	`setS57SpecsInfoFile(String value)` 设置 S-57 产品规范基本信息文件路径。
`void`	`setS57SpecsObjectFile(String value)` 设置 S-57 产品规范物标字典文件路径。

从类继承的方法 com.supermap.data.InternalHandleDisposable
makeSureNativeObjectLive

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

- 构造器详细资料
  - ChartEnvironment
```
public ChartEnvironment()
```
    构造一个新的 ChartEnvironment 对象。
- 方法详细资料
  - dispose
```
public void dispose()
```
    释放 ChartEnvironment 所占有的本地资源。
  - getS57ObjectFile
```
public String getS57ObjectFile()
```
    返回 S-57 物标字典文件路径。
    
    返回:
    
    S-57 物标字典文件路径。
  - setS57ObjectFile
```
public void setS57ObjectFile(String value)
```
    设置 S-57 物标字典文件路径。
    
    参数:
    
    value - S-57 物标字典文件路径。
  - getS57AttributeFile
```
public String getS57AttributeFile()
```
    返回 S-57 属性字典文件路径。
    
    返回:
    
    S-57 属性字典文件路径。
  - setS57AttributeFile
```
public void setS57AttributeFile(String value)
```
    设置S-57 属性字典文件路径。
    
    参数:
    
    value - S-57 属性字典文件路径。
  - getAgencyFile
```
public String getAgencyFile()
```
    返回机构编码字典文件路径。
    
    返回:
    
    机构编码字典文件路径。
  - setAgencyFile
```
public void setAgencyFile(String value)
```
    设置机构编码字典文件路径。
    
    参数:
    
    value - 机构编码字典文件路径。
  - getS57SpecsObjectFile
```
public String getS57SpecsObjectFile()
```
    返回 S-57 产品规范物标字典文件路径。
    
    返回:
    
    S-57 产品规范物标字典文件路径。
  - setS57SpecsObjectFile
```
public void setS57SpecsObjectFile(String value)
```
    设置 S-57 产品规范物标字典文件路径。
    
    参数:
    
    value - S-57 产品规范物标字典文件路径。
  - getS57SpecsInfoFile
```
public String getS57SpecsInfoFile()
```
    返回 S-57 产品规范基本信息文件路径。
    
    返回:
    
    S-57 产品规范基本信息文件路径。
  - setS57SpecsInfoFile
```
public void setS57SpecsInfoFile(String value)
```
    设置 S-57 产品规范基本信息文件路径。
    
    参数:
    
    value - S-57 产品规范基本信息文件路径。
  - getDisplayStyleNames
```
public String[] getDisplayStyleNames()
```
    从配置文件中获取所有已设置的显示风格的名称。
    
    返回:
    
    获取到的显示风格名称集合。
  - addNewDisplayStyle
```
public boolean addNewDisplayStyle(String newDisplayStyleName,
                                  ChartDisplayStyleType displayStyleType)
```
    在配置文件中增加一种新的显示风格。
    
    参数:
    
    newDisplayStyleName - 指定的新增显示风格的名称。
    
    displayStyleType - 指定的显示风格。
    
    返回:
    
    一个布尔值，如果成功返回 true，否则返回 false。
  - removeDisplayStyle
```
public boolean removeDisplayStyle(String displayStyleName)
```
    通过指定显示风格名称移除配置文件中对应的显示风格类型。
    
    参数:
    
    displayStyleName - 指定的显示风格名称。
    
    返回:
    
    一个布尔值，如果成功返回 true，否则返回 false。
  - getPointLookupFile
```
public String getPointLookupFile(String displayStyleName,
                                 boolean isSimplified)
```
    根据指定的参数获取点对象风格查找表文件路径。
    需要注意，对于 ChartDisplayStyleType.PAPERCHART 类型的显示风格，即纸质海图显示风格，isSymbolized 参数无效。
    
    参数:
    
    displayStyleName - 指定的显示风格名称。
    
    isSimplified - 指定是否是简单符号，如果为 false，则获取的是传统海图点符号查找表文件。
    
    返回:
    
    获取到的点对象风格查找表文件路径。
  - setPointLookupFile
```
public boolean setPointLookupFile(String value,
                                  String displayStyleName,
                                  boolean isSimplified)
```
    设置点对象风格查找表文件路径。
    通过此方法设置点对象风格查找表文件路径时，需要注意：
    
    1. 如果配置文件中不含有此显示风格，需要先调用 addNewDisplayStyle() 方法创建一种显示风格；
    
    2. 对于 ChartDisplayStyleType.PAPERCHART 类型的显示风格，即纸质海图显示风格，isSimplified 参数无效。
    
    参数:
    
    value - 指定的风格查找表文件路径。
    
    displayStyleName - 指定的显示风格名称。
    
    isSimplified - 指定是否是简单点符号。如果为 false，则设置的是传统纸质海图点符号的查找表文件。
    
    返回:
    
    一个布尔值，如果成功返回 true，否则返回 false。
  - getLineLookupFile
```
public String getLineLookupFile(String displayStyleName)
```
    通过指定显示风格的名称获取线对象风格查找表文件路径。
    
    参数:
    
    displayStyleName - 指定的显示风格名称。
    
    返回:
    
    获取到的线对象风格查找表文件路径。
  - setLineLookupFile
```
public boolean setLineLookupFile(String value,
                                 String displayStyleName)
```
    设置线对象风格查找表文件路径。
    注意：如果配置文件中不含有此显示风格，需要先调用 addNewDisplayStyle() 方法创建一种显示风格。
    
    参数:
    
    value - 指定的风格查找表文件路径。
    
    displayStyleName - 指定的显示风格名称。
    
    返回:
    
    一个布尔值，如果成功返回 true，否则返回 false。
  - getAreaLookupFile
```
public String getAreaLookupFile(String displayStyleName,
                                boolean isSymbolized)
```
    根据指定的参数获取面对象风格查找表文件路径。
    需要注意，对于 ChartDisplayStyleType.PAPERCHART 类型的显示风格，即纸质海图显示风格，isSymbolized 参数无效。
    
    参数:
    
    displayStyleName - 指定的显示风格名称。
    
    isSymbolized - 指定是否符号化边界。如果为 false，则获取不符号化边界的面对象风格查找表。
    
    返回:
    
    获取到的面对象风格查找表文件路径。
  - setAreaLookupFile
```
public boolean setAreaLookupFile(String value,
                                 String displayStyleName,
                                 boolean isSymbolized)
```
    设置面对象风格查找表文件路径。
    通过此方法设置面对象风格查找表文件路径时，需要注意：
    
    1. 如果配置文件中不含有此显示风格，需要先调用 addNewDisplayStyle() 方法创建一种显示风格；
    
    2. 对于 ChartDisplayStyleType.PAPERCHART 类型的显示风格，即纸质海图显示风格，isSymbolized 参数无效。
    
    参数:
    
    value - 指定的风格查找表文件路径。
    
    displayStyleName - 指定的显示风格名称。
    
    isSymbolized - 指定是否符号化边界，如果为 false，则设置的是不符号化边界的面对象风格查找表。
    
    返回:
    
    一个布尔值，如果成功返回 true，否则返回 false。
  - getColourTable
```
public String getColourTable(String displayStyleName,
                             ColourModeChart colourMode)
```
    根据指定的参数获取颜色表文件路径。
    需要注意的是，对于 ChartDisplayStyleType.PAPERCHART 类型的显示风格，即对纸质海图显示风格，colourMode 参数无效，获取的永远是 ColourModeChart.Day_Bright 模式。
    
    参数:
    
    displayStyleName - 指定的显示风格名称。
    
    colourMode - 指定的颜色模式。
    
    返回:
    
    获取到的颜色表文件路径。
  - setColourTable
```
public boolean setColourTable(String value,
                              String displayStyleName,
                              ColourModeChart colourMode)
```
    设置颜色表文件路径。
    需要注意的是，对于 ChartDisplayStyleType.PAPERCHART 类型的显示风格，即对纸质海图显示风格，colourMode 参数无效，设置的永远是 ColourModeChart.Day_Bright 模式。
    
    参数:
    
    value - 指定的颜色表文件路径。
    
    displayStyleName - 指定的显示风格名称。
    
    colourMode - 指定的颜色模式。
    
    返回:
    
    一个布尔值，如果成功返回 true，否则返回 false。
  - getDisplayStyleType
```
public ChartDisplayStyleType getDisplayStyleType(String displayStyleName)
```
    通过指定显示风格的名称获取对应的显示风格类型。
    
    参数:
    
    displayStyleName - 指定的显示风格的名称。
    
    返回:
    
    获取到的显示风格类型。
  - setIsDisposable
```
public static void setIsDisposable(com.supermap.data.InternalHandleDisposable obj,
                                   boolean disposable)
```
  - getHandle
```
public static long getHandle(com.supermap.data.InternalHandle obj)
```
  - setHandle
```
public static void setHandle(com.supermap.data.InternalHandle obj,
                             long handle)
```

类 ChartEnvironment

构造器概要

方法概要

从类继承的方法 com.supermap.data.InternalHandleDisposable

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

构造器详细资料

ChartEnvironment

方法详细资料

dispose

getS57ObjectFile

setS57ObjectFile

getS57AttributeFile

setS57AttributeFile

getAgencyFile

setAgencyFile

getS57SpecsObjectFile

setS57SpecsObjectFile

getS57SpecsInfoFile

setS57SpecsInfoFile

getDisplayStyleNames

addNewDisplayStyle

removeDisplayStyle

getPointLookupFile

setPointLookupFile

getLineLookupFile

setLineLookupFile

getAreaLookupFile

setAreaLookupFile

getColourTable

setColourTable

getDisplayStyleType

setIsDisposable

getHandle

setHandle