org.gvsig.fmap.dal

Interface DatabaseWorkspaceManager

All Superinterfaces:

java.lang.Cloneable, java.lang.Iterable<Function>, LabeledValue<DatabaseWorkspaceManager>, SupportTransactions, SymbolTable

All Known Implementing Classes:

DefaultDatabaseWorkspaceManager

public interface DatabaseWorkspaceManager
extends LabeledValue<DatabaseWorkspaceManager>, SymbolTable, SupportTransactions

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DatabaseWorkspaceManager.DatabaseWorkspaceListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIG_CAN_ANONYMOUS_USER_WRITE_IN_THE_TABLES
static java.lang.String	CONFIG_NAME_STORESREPOSITORYID
static java.lang.String	CONFIG_NAME_STORESREPOSITORYLABEL
static java.lang.String	FIELD_CONFIGURATION_NAME
static java.lang.String	FIELD_CONFIGURATION_VALUE
static java.lang.String	FIELD_REPOSITORY_EXTRA
static java.lang.String	FIELD_REPOSITORY_FLAGS
static java.lang.String	FIELD_REPOSITORY_NAME
static java.lang.String	FIELD_REPOSITORY_PARAMETERS
static java.lang.String	FIELD_RESOURCES_NAME
static java.lang.String	FIELD_RESOURCES_RESOURCE
static int	TABLE_CONFIGURATION
static java.lang.String	TABLE_CONFIGURATION_NAME
static int	TABLE_REPOSITORY
static java.lang.String	TABLE_REPOSITORY_NAME
static int	TABLE_RESOURCES
static java.lang.String	TABLE_RESOURCES_NAME

Method Summary

Modifier and Type	Method and Description
boolean	canAnonymousUserWriteInTheTables()
void	connect()
void	create(java.lang.String id, java.lang.String description) Create and initialize the tables associated with a gvSIG workspace.
void	createTable(int tableid) Create the configuration table indicated in the workspace.
void	createTableRepository(java.lang.String tableName)
void	createTableResources(java.lang.String tableName)
void	disconnect()
void	drop()
void	dropTable(int tableid) Remove the indicated configuration table from the workspace.
boolean	existsTable(int tableid) Check if the indicated configuration table exists in the workspace.
java.lang.String	get(java.lang.String name) Gets the value of a configuration variable associated with this work space.
ResourcesStorage	getAlternativeResourcesStorage(java.lang.String tableName) If the workspace has an alternate resource storage defined, return it.
java.io.File	getBaseFolder()
java.lang.String	getId() Returns the identifier of this workspace.
java.lang.String	getLabel() Returns the label of this workspace.
java.lang.String	getLabelOrId()
ResourcesStorage	getResourcesStorage()
DataServerExplorer	getServerExplorer()
DataServerExplorerParameters	getServerExplorerParameters()
StoresRepository	getStoresRepository() Gets the repository of data stores associated with this workspace.
FeatureStore	getTable(int tableid) Gets the data store associated with the indicated configuration table.
boolean	hasAlternativeResourcesStorage()
boolean	isConnected()
static boolean	isInternalTable(java.lang.String name) Check if the indicated name corresponds to one of the configuration tables of the workspace.
boolean	isValid() Returns true if the connection associated with this object refers to a valid workspace.
boolean	isValidStoresRepository() Returns true if the connection associated with this object refers to a valid workspace with a stores-repository.
boolean	set(java.lang.String name, java.lang.String value) Assigns the indicated value to the configuration variable.
void	setAlternativeResourcesStorage(java.lang.String resourcesPath)
void	setBaseFolder(java.io.File baseFolder)
boolean	writeStoresRepositoryEntry(java.lang.String name, DataStoreParameters parameters) Add a new data store to the workspace.
boolean	writeStoresRepositoryEntry(java.lang.String name, DataStoreParameters parameters, Bitmask mask)

Methods inherited from interface org.gvsig.tools.util.LabeledValue

getValue, label, toString

Methods inherited from interface org.gvsig.expressionevaluator.SymbolTable

addSymbolTable, clone, containsSymbolTable, exists, function, functions, getName, isSQLCompatible, localfunctions, localvariables, removeSymbolTable, value, variables

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.gvsig.tools.lang.Cloneable

cloneQuietly, cloneQuietly

Methods inherited from interface org.gvsig.fmap.dal.SupportTransactions

getTransaction, setTransaction

Field Detail

CONFIG_CAN_ANONYMOUS_USER_WRITE_IN_THE_TABLES

static final java.lang.String CONFIG_CAN_ANONYMOUS_USER_WRITE_IN_THE_TABLES

See Also:

Constant Field Values

TABLE_REPOSITORY_NAME

static final java.lang.String TABLE_REPOSITORY_NAME

See Also:

Constant Field Values

TABLE_RESOURCES_NAME

static final java.lang.String TABLE_RESOURCES_NAME

See Also:

Constant Field Values

TABLE_CONFIGURATION_NAME

static final java.lang.String TABLE_CONFIGURATION_NAME

See Also:

Constant Field Values

FIELD_RESOURCES_NAME

static final java.lang.String FIELD_RESOURCES_NAME

See Also:

Constant Field Values

FIELD_RESOURCES_RESOURCE

static final java.lang.String FIELD_RESOURCES_RESOURCE

See Also:

Constant Field Values

FIELD_REPOSITORY_NAME

static final java.lang.String FIELD_REPOSITORY_NAME

See Also:

Constant Field Values

FIELD_REPOSITORY_PARAMETERS

static final java.lang.String FIELD_REPOSITORY_PARAMETERS

See Also:

Constant Field Values

FIELD_REPOSITORY_FLAGS

static final java.lang.String FIELD_REPOSITORY_FLAGS

See Also:

Constant Field Values

FIELD_REPOSITORY_EXTRA

static final java.lang.String FIELD_REPOSITORY_EXTRA

See Also:

Constant Field Values

FIELD_CONFIGURATION_NAME

static final java.lang.String FIELD_CONFIGURATION_NAME

See Also:

Constant Field Values

FIELD_CONFIGURATION_VALUE

static final java.lang.String FIELD_CONFIGURATION_VALUE

See Also:

Constant Field Values

TABLE_RESOURCES

static final int TABLE_RESOURCES

See Also:

Constant Field Values

TABLE_REPOSITORY

static final int TABLE_REPOSITORY

See Also:

Constant Field Values

TABLE_CONFIGURATION

static final int TABLE_CONFIGURATION

See Also:

Constant Field Values

CONFIG_NAME_STORESREPOSITORYID

static final java.lang.String CONFIG_NAME_STORESREPOSITORYID

See Also:

Constant Field Values

CONFIG_NAME_STORESREPOSITORYLABEL

static final java.lang.String CONFIG_NAME_STORESREPOSITORYLABEL

See Also:

Constant Field Values

Method Detail

isInternalTable

static boolean isInternalTable(java.lang.String name)

Check if the indicated name corresponds to one of the configuration tables of the workspace.

Parameters:

name - to check.

Returns:

true if the name is that of a configuration table.

getId

java.lang.String getId()

Returns the identifier of this workspace.

Returns:

the id.

getServerExplorer

DataServerExplorer getServerExplorer()

getServerExplorerParameters

DataServerExplorerParameters getServerExplorerParameters()

getLabel

java.lang.String getLabel()

Returns the label of this workspace.

Specified by:

getLabel in interface LabeledValue<DatabaseWorkspaceManager>

Returns:

the label value.

get

java.lang.String get(java.lang.String name)

Gets the value of a configuration variable associated with this work space.

Parameters:

name - of the variable to consult

Returns:

the value of the variable

set

boolean set(java.lang.String name,
            java.lang.String value)

Assigns the indicated value to the configuration variable.

Parameters:

name - of the variable.

value - value to set.

Returns:

true if can assign the value.

getStoresRepository

StoresRepository getStoresRepository()

Gets the repository of data stores associated with this workspace.

Returns:

the data stores repository.

writeStoresRepositoryEntry

boolean writeStoresRepositoryEntry(java.lang.String name,
                                   DataStoreParameters parameters)

Add a new data store to the workspace.

Parameters:

name - of the data store.

parameters - to open the data store.

Returns:

true if ok.

writeStoresRepositoryEntry

boolean writeStoresRepositoryEntry(java.lang.String name,
                                   DataStoreParameters parameters,
                                   Bitmask mask)

canAnonymousUserWriteInTheTables

boolean canAnonymousUserWriteInTheTables()

existsTable

boolean existsTable(int tableid)

Check if the indicated configuration table exists in the workspace.

Parameters:

tableid -

Returns:

true if the table exists.

createTable

void createTable(int tableid)

Create the configuration table indicated in the workspace.

Parameters:

tableid - identifier of the configuration table to create.

dropTable

void dropTable(int tableid)

Remove the indicated configuration table from the workspace.

Parameters:

tableid - identifier of the configuration table to remove.

getTable

FeatureStore getTable(int tableid)

Gets the data store associated with the indicated configuration table.

Parameters:

tableid - identifier of the configuration table to get.

Returns:

the FeatureStore of the configuration table.

isValid

boolean isValid()

Returns true if the connection associated with this object refers to a valid workspace. At least the variable "StoresRepository.id" must be defined.

Returns:

isValidStoresRepository

boolean isValidStoresRepository()

Returns true if the connection associated with this object refers to a valid workspace with a stores-repository. At least the repositories table must exist and the variable "StoresRepository.id" must be defined.

Returns:

getAlternativeResourcesStorage

ResourcesStorage getAlternativeResourcesStorage(java.lang.String tableName)

If the workspace has an alternate resource storage defined, return it. If don't have it, return null.

Parameters:

tableName -

Returns:

the alternate resource storage.

hasAlternativeResourcesStorage

boolean hasAlternativeResourcesStorage()

setAlternativeResourcesStorage

void setAlternativeResourcesStorage(java.lang.String resourcesPath)

create

void create(java.lang.String id,
            java.lang.String description)

Create and initialize the tables associated with a gvSIG workspace.

Parameters:

id - of the workspace

description - of the workspace

drop

void drop()

getBaseFolder

java.io.File getBaseFolder()

setBaseFolder

void setBaseFolder(java.io.File baseFolder)

getResourcesStorage

ResourcesStorage getResourcesStorage()

connect

void connect()

disconnect

void disconnect()

createTableRepository

void createTableRepository(java.lang.String tableName)

createTableResources

void createTableResources(java.lang.String tableName)

isConnected

boolean isConnected()

getLabelOrId

java.lang.String getLabelOrId()