Package com.esri.arcgisruntime.localserver

Class EnterpriseGeodatabaseWorkspace

java.lang.Object

com.esri.arcgisruntime.localserver.DynamicWorkspace

com.esri.arcgisruntime.localserver.EnterpriseGeodatabaseWorkspace

public final class EnterpriseGeodatabaseWorkspace
extends DynamicWorkspace

An enterprise geodatabase workspace can be used to create a SublayerSource which displays data from the database.

Since:

100.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EnterpriseGeodatabaseWorkspace.ConnectionType	The types of ArcSDE connection.

Method Summary

Modifier and Type	Method	Description
static EnterpriseGeodatabaseWorkspace	createFromConnectionFile(String id, String connectionFilePath)	Creates an enterprise geodatabase workspace based on a connection file.
static EnterpriseGeodatabaseWorkspace	createFromConnectionFile(String id, String connectionFilePath, boolean lockVersion)	Creates an enterprise geodatabase workspace based on a connection file.
static EnterpriseGeodatabaseWorkspace	createFromConnectionString(String id, String connectionString)	Creates an enterprise geodatabase workspace based on a connection string.
static EnterpriseGeodatabaseWorkspace	createFromConnectionString(String id, String connectionString, boolean lockVersion)	Creates an enterprise geodatabase workspace based on a connection string.
String	getConnection()	Gets the connection string or connection file path used to create this workspace.
EnterpriseGeodatabaseWorkspace.ConnectionType	getConnectionType()	Gets the type of connection used to create this workspace.
boolean	isLockVersion()	Returns true if the connection cannot be changed to another version of the geodatabase, false otherwise.

Methods inherited from class com.esri.arcgisruntime.localserver.DynamicWorkspace

getId

Methods inherited from class java.lang.Object

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

Method Detail

createFromConnectionFile

public static EnterpriseGeodatabaseWorkspace createFromConnectionFile(String id,
                                                                      String connectionFilePath)

Creates an enterprise geodatabase workspace based on a connection file.

Parameters:

id - the ID of this workspace

connectionFilePath - the path to the connection file

Returns:

a new EnterpriseGeodatabaseWorkspace

Throws:

IllegalArgumentException - if id is null or empty

IllegalArgumentException - if connectionFilePath is null or empty

Since:

100.1.0

createFromConnectionFile

public static EnterpriseGeodatabaseWorkspace createFromConnectionFile(String id,
                                                                      String connectionFilePath,
                                                                      boolean lockVersion)

Creates an enterprise geodatabase workspace based on a connection file.

Parameters:

id - the ID of this workspace

connectionFilePath - the path to the connection file

lockVersion - true if the connection cannot be changed to another version of the geodatabase

Returns:

a new EnterpriseGeodatabaseWorkspace

Throws:

IllegalArgumentException - if id is null or empty

IllegalArgumentException - if connectionFilePath is null or empty

Since:

100.1.0

createFromConnectionString

public static EnterpriseGeodatabaseWorkspace createFromConnectionString(String id,
                                                                        String connectionString)

Creates an enterprise geodatabase workspace based on a connection string.

Parameters:

id - the ID of this workspace

connectionString - the connection string

Returns:

a new EnterpriseGeodatabaseWorkspace

Throws:

IllegalArgumentException - if id is null or empty

IllegalArgumentException - if connectionString is null or empty

Since:

100.1.0

createFromConnectionString

public static EnterpriseGeodatabaseWorkspace createFromConnectionString(String id,
                                                                        String connectionString,
                                                                        boolean lockVersion)

Creates an enterprise geodatabase workspace based on a connection string.

Parameters:

id - the ID of this workspace

connectionString - the connection string

lockVersion - true if the connection cannot be changed to another version of the geodatabase

Returns:

a new EnterpriseGeodatabaseWorkspace

Throws:

IllegalArgumentException - if id is null or empty

IllegalArgumentException - if connectionString is null or empty

Since:

100.1.0

isLockVersion

public boolean isLockVersion()

Returns true if the connection cannot be changed to another version of the geodatabase, false otherwise. Default value is true.

Returns:

true if locked, false otherwise

Since:

100.1.0

getConnection

public String getConnection()

Gets the connection string or connection file path used to create this workspace.

Returns:

the connection string or connection file path

Since:

100.1.0

getConnectionType

public EnterpriseGeodatabaseWorkspace.ConnectionType getConnectionType()

Gets the type of connection used to create this workspace.

Returns:

the connection type

Since:

100.1.0