au.edu.archer.services.icat
Interface ICAT

All Superinterfaces:

ICATTraversal, SearchService

All Known Implementing Classes:

AbstractICATClient, ICATHibernateImpl, ICATWsClientImpl

public interface ICAT
extends ICATTraversal, SearchService

The general interface into the ICAT, implemented by various DB and service oriented classes.

Author:

nigel

Method Summary

void	deleteDataFile(DataFile in)
void	deleteDataFileFormat(DataFileFormat in)
void	deleteDataFileParameter(DataFileParameter in)
void	deleteDataSet(DataSet in)
void	deleteDataSetParameter(DataSetParameter in)
void	deleteDataSetStatus(DataSetStatus in)
void	deleteDataSetType(DataSetType in)
void	deleteFacilityCycle(FacilityCycle in)
void	deleteFacilityUser(FacilityUser in)
void	deleteInstrument(Instrument in)
void	deleteInvestigation(Investigation in)
void	deleteInvestigationType(InvestigationType in)
void	deleteParameter(Parameter in)
void	deleteSample(Sample in)
void	deleteSampleParameter(SampleParameter in)
void	deleteStudy(Study in)
void	deleteStudyStatus(StudyStatus in)
java.util.List<DataFileFormat>	getAllDataFileFormats()
java.util.List<DataFileParameter>	getAllDataFileParameters(java.lang.Integer in)
java.util.List<DataFile>	getAllDataFilesByDataSetId(java.lang.Integer in)
java.util.List<DataSetParameter>	getAllDataSetParameters(java.lang.Integer in)
java.util.List<DataSet>	getAllDataSetsByInvestigationId(java.lang.Integer in)
java.util.List<DataSetStatus>	getAllDataSetStatus()
java.util.List<DataSetType>	getAllDataSetTypes()
java.util.List<FacilityCycle>	getAllFacilityCycles()
java.util.List<FacilityUser>	getAllFacilityUsers()
java.util.List<Instrument>	getAllInstruments()
java.util.List<Investigation>	getAllInvestigationsByStudyId(java.lang.Integer in)
java.util.List<InvestigationType>	getAllInvestigationTypes()
java.util.List<Parameter>	getAllParameters()
java.util.List<Parameter>	getAllParametersByType(boolean isSampleParameter, boolean isDataSetParameter, boolean isDataFileParameter) Returns the parameters for which the boolean parameters are true.
java.util.List<SampleParameter>	getAllSampleParameters(java.lang.Integer in)
java.util.List<Sample>	getAllSamplesByInvestigationId(java.lang.Integer in)
java.util.List<Sample>	getAllSamplesByInvestigationName(java.lang.String studyName, java.lang.String investigationName)
java.util.List<Study>	getAllStudies()
java.util.List<StudyStatus>	getAllStudyStatus()
DataFile	getDataFileById(java.lang.Integer in)
DataFile	getDataFileByLocation(java.lang.String location) Get the Data file object associated with the given location URI.
DataFile	getDataFileByName(java.lang.String studyName, java.lang.String investigationName, java.lang.String datasetName, java.lang.String datafileName) Get the data file based on the names of it's path components in the icat structure.
DataFileFormat	getDataFileFormatById(DataFileFormatPK id)
DataFileFormat	getDataFileFormatById(java.lang.String name, java.lang.String version)
java.util.List<DataFileFormat>	getDataFileFormatByName(java.lang.String in)
DataFileParameter	getDataFileParameterById(java.lang.String name, java.lang.String units, java.lang.Integer dataFileID)
DataSet	getDataSetById(java.lang.Integer in)
DataSet	getDataSetByLocation(java.lang.String location)
DataSet	getDataSetByName(java.lang.String studyName, java.lang.String investigationName, java.lang.String datasetName) Lookup the dataset based on the path name components made up of study, investigation and dataset names.
java.lang.Integer	getDataSetIdByHandle(java.lang.String in)
DataSetParameter	getDataSetParameterById(java.lang.String name, java.lang.String units, java.lang.Integer dataFileID)
DataSetStatus	getDataSetStatusByName(java.lang.String in)
DataSetType	getDataSetTypeByName(java.lang.String in)
FacilityCycle	getFacilityCycleByName(java.lang.String in)
FacilityUser	getFacilityUserById(java.lang.String in)
Instrument	getInstrumentByName(java.lang.String in)
Investigation	getInvestigationById(java.lang.Integer in)
Investigation	getInvestigationByLocation(java.lang.String location)
Investigation	getInvestigationByName(java.lang.String studyName, java.lang.String investigationName) Lookup the Investigation based on the path components of study name and investigation name.
InvestigationType	getInvestigationTypeByName(java.lang.String in)
ICATObjectFactory	getObjectFactory()
Parameter	getParameterById(java.lang.Integer in)
Parameter	getParameterByName(java.lang.String name, java.lang.String units) Gets the parameter with this name-unit key
java.util.List<java.lang.String>	getResourceUrlPrefixes()
Sample	getSampleById(java.lang.Integer in)
Sample	getSampleByName(java.lang.String studyName, java.lang.String investigationName, java.lang.String sampleName)
SampleParameter	getSampleParameterById(java.lang.String name, java.lang.String units, java.lang.Integer sampleID)
Study	getStudyById(java.lang.Integer in)
Study	getStudyByLocation(java.lang.String location)
Study	getStudyByName(java.lang.String in)
StudyStatus	getStudyStatusByName(java.lang.String in)
java.lang.String	testCall(java.lang.String str1, java.lang.String str2)
void	triggerNotifications()
DataFile	updateDataFile(DataFile in) Save the datafile object.
DataFileFormat	updateDataFileFormat(DataFileFormat in) Save the datafile format object.
DataFileParameter	updateDataFileParameter(DataFileParameter in) Save the datafile parameter object.
DataSet	updateDataSet(DataSet in) Save the dataset object.
DataSetParameter	updateDataSetParameter(DataSetParameter in) Save the dataset parameter object.
DataSetStatus	updateDataSetStatus(DataSetStatus in) Save the dataset status object.
DataSetType	updateDataSetType(DataSetType in) Save the dataset type object.
FacilityCycle	updateFacilityCycle(FacilityCycle in) Save the facility cycle object.
FacilityUser	updateFacilityUser(FacilityUser in) Save the facility user object.
Instrument	updateInstrument(Instrument in) Save the instrument object.
Investigation	updateInvestigation(Investigation in) Save the investigation object.
InvestigationType	updateInvestigationType(InvestigationType in) Save the investigation type object.
Parameter	updateParameter(Parameter in) Save the parameter, updating or creating if id is null or 0.
Sample	updateSample(Sample in) Save the study object.
SampleParameter	updateSampleParameter(SampleParameter in) Save the sample parameter object.
Study	updateStudy(Study in) Save the study object.
StudyStatus	updateStudyStatus(StudyStatus in) Save the study status object.

Methods inherited from interface au.edu.archer.services.icat.ICATTraversal

getDataFilesFor, getDataSetFor, getDataSetsFor, getDataSetsFor, getInvestigationFor, getInvestigationFor, getInvestigationsFor, getSamplesFor, getStudyFor

Methods inherited from interface au.edu.archer.services.icat.SearchService

searchDataFile, searchDataSet, searchExperiment, searchProject, searchSample

Method Detail

getObjectFactory

ICATObjectFactory getObjectFactory()

testCall

java.lang.String testCall(java.lang.String str1,
                          java.lang.String str2)
                          throws ICATServiceException

Throws:

ICATServiceException

updateStudy

Study updateStudy(Study in)
                  throws ICATServiceException

Save the study object. First unflatten, then persist, then flatten and return.

Parameters:

in -

Returns:

Throws:

ICATServiceException

updateStudyStatus

StudyStatus updateStudyStatus(StudyStatus in)
                              throws ICATServiceException

Save the study status object. First unflatten, then persist, then flatten and return.

Parameters:

in -

Returns:

Throws:

ICATServiceException

updateInvestigation

Investigation updateInvestigation(Investigation in)
                                  throws ICATServiceException

Save the investigation object. First unflatten, then persist, then flatten and return.

Parameters:

in -

Returns:

Throws:

ICATServiceException

updateInvestigationType

InvestigationType updateInvestigationType(InvestigationType in)
                                          throws ICATServiceException

Save the investigation type object. First unflatten, then persist, then flatten and return.

Parameters:

in -

Returns:

Throws:

ICATServiceException

updateSample

Sample updateSample(Sample in)
                    throws ICATServiceException

Save the study object. First unflatten, then persist, then flatten and return.

Parameters:

in -

Returns:

Throws:

ICATServiceException

updateSampleParameter

SampleParameter updateSampleParameter(SampleParameter in)
                                      throws ICATServiceException

Save the sample parameter object. First unflatten, then persist, then flatten and return.

Parameters:

in -

Returns:

Throws:

ICATServiceException

updateDataSet

DataSet updateDataSet(DataSet in)
                      throws ICATServiceException

Save the dataset object. First unflatten, then persist, then flatten and return.

Parameters:

in -

Returns:

Throws:

ICATServiceException

updateDataSetType

DataSetType updateDataSetType(DataSetType in)
                              throws ICATServiceException

Save the dataset type object. First unflatten, then persist, then flatten and return.

Parameters:

in -

Returns:

Throws:

ICATServiceException

updateDataSetStatus

DataSetStatus updateDataSetStatus(DataSetStatus in)
                                  throws ICATServiceException

Save the dataset status object. First unflatten, then persist, then flatten and return.

Parameters:

in -

Returns:

Throws:

ICATServiceException

updateDataSetParameter

DataSetParameter updateDataSetParameter(DataSetParameter in)
                                        throws ICATServiceException

Save the dataset parameter object. First unflatten, then persist, then flatten and return.

Parameters:

in -

Returns:

Throws:

ICATServiceException

updateDataFile

DataFile updateDataFile(DataFile in)
                        throws ICATServiceException

Save the datafile object. First unflatten, then persist, then flatten and return.

Parameters:

in -

Returns:

Throws:

ICATServiceException

updateDataFileFormat

DataFileFormat updateDataFileFormat(DataFileFormat in)
                                    throws ICATServiceException

Save the datafile format object. First unflatten, then persist, then flatten and return.

Parameters:

in -

Returns:

Throws:

ICATServiceException

updateDataFileParameter

DataFileParameter updateDataFileParameter(DataFileParameter in)
                                          throws ICATServiceException

Save the datafile parameter object. First unflatten, then persist, then flatten and return.

Parameters:

in -

Returns:

Throws:

ICATServiceException

updateInstrument

Instrument updateInstrument(Instrument in)
                            throws ICATServiceException

Save the instrument object. First unflatten, then persist, then flatten and return.

Parameters:

in -

Returns:

Throws:

ICATServiceException

updateFacilityCycle

FacilityCycle updateFacilityCycle(FacilityCycle in)
                                  throws ICATServiceException

Save the facility cycle object. First unflatten, then persist, then flatten and return.

Parameters:

in -

Returns:

Throws:

ICATServiceException

updateFacilityUser

FacilityUser updateFacilityUser(FacilityUser in)
                                throws ICATServiceException

Save the facility user object. First unflatten, then persist, then flatten and return.

Parameters:

in -

Returns:

Throws:

ICATServiceException

updateParameter

Parameter updateParameter(Parameter in)
                          throws ICATServiceException

Save the parameter, updating or creating if id is null or 0.

Parameters:

in -

Returns:

Throws:

ICATServiceException

deleteStudy

void deleteStudy(Study in)
                 throws ICATServiceException

Throws:

ICATServiceException

deleteStudyStatus

void deleteStudyStatus(StudyStatus in)
                       throws ICATServiceException

Throws:

ICATServiceException

deleteInvestigation

void deleteInvestigation(Investigation in)
                         throws ICATServiceException

Throws:

ICATServiceException

deleteInvestigationType

void deleteInvestigationType(InvestigationType in)
                             throws ICATServiceException

Throws:

ICATServiceException

deleteSample

void deleteSample(Sample in)
                  throws ICATServiceException

Throws:

ICATServiceException

deleteSampleParameter

void deleteSampleParameter(SampleParameter in)
                           throws ICATServiceException

Throws:

ICATServiceException

deleteDataSet

void deleteDataSet(DataSet in)
                   throws ICATServiceException

Throws:

ICATServiceException

deleteDataSetType

void deleteDataSetType(DataSetType in)
                       throws ICATServiceException

Throws:

ICATServiceException

deleteDataSetStatus

void deleteDataSetStatus(DataSetStatus in)
                         throws ICATServiceException

Throws:

ICATServiceException

deleteDataSetParameter

void deleteDataSetParameter(DataSetParameter in)
                            throws ICATServiceException

Throws:

ICATServiceException

deleteDataFile

void deleteDataFile(DataFile in)
                    throws ICATServiceException

Throws:

ICATServiceException

deleteDataFileFormat

void deleteDataFileFormat(DataFileFormat in)
                          throws ICATServiceException

Throws:

ICATServiceException

deleteDataFileParameter

void deleteDataFileParameter(DataFileParameter in)
                             throws ICATServiceException

Throws:

ICATServiceException

deleteInstrument

void deleteInstrument(Instrument in)
                      throws ICATServiceException

Throws:

ICATServiceException

deleteFacilityCycle

void deleteFacilityCycle(FacilityCycle in)
                         throws ICATServiceException

Throws:

ICATServiceException

deleteFacilityUser

void deleteFacilityUser(FacilityUser in)
                        throws ICATServiceException

Throws:

ICATServiceException

deleteParameter

void deleteParameter(Parameter in)
                     throws ICATServiceException

Throws:

ICATServiceException

getAllStudies

java.util.List<Study> getAllStudies()
                                    throws ICATServiceException

Throws:

ICATServiceException

getAllStudyStatus

java.util.List<StudyStatus> getAllStudyStatus()
                                              throws ICATServiceException

Throws:

ICATServiceException

getAllInvestigationsByStudyId

java.util.List<Investigation> getAllInvestigationsByStudyId(java.lang.Integer in)
                                                            throws ICATServiceException

Throws:

ICATServiceException

getAllInvestigationTypes

java.util.List<InvestigationType> getAllInvestigationTypes()
                                                           throws ICATServiceException

Throws:

ICATServiceException

getAllSamplesByInvestigationId

java.util.List<Sample> getAllSamplesByInvestigationId(java.lang.Integer in)
                                                      throws ICATServiceException

Throws:

ICATServiceException

getAllSamplesByInvestigationName

java.util.List<Sample> getAllSamplesByInvestigationName(java.lang.String studyName,
                                                        java.lang.String investigationName)
                                                        throws ICATServiceException

Throws:

ICATServiceException

getAllSampleParameters

java.util.List<SampleParameter> getAllSampleParameters(java.lang.Integer in)
                                                       throws ICATServiceException

Throws:

ICATServiceException

getAllDataSetsByInvestigationId

java.util.List<DataSet> getAllDataSetsByInvestigationId(java.lang.Integer in)
                                                        throws ICATServiceException

Throws:

ICATServiceException

getAllDataSetTypes

java.util.List<DataSetType> getAllDataSetTypes()
                                               throws ICATServiceException

Throws:

ICATServiceException

getAllDataSetStatus

java.util.List<DataSetStatus> getAllDataSetStatus()
                                                  throws ICATServiceException

Throws:

ICATServiceException

getAllDataSetParameters

java.util.List<DataSetParameter> getAllDataSetParameters(java.lang.Integer in)
                                                         throws ICATServiceException

Throws:

ICATServiceException

getAllDataFilesByDataSetId

java.util.List<DataFile> getAllDataFilesByDataSetId(java.lang.Integer in)
                                                    throws ICATServiceException

Throws:

ICATServiceException

getAllDataFileFormats

java.util.List<DataFileFormat> getAllDataFileFormats()
                                                     throws ICATServiceException

Throws:

ICATServiceException

getAllDataFileParameters

java.util.List<DataFileParameter> getAllDataFileParameters(java.lang.Integer in)
                                                           throws ICATServiceException

Throws:

ICATServiceException

getAllInstruments

java.util.List<Instrument> getAllInstruments()
                                             throws ICATServiceException

Throws:

ICATServiceException

getAllFacilityCycles

java.util.List<FacilityCycle> getAllFacilityCycles()
                                                   throws ICATServiceException

Throws:

ICATServiceException

getAllFacilityUsers

java.util.List<FacilityUser> getAllFacilityUsers()
                                                 throws ICATServiceException

Throws:

ICATServiceException

getAllParameters

java.util.List<Parameter> getAllParameters()
                                           throws ICATServiceException

Throws:

ICATServiceException

getAllParametersByType

java.util.List<Parameter> getAllParametersByType(boolean isSampleParameter,
                                                 boolean isDataSetParameter,
                                                 boolean isDataFileParameter)
                                                 throws ICATServiceException

Returns the parameters for which the boolean parameters are true. The parameters are ored together so getAllParametersByType(true, true, true) will return all the parameters

Parameters:

isSampleParameter -

isDataSetParameter -

isDataFileParameter -

Returns:

Throws:

ICATServiceException

getStudyById

Study getStudyById(java.lang.Integer in)
                   throws ICATServiceException

Throws:

ICATServiceException

getStudyByName

Study getStudyByName(java.lang.String in)
                     throws ICATServiceException

Throws:

ICATServiceException

getStudyStatusByName

StudyStatus getStudyStatusByName(java.lang.String in)
                                 throws ICATServiceException

Throws:

ICATServiceException

getInvestigationById

Investigation getInvestigationById(java.lang.Integer in)
                                   throws ICATServiceException

Throws:

ICATServiceException

getInvestigationByName

Investigation getInvestigationByName(java.lang.String studyName,
                                     java.lang.String investigationName)
                                     throws ICATServiceException

Lookup the Investigation based on the path components of study name and investigation name.

Parameters:

studyName -

investigationName -

Returns:

Throws:

ICATServiceException

getInvestigationTypeByName

InvestigationType getInvestigationTypeByName(java.lang.String in)
                                             throws ICATServiceException

Throws:

ICATServiceException

getSampleById

Sample getSampleById(java.lang.Integer in)
                     throws ICATServiceException

Throws:

ICATServiceException

getSampleByName

Sample getSampleByName(java.lang.String studyName,
                       java.lang.String investigationName,
                       java.lang.String sampleName)
                       throws ICATServiceException

Throws:

ICATServiceException

getSampleParameterById

SampleParameter getSampleParameterById(java.lang.String name,
                                       java.lang.String units,
                                       java.lang.Integer sampleID)
                                       throws ICATServiceException

Throws:

ICATServiceException

getDataSetById

DataSet getDataSetById(java.lang.Integer in)
                       throws ICATServiceException

Throws:

ICATServiceException

getDataSetByName

DataSet getDataSetByName(java.lang.String studyName,
                         java.lang.String investigationName,
                         java.lang.String datasetName)
                         throws ICATServiceException

Lookup the dataset based on the path name components made up of study, investigation and dataset names.

Parameters:

studyName -

investigationName -

datasetName -

Returns:

Throws:

ICATServiceException

getDataSetTypeByName

DataSetType getDataSetTypeByName(java.lang.String in)
                                 throws ICATServiceException

Throws:

ICATServiceException

getDataSetStatusByName

DataSetStatus getDataSetStatusByName(java.lang.String in)
                                     throws ICATServiceException

Throws:

ICATServiceException

getDataSetIdByHandle

java.lang.Integer getDataSetIdByHandle(java.lang.String in)
                                       throws ICATServiceException

Throws:

ICATServiceException

getDataSetParameterById

DataSetParameter getDataSetParameterById(java.lang.String name,
                                         java.lang.String units,
                                         java.lang.Integer dataFileID)
                                         throws ICATServiceException

Throws:

ICATServiceException

getDataFileById

DataFile getDataFileById(java.lang.Integer in)
                         throws ICATServiceException

Throws:

ICATServiceException

getDataFileByLocation

DataFile getDataFileByLocation(java.lang.String location)
                               throws ICATServiceException

Get the Data file object associated with the given location URI.

Parameters:

location -

Returns:

Throws:

ICATServiceException

getDataSetByLocation

DataSet getDataSetByLocation(java.lang.String location)
                             throws ICATServiceException

Throws:

ICATServiceException

getInvestigationByLocation

Investigation getInvestigationByLocation(java.lang.String location)
                                         throws ICATServiceException

Throws:

ICATServiceException

getStudyByLocation

Study getStudyByLocation(java.lang.String location)
                         throws ICATServiceException

Throws:

ICATServiceException

getDataFileByName

DataFile getDataFileByName(java.lang.String studyName,
                           java.lang.String investigationName,
                           java.lang.String datasetName,
                           java.lang.String datafileName)
                           throws ICATServiceException

Get the data file based on the names of it's path components in the icat structure.

Parameters:

studyName -

investigationName -

datasetName -

datafileName -

Returns:

Throws:

ICATServiceException

getDataFileFormatById

DataFileFormat getDataFileFormatById(DataFileFormatPK id)
                                     throws ICATServiceException

Throws:

ICATServiceException

getDataFileFormatById

DataFileFormat getDataFileFormatById(java.lang.String name,
                                     java.lang.String version)
                                     throws ICATServiceException

Throws:

ICATServiceException

getDataFileFormatByName

java.util.List<DataFileFormat> getDataFileFormatByName(java.lang.String in)
                                                       throws ICATServiceException

Throws:

ICATServiceException

getDataFileParameterById

DataFileParameter getDataFileParameterById(java.lang.String name,
                                           java.lang.String units,
                                           java.lang.Integer dataFileID)
                                           throws ICATServiceException

Throws:

ICATServiceException

getInstrumentByName

Instrument getInstrumentByName(java.lang.String in)
                               throws ICATServiceException

Throws:

ICATServiceException

getFacilityCycleByName

FacilityCycle getFacilityCycleByName(java.lang.String in)
                                     throws ICATServiceException

Throws:

ICATServiceException

getFacilityUserById

FacilityUser getFacilityUserById(java.lang.String in)
                                 throws ICATServiceException

Throws:

ICATServiceException

getParameterById

Parameter getParameterById(java.lang.Integer in)
                           throws ICATServiceException

Throws:

ICATServiceException

getParameterByName

Parameter getParameterByName(java.lang.String name,
                             java.lang.String units)
                             throws ICATServiceException

Gets the parameter with this name-unit key

Parameters:

name -

units -

Returns:

Throws:

ICATServiceException

getResourceUrlPrefixes

java.util.List<java.lang.String> getResourceUrlPrefixes()
                                                        throws ICATServiceException

Throws:

ICATServiceException

triggerNotifications

void triggerNotifications()
                          throws ICATServiceException

Throws:

ICATServiceException