org.lsst.ccs.config
Interface DBInterface

All Known Implementing Classes:

FIleBasedDAO, HibernateDAO, HqlDAO, MemoryDAO

public interface DBInterface

defines the basic methods implemented by a Data Access Object. Note that many types are package protected so implementors whould be in the same package.

Author:

bamade

Method Summary

void	begin() starts a transaction
void	close() claose all
void	deleteActiveConfigProfile(org.lsst.ccs.config.AConfigProfile oldProfile) delectes the active profile from DB
void	deleteActiveSubsystemDescription(org.lsst.ccs.config.ASubsystemDescription oldDescription) deletes an active description
void	end() end a transaction
void	fail() failure: must close transaction
void	fail(Throwable th) same as fail but a Throwable can be used to log.
org.lsst.ccs.config.AConfigProfile	getActiveConfigProfile(String name, String tag) get configProfile with name and tag
Collection<org.lsst.ccs.config.AConfigProfile>	getActiveProfilesForSubsystem(org.lsst.ccs.config.ASubsystemDescription description) gets the active configProfiles that references an active SubsystemDescription
org.lsst.ccs.config.ASubsystemDescription	getActiveSubsystemDescription(long id) gets a subsystem descirption by it"s id
org.lsst.ccs.config.ASubsystemDescription	getActiveSubsystemDescription(String name, String tag) gets a SubsystemDescription in the corresponding active object table.
org.lsst.ccs.config.GhostSubsystemDescription	getGhostDescription(long id) returns ghost with corresponding id
MachineConfiguration	getMachineConfiguration(String macAddress) get a machine configuration..
PreparedConfiguration	getPreparedConfiguration(String subsystemName, String configName, String tag) returns a prepared Configuration
Collection<org.lsst.ccs.config.PastConfigProfile>	getProfilesForSubsystem(org.lsst.ccs.config.GhostSubsystemDescription description) get the deprecated ConfigProfile that referenced a subsystemDescription (active or deprecated)
void	modifyParmConfig(org.lsst.ccs.config.AParameterConfiguration config) registers a modified parameter
void	saveConfigProfile(org.lsst.ccs.config.AConfigProfile newProfile) saves the new argument: ID is modified and argument becomes immutable.
void	saveGhostDescriptions(org.lsst.ccs.config.GhostSubsystemDescription ghosts) saves the argument
void	saveMachineConfiguration(MachineConfiguration machineConfiguration) saves a machine configuration
void	savePastProfile(org.lsst.ccs.config.PastConfigProfile deprecatedProfile) saves argument
void	savePreparedConfiguration(PreparedConfiguration preparedConfiguration) saves a preparedConfiguration
void	saveRun(RunHistory runHistory) saves a run history
void	saveSubsystemDescription(org.lsst.ccs.config.ASubsystemDescription newDescription) saves the argument: which must now becomes immutable and be numbered (with an ID)
List<?>	simpleHQLRequest(String hqlString) execut simple request (read only: select of From)

Method Detail

begin

void begin()

starts a transaction

end

void end()

end a transaction

fail

void fail()

failure: must close transaction

fail

void fail(Throwable th)

same as fail but a Throwable can be used to log.

Parameters:

th -

saveSubsystemDescription

void saveSubsystemDescription(org.lsst.ccs.config.ASubsystemDescription newDescription)

saves the argument: which must now becomes immutable and be numbered (with an ID)

Parameters:

newDescription -

saveGhostDescriptions

void saveGhostDescriptions(org.lsst.ccs.config.GhostSubsystemDescription ghosts)

saves the argument

Parameters:

ghosts -

getActiveSubsystemDescription

org.lsst.ccs.config.ASubsystemDescription getActiveSubsystemDescription(String name,
                                                                        String tag)

gets a SubsystemDescription in the corresponding active object table.

Parameters:

name -

tag -

Returns:

null if not found

getActiveSubsystemDescription

org.lsst.ccs.config.ASubsystemDescription getActiveSubsystemDescription(long id)

gets a subsystem descirption by it"s id

Parameters:

id -

Returns:

getGhostDescription

org.lsst.ccs.config.GhostSubsystemDescription getGhostDescription(long id)

returns ghost with corresponding id

Parameters:

id -

Returns:

null if not found

deleteActiveSubsystemDescription

void deleteActiveSubsystemDescription(org.lsst.ccs.config.ASubsystemDescription oldDescription)

deletes an active description

Parameters:

oldDescription -

saveConfigProfile

void saveConfigProfile(org.lsst.ccs.config.AConfigProfile newProfile)

saves the new argument: ID is modified and argument becomes immutable.

Parameters:

newProfile -

savePastProfile

void savePastProfile(org.lsst.ccs.config.PastConfigProfile deprecatedProfile)

saves argument

Parameters:

deprecatedProfile -

getActiveConfigProfile

org.lsst.ccs.config.AConfigProfile getActiveConfigProfile(String name,
                                                          String tag)

get configProfile with name and tag

Parameters:

name -

tag -

Returns:

null if not found

deleteActiveConfigProfile

void deleteActiveConfigProfile(org.lsst.ccs.config.AConfigProfile oldProfile)

delectes the active profile from DB

Parameters:

oldProfile -

modifyParmConfig

void modifyParmConfig(org.lsst.ccs.config.AParameterConfiguration config)

registers a modified parameter

Parameters:

config -

getActiveProfilesForSubsystem

Collection<org.lsst.ccs.config.AConfigProfile> getActiveProfilesForSubsystem(org.lsst.ccs.config.ASubsystemDescription description)

gets the active configProfiles that references an active SubsystemDescription

Parameters:

description -

Returns:

getProfilesForSubsystem

Collection<org.lsst.ccs.config.PastConfigProfile> getProfilesForSubsystem(org.lsst.ccs.config.GhostSubsystemDescription description)

get the deprecated ConfigProfile that referenced a subsystemDescription (active or deprecated)

Parameters:

description -

Returns:

saveRun

void saveRun(RunHistory runHistory)

saves a run history

Parameters:

runHistory -

savePreparedConfiguration

void savePreparedConfiguration(PreparedConfiguration preparedConfiguration)

saves a preparedConfiguration

Parameters:

preparedConfiguration -

getPreparedConfiguration

PreparedConfiguration getPreparedConfiguration(String subsystemName,
                                               String configName,
                                               String tag)

returns a prepared Configuration

Parameters:

subsystemName -

configName -

tag -

Returns:

null if not found

saveMachineConfiguration

void saveMachineConfiguration(MachineConfiguration machineConfiguration)

saves a machine configuration

Parameters:

machineConfiguration -

getMachineConfiguration

MachineConfiguration getMachineConfiguration(String macAddress)

get a machine configuration..

Parameters:

macAddress -

Returns:

null if not found

simpleHQLRequest

List<?> simpleHQLRequest(String hqlString)

execut simple request (read only: select of From)

Parameters:

hqlString -

Returns:

close

void close()

claose all