au.edu.jcu.hermes.plugin.icat
Interface IICATModel

All Known Implementing Classes:
ICATModel

public interface IICATModel


Method Summary
 void addConnection(IICATConnector connector)
          Add a connection to an ICAT service.
 void addSuccessListener(java.awt.event.ActionListener actionListener)
          Add a listener to listen for function success.
 void changeConnection(IICATConnector connector)
          change the url connected to.
 java.util.List<DataSetStatus> getAllDataSetStatus()
          Get all the possible Data Set Status'.
 java.util.List<DataSetType> getAllDataSetTypes()
          Get all the possible Data Set Types.
 java.util.List<DataFileFormat> getAllFormats()
          Get all the possible Data File Formats.
 java.util.List<Instrument> getAllInstruments()
          Get all the possible Instruments.
 java.util.List<InvestigationType> getAllInvestigationTypes()
          Get all the possible Investigation Types.
 java.util.List<SampleParameter> getAllSampleParameters(long sampleId)
          Get all the parameters for the sample.
 java.util.List<Study> getAllStudies()
           
 java.util.List<StudyStatus> getAllStudyStatus()
          Get all the options for Study Status.
 java.util.List<IICATConnector> getConnections()
          Get the list of connections.
 DataFile getDataFileById(long id)
          Get the Data File that relates to the id.
 DataFileParameter getDataFileParameterById(long id)
          get the Data File Parameter that relates to the id.
 java.util.List<DataFile> getDataFiles(DataSet dataSet)
          Get a list of the Data Files in a Data Set.
 DataSet getDataSetById(long id)
          Get the Data Set that relates to the id.
 DataSetParameter getDataSetParameterById(long id)
          get the Data Set Parameter that relates to the id.
 java.util.List<DataSet> getDataSets(Investigation inv)
          Get a list of the data sets associated with an investigation.
 ICATObjectFactory getICATFactory()
           
 Investigation getInvestigationById(long id)
          Get the Investigation that relates to the id.
 java.util.List<Investigation> getInvestigations(Study study)
          Get a list of the investigations associated with a study.
 InvestigationType getInvType(java.lang.String invType)
          Get the details of an investigation type from the name.
 Sample getSampleById(long id)
          Get the Sample that relates to the id.
 SampleParameter getSampleParameterById(long id)
          Get the sample parameter that relates to the id.
 java.util.List<Sample> getSamples(Investigation inv)
          Get a list of the samples associated with an investigation.
 Study getStudyById(long id)
          Return the Study that relates the the id.
 DataFile newDataFile(long dataSetId)
          Add a Data File.
 DataFileParameter newDataFileParameter(long dataFileId)
          Add a Data File Parameter.
 DataSet newDataSet(long investigationId)
          Add a Data Set.
 DataSetParameter newDataSetParameter(long dataSetId)
          Add a Data Set Parameter.
 Investigation newInvestigation(long studyId)
          Add an Investigation.
 Sample newSample(long investigationId)
          Add a sample.
 SampleParameter newSampleParameter(long sampleId)
          Add a Sample Parameter.
 Study newStudy()
          Add a new study.
 void removeConnection(IICATConnector connector)
          Remove a connection to an ICAT service.
 void removeDataFile(long dataFileId)
          Delete a Data File.
 void removeDataFileParameter(long parameterId)
          Delete a Data File Parameter.
 void removeDataSet(long dataSetId)
          Delete a sample.
 void removeDataSetParameter(long parameterId)
          delete a data set Parameter.
 void removeInvestigation(long investigationId)
          Delete the Investigation.
 void removeSample(long sampleId)
          Delete a sample.
 void removeSampleParameter(long parameterId)
          delete a sample parameter.
 void removeStudy(long studyId)
          Delete the study.
 void updateDataFile(DataFile dataFile)
          Update a Data File.
 void updateDataFileParameter(DataFileParameter parameter)
          Update a Data File Parameter.
 DataSet updateDataSet(DataSet dataSet)
          Update a data set.
 void updateDataSetParameter(DataSetParameter parameter)
          update a data set Parameter.
 Investigation updateInvestigation(Investigation inv)
          Updates an investigation to the ICAT store.
 Sample updateSample(Sample sample)
          Update a sample.
 void updateSampleParameter(SampleParameter parameter)
          update a new sample parameter.
 Study updateStudy(Study study)
          Updates a study to the ICAT store.
 

Method Detail

changeConnection

void changeConnection(IICATConnector connector)
change the url connected to.

Parameters:
connector - - IICATConnector

getICATFactory

ICATObjectFactory getICATFactory()
Returns:
the object factory for the ICAT schema.

getInvType

InvestigationType getInvType(java.lang.String invType)
Get the details of an investigation type from the name.

Parameters:
invType - - the name of the investigation type
Returns:
InvestigationType

newStudy

Study newStudy()
Add a new study.

Returns:
the new study object

updateStudy

Study updateStudy(Study study)
Updates a study to the ICAT store.

Parameters:
study - - the new study object
Returns:
Study

getAllStudies

java.util.List<Study> getAllStudies()
Returns:
the list of studies in the ICAT store.

getStudyById

Study getStudyById(long id)
Return the Study that relates the the id.

Parameters:
id - - long
Returns:
Study

removeStudy

void removeStudy(long studyId)
Delete the study.

Parameters:
studyId - - long

getInvestigations

java.util.List<Investigation> getInvestigations(Study study)
Get a list of the investigations associated with a study.

Parameters:
study - - Study
Returns:
List of Investigation

getInvestigationById

Investigation getInvestigationById(long id)
Get the Investigation that relates to the id.

Parameters:
id - - long
Returns:
Investigation

removeInvestigation

void removeInvestigation(long investigationId)
Delete the Investigation.

Parameters:
investigationId - - long

newInvestigation

Investigation newInvestigation(long studyId)
Add an Investigation.

Parameters:
studyId - - long
Returns:
Investigation

updateInvestigation

Investigation updateInvestigation(Investigation inv)
Updates an investigation to the ICAT store.

Parameters:
inv - - Investigation
Returns:
Investigation

getDataSets

java.util.List<DataSet> getDataSets(Investigation inv)
Get a list of the data sets associated with an investigation.

Parameters:
inv - - Investigation
Returns:
List of DataSet

getDataSetById

DataSet getDataSetById(long id)
Get the Data Set that relates to the id.

Parameters:
id - - long
Returns:
DataSet

removeDataSet

void removeDataSet(long dataSetId)
Delete a sample.

Parameters:
dataSetId - - long

newDataSet

DataSet newDataSet(long investigationId)
Add a Data Set.

Parameters:
investigationId - - long
Returns:
DataSet

updateDataSet

DataSet updateDataSet(DataSet dataSet)
Update a data set.

Parameters:
dataSet - - DataSet
Returns:
DataSet

getSamples

java.util.List<Sample> getSamples(Investigation inv)
Get a list of the samples associated with an investigation.

Parameters:
inv - - Investigation
Returns:
List of Sample

getSampleById

Sample getSampleById(long id)
Get the Sample that relates to the id.

Parameters:
id - - long
Returns:
Sample

removeSample

void removeSample(long sampleId)
Delete a sample.

Parameters:
sampleId - - long

newSample

Sample newSample(long investigationId)
Add a sample.

Parameters:
investigationId - - long
Returns:
Sample

updateSample

Sample updateSample(Sample sample)
Update a sample.

Parameters:
sample - - Sample
Returns:
Sample

getDataFiles

java.util.List<DataFile> getDataFiles(DataSet dataSet)
Get a list of the Data Files in a Data Set.

Parameters:
dataSet - - DataSet
Returns:
List of DataFile

newDataFile

DataFile newDataFile(long dataSetId)
Add a Data File.

Parameters:
dataSetId - - long
Returns:
- DataFile

updateDataFile

void updateDataFile(DataFile dataFile)
Update a Data File.

Parameters:
dataFile - - DataFile

getDataFileById

DataFile getDataFileById(long id)
Get the Data File that relates to the id.

Parameters:
id - - long
Returns:
DataFile

removeDataFile

void removeDataFile(long dataFileId)
Delete a Data File.

Parameters:
dataFileId - - long

getDataFileParameterById

DataFileParameter getDataFileParameterById(long id)
get the Data File Parameter that relates to the id.

Parameters:
id - - long
Returns:
DataFileParameter

newDataFileParameter

DataFileParameter newDataFileParameter(long dataFileId)
Add a Data File Parameter.

Parameters:
dataFileId - - long
Returns:
DataFileParameter

updateDataFileParameter

void updateDataFileParameter(DataFileParameter parameter)
Update a Data File Parameter.

Parameters:
parameter - - DataFileParameter

removeDataFileParameter

void removeDataFileParameter(long parameterId)
Delete a Data File Parameter.

Parameters:
parameterId - - long

getDataSetParameterById

DataSetParameter getDataSetParameterById(long id)
get the Data Set Parameter that relates to the id.

Parameters:
id - - long
Returns:
DataSetParameter

newDataSetParameter

DataSetParameter newDataSetParameter(long dataSetId)
Add a Data Set Parameter.

Parameters:
dataSetId - - long
Returns:
DataSetParameter

updateDataSetParameter

void updateDataSetParameter(DataSetParameter parameter)
update a data set Parameter.

Parameters:
parameter - - DataSetParameter

removeDataSetParameter

void removeDataSetParameter(long parameterId)
delete a data set Parameter.

Parameters:
parameterId - - long

getSampleParameterById

SampleParameter getSampleParameterById(long id)
Get the sample parameter that relates to the id.

Parameters:
id - - long
Returns:
SampleParameter

getAllSampleParameters

java.util.List<SampleParameter> getAllSampleParameters(long sampleId)
Get all the parameters for the sample.

Parameters:
sampleId - - long
Returns:
List of SampleParameter

newSampleParameter

SampleParameter newSampleParameter(long sampleId)
Add a Sample Parameter.

Parameters:
sampleId - - long
Returns:
SampleParameter

updateSampleParameter

void updateSampleParameter(SampleParameter parameter)
update a new sample parameter.

Parameters:
parameter - - SampleParameter

removeSampleParameter

void removeSampleParameter(long parameterId)
delete a sample parameter.

Parameters:
parameterId - - long

getAllStudyStatus

java.util.List<StudyStatus> getAllStudyStatus()
Get all the options for Study Status.

Returns:
List of StudyStatus

getAllInstruments

java.util.List<Instrument> getAllInstruments()
Get all the possible Instruments.

Returns:
List of Instrument

getAllInvestigationTypes

java.util.List<InvestigationType> getAllInvestigationTypes()
Get all the possible Investigation Types.

Returns:
List of InvestigationType

getAllDataSetTypes

java.util.List<DataSetType> getAllDataSetTypes()
Get all the possible Data Set Types.

Returns:
List of DataSetType

getAllDataSetStatus

java.util.List<DataSetStatus> getAllDataSetStatus()
Get all the possible Data Set Status'.

Returns:
List of DataSetStatus

getAllFormats

java.util.List<DataFileFormat> getAllFormats()
Get all the possible Data File Formats.

Returns:
List of DataFileFormat

addSuccessListener

void addSuccessListener(java.awt.event.ActionListener actionListener)
Add a listener to listen for function success.

Parameters:
actionListener - - ActionListener

addConnection

void addConnection(IICATConnector connector)
Add a connection to an ICAT service.

Parameters:
connector - - IICATConnector

removeConnection

void removeConnection(IICATConnector connector)
Remove a connection to an ICAT service.

Parameters:
connector - - IICATConnector

getConnections

java.util.List<IICATConnector> getConnections()
Get the list of connections.

Returns:
List of IICATConnector