WorkspaceConnectionInfo (iObjects Java Help)

java.lang.Object
- com.supermap.data.InternalHandle
- - com.supermap.data.InternalHandleDisposable
  - - com.supermap.data.WorkspaceConnectionInfo

所有已实现的接口:: IDisposable

public class WorkspaceConnectionInfo
extends com.supermap.data.InternalHandleDisposable

工作空间连接信息类。

包括了进行工作空间连接的所有信息，如所要连接的服务器名称，数据库名称，用户名，密码等。对不同类型的工作空间，其连接信息有所区别，所以在使用该类所包含的成员时，请注意该成员所适用的工作空间类型。

示范代码:

以下代码示范如何通过指定的工作空间连接信息打开工作空间。

 public void workspaceConnectionInfoTest(int m_WsType) {
        // 构造工作空间对象和工作空间连接信息对象
        Workspace workspace = new Workspace();
        WorkspaceConnectionInfo workspaceConnectionInfo = new
                WorkspaceConnectionInfo();
        switch (m_WsType) {

        // SXWU 文件工作空间信息设置
        case 1:
            workspaceConnectionInfo.setType(WorkspaceType.SXWU);
            workspaceConnectionInfo.setServer("../../SampleData/World/World.sxwu");
            break;

        // SMWU 工作空间信息设置
        case 2:
            workspaceConnectionInfo.setType(WorkspaceType.SMWU);
            workspaceConnectionInfo.setServer("../../SampleData/World/World.smwu");
            break;

        // ORACLE 工作空间信息设置
        case 3:
            workspaceConnectionInfo.setType(WorkspaceType.ORACLE);
            workspaceConnectionInfo.setServer("supermap");
            workspaceConnectionInfo.setDatabase("ugo");
            workspaceConnectionInfo.setName("ugo");
            workspaceConnectionInfo.setUser("ugo");
            workspaceConnectionInfo.setPassword("map");
            break;

        // SQL 工作空间信息设置
        case 4:
            workspaceConnectionInfo.setType(WorkspaceType.SQL);
            workspaceConnectionInfo.setServer("ugces");
            workspaceConnectionInfo.setDriver("SQL Server");
            workspaceConnectionInfo.setDatabase("Test");
            workspaceConnectionInfo.setName("SQLSERVER");
            workspaceConnectionInfo.setUser("objects");
            workspaceConnectionInfo.setPassword("java");
            break;

        // 其他情况
        default:
            break;
        }

        // 以指定的工作空间连接信息打开工作空间
        boolean isOpen = workspace.open(workspaceConnectionInfo);

        // 判断工作空间是否打开成功
        if (isOpen) {
            System.out.println("工作空间打开成功");
        } else {
            System.out.println("工作空间打开失败");
            return;
        }

        // 释放工作空间以及其连接信息
        workspaceConnectionInfo.dispose();
        workspace.dispose();
    }

构造器概要

构造器
构造器和说明
`WorkspaceConnectionInfo()` 构造一个新的 WorkspaceConnectionInfo 对象，默认的类型为默认工作空间，即：`WorkspaceType.DEFAULT`。
`WorkspaceConnectionInfo(String file)` 根据指定的参数来构造一个 WorkspaceConnectionInfo 的新对象。
`WorkspaceConnectionInfo(String tns, String database, String name, String user, String password)` 根据指定的参数来构造一个 WorkspaceConnectionInfo 的新对象。
`WorkspaceConnectionInfo(String server, String driver, String database, String name, String user, String password)` 根据指定的参数来构造一个 WorkspaceConnectionInfo 的新对象。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`dispose()` 释放该对象所占用的资源。
`String`	`getDatabase()` 返回工作空间连接的数据库名。
`String`	`getDriver()` 返回使用 ODBC 连接的数据库的驱动程序名。
`String`	`getName()` 返回工作空间在数据库中的名称。
`String`	`getPassword()` 返回登录工作空间连接的数据库或文件的密码。
`String`	`getServer()` 返回数据库服务器名或文件名。
`WorkspaceType`	`getType()` 返回工作空间的类型。
`String`	`getUser()` 返回登录数据库的用户名。
`WorkspaceVersion`	`getVersion()` 返回工作空间的版本。
`void`	`setDatabase(String value)` 设置工作空间连接的数据库名。
`void`	`setDriver(String value)` 设置使用 ODBC 连接的数据库的驱动程序名，对目前支持的数据库工作空间中，SQL Server 数据库使用 ODBC 连接，SQL Server 数据库的驱动程序名如为 SQL Server 或 SQL Native Client。
`void`	`setName(String value)` 设置工作空间在数据库中的名称。
`void`	`setPassword(String value)` 设置登录工作空间连接的数据库或文件的密码。
`void`	`setServer(String value)` 设置数据库服务器名或文件名。
`void`	`setType(WorkspaceType value)` 设置工作空间的类型。
`void`	`setUser(String value)` 设置登录数据库的用户名。
`void`	`setVersion(WorkspaceVersion value)` 设置工作空间的版本。
`String`	`toString()` 将当前工作空间连接信息对象输出为格式化字符串，其格式为:{Name="",Type="",Server="",Database="",Driver="",User="",Password="",Version=""}。

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

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

- 构造器详细资料
  - WorkspaceConnectionInfo
```
public WorkspaceConnectionInfo(String tns,
                               String database,
                               String name,
                               String user,
                               String password)
```
    根据指定的参数来构造一个 WorkspaceConnectionInfo 的新对象。
    
    参数:
    
    tns - Oracle 客户端配置连接名。
    
    database - 数据库名称。
    
    name - 工作空间名称。
    
    user - 用户名。
    
    password - 密码。
  - WorkspaceConnectionInfo
```
public WorkspaceConnectionInfo(String server,
                               String driver,
                               String database,
                               String name,
                               String user,
                               String password)
```
    根据指定的参数来构造一个 WorkspaceConnectionInfo 的新对象。
    
    参数:
    
    server - 服务器名称。
    
    driver - 当采用 ODBC 连接时的驱动程序名称。
    
    database - 数据库名称。
    
    name - 工作空间的名称。
    
    user - 用来登录数据库的用户名。
    
    password - 用来登录数据库的密码。
  - WorkspaceConnectionInfo
```
public WorkspaceConnectionInfo(String file)
```
    根据指定的参数来构造一个 WorkspaceConnectionInfo 的新对象。
    
    参数:
    
    file - SXW 文件路径名。
  - WorkspaceConnectionInfo
```
public WorkspaceConnectionInfo()
```
    构造一个新的 WorkspaceConnectionInfo 对象，默认的类型为默认工作空间，即：WorkspaceType.DEFAULT。
- 方法详细资料
  - getName
```
public String getName()
```
    返回工作空间在数据库中的名称。对文件型的工作空间，此名称设为空。
    
    返回:
    
    工作空间在数据库中的名称。
    
    默认值:
    
    默认值为空字符串。
  - setName
```
public void setName(String value)
```
    设置工作空间在数据库中的名称。对文件型的工作空间，此名称设为空。
    
    参数:
    
    value - 工作空间在数据库中的名称。
  - getType
```
public WorkspaceType getType()
```
    返回工作空间的类型。工作空间可以存储在文件中，也可以存储在数据库中。目前支持的文件型的工作空间的类型为 SXW 格式、 SMW 格式、SXWU 格式和 SMWU 格式的工作空间；数据库型工作空间为 ORACLE 格式和 SQL 格式的工作空间；默认的工作空间类型为未存储的工作空间。
    
    返回:
    
    工作空间的类型。
    
    默认值:
    
    默认值为 DEFAULT。
  - setType
```
public void setType(WorkspaceType value)
```
    设置工作空间的类型。工作空间可以存储在文件中，也可以存储在数据库中。目前支持的文件型的工作空间的类型为 SXW 格式、 SMW 格式、SXWU 格式和 SMWU 格式的工作空间；数据库型工作空间为 ORACLE 格式和 SQL 格式的工作空间；默认的工作空间类型为未存储的工作空间。
    
    参数:
    
    value - 工作空间的类型。
  - getServer
```
public String getServer()
```
    返回数据库服务器名或文件名。
    1. 对于 Oracle 数据库，其服务器名为其 TNS 服务名称；
    2. 对于 SQL Server 数据库，其服务器名为其系统的 DSN（Database Source Name）名称；
    3. 对于 SXW 、SMW、SXWU 和 SMWU 文件，为其文件名称，其中包括路径名称和文件的后缀名。特别地，此处的路径为绝对路径。
    返回:
    
    数据库服务器名或文件的路径名。
    
    默认值:
    
    默认值为空字符串。
  - setServer
```
public void setServer(String value)
```
    设置数据库服务器名或文件名。
    1. 对于 Oracle 数据库，其服务器名为其 TNS 服务名称；
    2. 对于 SQL Server 数据库，其服务器名为其系统的 DNS（Database Source Name）名称；
    3. 对于 SXW 、SMW、SXWU 和 SMWU 文件，其服务器名称为其文件名称，其中包括路径名称和文件的后缀名。特别地，此处的路径为绝对路径。
    参数:
    
    value - 数据库服务器名或文件的路径名。
  - getDatabase
```
public String getDatabase()
```
    返回工作空间连接的数据库名。对数据库类型工作空间适用。
    
    返回:
    
    工作空间连接的数据库名。
    
    默认值:
    
    默认值为空字符串。
  - setDatabase
```
public void setDatabase(String value)
```
    设置工作空间连接的数据库名。对数据库类型工作空间适用。
    
    参数:
    
    value - 工作空间连接的数据库名。
  - getUser
```
public String getUser()
```
    返回登录数据库的用户名。对数据库类型工作空间适用。
    
    返回:
    
    登录数据库的用户名。
    
    默认值:
    
    默认值为空字符串。
  - setUser
```
public void setUser(String value)
```
    设置登录数据库的用户名。对数据库类型工作空间适用。
    
    参数:
    
    value - 登录数据库的用户名。
  - getPassword
```
public String getPassword()
```
    返回登录工作空间连接的数据库或文件的密码。
    
    返回:
    
    登录工作空间连接的数据库或文件的密码。
    
    默认值:
    
    默认值为空字符串。
  - setPassword
```
public void setPassword(String value)
```
    设置登录工作空间连接的数据库或文件的密码。
    此密码的设置只对 Oracle 和 SQL 数据源有效，对本地（UDB）数据源无效。
    
    参数:
    
    value - 登录工作空间连接的数据库或文件的密码。
  - getDriver
```
public String getDriver()
```
    返回使用 ODBC 连接的数据库的驱动程序名。对目前支持的数据库工作空间中，SQL Server 数据库使用 ODBC 连接，SQL Server 数据库的驱动程序名如为 SQL Server 或 SQL Native Client。
    
    返回:
    
    使用 ODBC 连接的数据库的驱动程序名。
    
    默认值:
    
    默认值为空字符串。
  - setDriver
```
public void setDriver(String value)
```
    设置使用 ODBC 连接的数据库的驱动程序名，对目前支持的数据库工作空间中，SQL Server 数据库使用 ODBC 连接，SQL Server 数据库的驱动程序名如为 SQL Server 或 SQL Native Client。
    
    参数:
    
    value - 使用 ODBC 连接的数据库的驱动程序名。
    
    默认值:
    
    默认值为空字符串。
  - getVersion
```
public WorkspaceVersion getVersion()
```
    返回工作空间的版本。
    
    返回:
    
    工作空间的版本。
    
    默认值:
    
    默认值为 UGC70。
  - setVersion
```
public void setVersion(WorkspaceVersion value)
```
    设置工作空间的版本。
    
    参数:
    
    value - 工作空间的版本。
    
    默认值:
    
    默认值为 UGC20。
  - toString
```
public String toString()
```
    将当前工作空间连接信息对象输出为格式化字符串，其格式为:{Name="",Type="",Server="",Database="",Driver="",User="",Password="",Version=""}。
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    表示此工作空间连接信息对象的字符串。
  - dispose
```
public void dispose()
```
    释放该对象所占用的资源。调用该方法之后，此对象不再可用。

类 WorkspaceConnectionInfo

构造器概要

方法概要

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

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

构造器详细资料

WorkspaceConnectionInfo

WorkspaceConnectionInfo

WorkspaceConnectionInfo

WorkspaceConnectionInfo

方法详细资料

getName

setName

getType

setType

getServer

setServer

getDatabase

setDatabase

getUser

setUser

getPassword

setPassword

getDriver

setDriver

getVersion

setVersion

toString

dispose