com.mockturtlesolutions.snifflib.reposconfig.database

Class RepositoryXMLConnection

java.lang.Object

com.mockturtlesolutions.snifflib.reposconfig.database.RepositoryXMLConnection

All Implemented Interfaces:

RepositoryConnectivity

Direct Known Subclasses:

CanonicalSetXMLConnection, DblMatrixXMLConnection, FlatFileSetXMLConnection, FlatFileXMLConnection, GaussianProposalXMLConnection, GridElementXMLConnection, GroovyScriptXMLConnection, ImageFileXMLConnection, ImageStackXMLConnection, MatrixStorageXMLConnection, MCMCRunXMLConnection, MCMCStorageXMLConnection, MCMCTraceXMLConnection, MyrtleXMLConnection, ParameterSetXMLConnection, ProposalDistributionXMLConnection, ReservedFunctionXMLConnection, StatisticalModelXMLConnection, TimerStorageXMLConnection, WedgeXMLConnection, WordStorageXMLConnection, XppBettyXMLConnection, XppOdeXMLConnection

public class RepositoryXMLConnection
extends java.lang.Object
implements RepositoryConnectivity

Constructor Summary

Constructors

Constructor and Description
RepositoryXMLConnection(ReposConfig config, java.lang.String repos)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the connection fo the repository.
protected void	copyStyleFileResource(java.lang.String rname, java.io.File newfile) Convenience method which copies a resource file to the style directory.
void	createAndTransferStorageThreaded(RepositoryStorage storage) Creates (if not exists) the storage on this connectivity and then transfers it.
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.
protected java.lang.Class	getClassForLocalName(java.lang.String name)
RepositoryMaintenance	getCustodian() Gets an instance appropriate for the creation, deletion or other privilaged or atypical operations on the storages housed within a reporitory.
java.io.File	getDatabasePath()
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.
void	getStorageThreaded(java.util.concurrent.ConcurrentHashMap out, java.lang.String storagename)
int	getThreadedTransfers()
java.lang.String	getXMLFilename(java.lang.String storagename)
protected void	installStyleResources() Method is called which typically writes files (e.g.
java.lang.Class	resolveStorageFor(java.lang.Class iface) For the given interface (or less typically class) return the RepositoryStorage class extension for this repsoitory.
void	setThreadedTransfers(int n)
boolean	storageExists(java.lang.String storagename) Determines if the named storage already exists in the possibly remote repository.

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoryXMLConnection

public RepositoryXMLConnection(ReposConfig config,
                       java.lang.String repos)

Method Detail

getFindNameDialogForClass

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

Specified by:

getFindNameDialogForClass in interface RepositoryConnectivity

resolveStorageFor

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

Description copied from interface: RepositoryConnectivity

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.

Specified by:

resolveStorageFor in interface RepositoryConnectivity

copyStyleFileResource

protected void copyStyleFileResource(java.lang.String rname,
                         java.io.File newfile)

Convenience method which copies a resource file to the style directory.

installStyleResources

protected void installStyleResources()

Method is called which typically writes files (e.g. XSL, CSS) describing style or other formating information which may be used by capable browsers or other editors. This default implementation expects a resource directory named styles relative to this class' JAVA path to contain the necessary styles.

getRepository

public java.lang.String getRepository()

Description copied from interface: RepositoryConnectivity

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.

Specified by:

getRepository in interface RepositoryConnectivity

getDatabasePath

public java.io.File getDatabasePath()

getCustodian

public RepositoryMaintenance getCustodian()

Description copied from interface: RepositoryConnectivity

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

Specified by:

getCustodian in interface RepositoryConnectivity

getXMLFilename

public java.lang.String getXMLFilename(java.lang.String storagename)

createStorage

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

Description copied from interface: RepositoryConnectivity

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.

Specified by:

createStorage in interface RepositoryConnectivity

storageExists

public boolean storageExists(java.lang.String storagename)

Description copied from interface: RepositoryConnectivity

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

Specified by:

storageExists in interface RepositoryConnectivity

createAndTransferStorageThreaded

public void createAndTransferStorageThreaded(RepositoryStorage storage)

Creates (if not exists) the storage on this connectivity and then transfers it. The creation and transfer operations occur as a threaded process. This method is useful if many storages are being transfered and it can be guaranteed that each storage is independent or if a threaded transfer is desired (large single transfer).

getStorageThreaded

public void getStorageThreaded(java.util.concurrent.ConcurrentHashMap out,
                      java.lang.String storagename)

getThreadedTransfers

public int getThreadedTransfers()

setThreadedTransfers

public void setThreadedTransfers(int n)

getClassForLocalName

protected java.lang.Class getClassForLocalName(java.lang.String name)

determineClassOf

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

Description copied from interface: RepositoryConnectivity

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

Specified by:

determineClassOf in interface RepositoryConnectivity

Returns:

if the named storage does not exist

getStorage

public RepositoryStorage getStorage(java.lang.String storagename)

Description copied from interface: RepositoryConnectivity

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.

Specified by:

getStorage in interface RepositoryConnectivity

Returns:

null if the named storage does not exist

close

public void close()

Description copied from interface: RepositoryConnectivity

Closes the connection fo the repository.

Specified by:

close in interface RepositoryConnectivity

getStorageNameQuery

public RepositoryStorageNameQuery getStorageNameQuery()

Description copied from interface: RepositoryConnectivity

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

Specified by:

getStorageNameQuery in interface RepositoryConnectivity