com.mockturtlesolutions.snifflib.reposconfig.database

Interface RepositoryConnectivity

All Known Subinterfaces:

CanonicalSetConnectivity, CanonicalVariableConnectivity, DblMatrixConnectivity, FlatFileConnectivity, FlatFileSetConnectivity, FlatFileStorageConnectivity, GaussianProposalConnectivity, GLMStorageConnectivity, GridElementConnectivity, GroovyScriptConnectivity, ImageFileConnectivity, ImageStackConnectivity, MatrixStorageConnectivity, MCMCRunConnectivity, MCMCStorageConnectivity, MCMCTraceConnectivity, MyrtleConnectivity, ParameterSetConnectivity, ProposalDistributionConnectivity, ReservedFunctionConnectivity, SQLConnectivity, StatisticalModelStorageConnectivity, TimerStorageConnectivity, WedgeConnectivity, WordStorageConnectivity, XppBettyConnectivity, XppOdeConnectivity

All Known Implementing Classes:

CanonicalSetPostgreSQLConnection, CanonicalSetSQLConnection, CanonicalSetXMLConnection, CanonicalVariablePostgreSQLConnection, CanonicalVariableSQLConnection, CanonicalVariableXMLConnection, DblMatrixSQLConnection, DblMatrixSQLiteConnection, DblMatrixXMLConnection, FlatFileSetSQLConnection, FlatFileSetXMLConnection, FlatFileSQLConnection, FlatFileXMLConnection, GaussianProposalSQLConnection, GaussianProposalXMLConnection, GLMStoragePostgreSQLConnection, GLMStorageSQLConnection, GLMStorageXMLConnection, GridElementXMLConnection, GroovyScriptPostgreSQLConnection, GroovyScriptSQLiteConnection, GroovyScriptXMLConnection, ImageFileSQLConnection, ImageFileXMLConnection, ImageStackXMLConnection, MatrixStorageSQLConnection, MatrixStorageXMLConnection, MCMCRunPostgreSQLConnection, MCMCRunXMLConnection, MCMCStoragePostgreSQLConnection, MCMCStorageSQLConnection, MCMCStorageXMLConnection, MCMCTracePostgreSQLConnection, MCMCTraceSQLConnection, MCMCTraceXMLConnection, MyrtleXMLConnection, ParameterSetPostgreSQLConnection, ParameterSetSQLConnection, ParameterSetSQLiteConnection, ParameterSetXMLConnection, ProposalDistributionSQLConnection, ProposalDistributionXMLConnection, RepositoryPostgreSQLConnection, RepositorySQLConnection, RepositorySQLiteConnection, RepositoryXMLConnection, ReservedFunctionXMLConnection, SQLConnection, StatisticalModelPostgreSQLConnection, StatisticalModelSQLConnection, StatisticalModelXMLConnection, TimerStorageSQLConnection, TimerStorageXMLConnection, WedgeXMLConnection, WordStorageSQLConnection, WordStorageXMLConnection, XppBettyXMLConnection, XppOdePostgreSQLConnection, XppOdeSQLiteConnection, XppOdeXMLConnection

public interface RepositoryConnectivity

This is a tagging interface for all classes that connect in some way to a repository. Tagging such implmenting classes with this interface can be useful for reflection.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the connection fo the repository.
boolean	createStorage(java.lang.Class iface, java.lang.String storagename) Creates a storage instance on the repository.
java.lang.Class	determineClassOf(java.lang.String storagename) Returns a Class object for the type of storage that would result from instantiating the named storage.
RepositoryMaintenance	getCustodian() Gets an instance appropriate for the creation, deletion or other privilaged or atypical operations on the storages housed within a reporitory.
java.lang.Class	getFindNameDialogForClass(java.lang.Class storageclass)
java.lang.String	getRepository() Returns the name associated with the repository to which the connection is established.
RepositoryStorage	getStorage(java.lang.String storagename) Gets the storage having the given nickname from the currently connected repository.
RepositoryStorageNameQuery	getStorageNameQuery() Returns a name query instance appropriate for searching the repository contents for storages matching various search criteria.
java.lang.Class	resolveStorageFor(java.lang.Class iface) For the given interface (or less typically class) return the RepositoryStorage class extension for this repsoitory.
boolean	storageExists(java.lang.String storagename) Determines if the named storage already exists in the possibly remote repository.

Method Detail

getCustodian

RepositoryMaintenance getCustodian()

Gets an instance appropriate for the creation, deletion or other privilaged or atypical operations on the storages housed within a reporitory.

createStorage

boolean createStorage(java.lang.Class iface,
                    java.lang.String storagename)

Creates a storage instance on the repository. The storage created may be persistent depending on the type of repository. The repository itself may be remote or local depeding how it is configured. Storage nicknames are assumed to be unique identifiers of the instance at least within a repository. If a storage by the same nickname already exists within the repository then this method does nothing.

storageExists

boolean storageExists(java.lang.String storagename)

Determines if the named storage already exists in the possibly remote repository.

resolveStorageFor

java.lang.Class resolveStorageFor(java.lang.Class iface)

For the given interface (or less typically class) return the RepositoryStorage class extension for this repsoitory. For example a RepositorySQLConnection extension for a repository of WidgetStorage's this method might return WidgetStorageSQL.class.

getRepository

java.lang.String getRepository()

Returns the name associated with the repository to which the connection is established. Names are associated to repositories by a ReposConfig instance. In common usage, ReposConfig instances are per-user and persisted by plain text (configuration) files within the user's home directory.

getStorage

RepositoryStorage getStorage(java.lang.String storagename)

Gets the storage having the given nickname from the currently connected repository. If the named storage does not exist on the connected repository then this method returns null.

Returns:

null if the named storage does not exist

determineClassOf

java.lang.Class determineClassOf(java.lang.String storagename)

Returns a Class object for the type of storage that would result from instantiating the named storage.

Returns:

if the named storage does not exist

getStorageNameQuery

RepositoryStorageNameQuery getStorageNameQuery()

Returns a name query instance appropriate for searching the repository contents for storages matching various search criteria.

getFindNameDialogForClass

java.lang.Class getFindNameDialogForClass(java.lang.Class storageclass)

close

void close()

Closes the connection fo the repository.