au.edu.archer.services.icat
Class AbstractICATClient

java.lang.Object
  au.edu.archer.services.icat.AbstractICATClient

All Implemented Interfaces:

ICAT, ICATHelpers, ICATTraversal, SearchService

Direct Known Subclasses:

ICATHibernateImpl, ICATWsClientImpl

public abstract class AbstractICATClient
extends java.lang.Object
implements ICAT, ICATHelpers

The AbstractICATClient implementes some common methods, such as normalisaion of locations, as well as high level getters.

Author:

nigel

Constructor Summary

AbstractICATClient()

Method Summary

DataFileFormat	getDataFileFormatById(DataFileFormatPK id)
DataFileParameter	getDataFileParameterById(DataFileParameterPK key)
java.util.List<DataFile>	getDataFilesFor(DataSet ds)
DataSet	getDataSetFor(DataFile df)
DataSetParameter	getDataSetParameterById(DataSetParameterPK key)
java.util.List<DataSet>	getDataSetsFor(Investigation i)
java.util.List<DataSet>	getDataSetsFor(Sample s)
Investigation	getInvestigationFor(DataSet ds)
Investigation	getInvestigationFor(Sample s)
java.util.List<Investigation>	getInvestigationsFor(Study s)
java.util.List<Sample>	getSamplesFor(Investigation i)
Study	getStudyFor(Investigation i)
java.lang.String	normaliseLocation(java.lang.String in) Convert the location into a standard form for easier searching.

Methods inherited from class java.lang.Object

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

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

deleteDataFile, deleteDataFileFormat, deleteDataFileParameter, deleteDataSet, deleteDataSetParameter, deleteDataSetStatus, deleteDataSetType, deleteFacilityCycle, deleteFacilityUser, deleteInstrument, deleteInvestigation, deleteInvestigationType, deleteParameter, deleteSample, deleteSampleParameter, deleteStudy, deleteStudyStatus, getAllDataFileFormats, getAllDataFileParameters, getAllDataFilesByDataSetId, getAllDataSetParameters, getAllDataSetsByInvestigationId, getAllDataSetStatus, getAllDataSetTypes, getAllFacilityCycles, getAllFacilityUsers, getAllInstruments, getAllInvestigationsByStudyId, getAllInvestigationTypes, getAllParameters, getAllParametersByType, getAllSampleParameters, getAllSamplesByInvestigationId, getAllSamplesByInvestigationName, getAllStudies, getAllStudyStatus, getDataFileById, getDataFileByLocation, getDataFileByName, getDataFileFormatById, getDataFileFormatByName, getDataFileParameterById, getDataSetById, getDataSetByLocation, getDataSetByName, getDataSetIdByHandle, getDataSetParameterById, getDataSetStatusByName, getDataSetTypeByName, getFacilityCycleByName, getFacilityUserById, getInstrumentByName, getInvestigationById, getInvestigationByLocation, getInvestigationByName, getInvestigationTypeByName, getObjectFactory, getParameterById, getParameterByName, getResourceUrlPrefixes, getSampleById, getSampleByName, getSampleParameterById, getStudyById, getStudyByLocation, getStudyByName, getStudyStatusByName, testCall, triggerNotifications, updateDataFile, updateDataFileFormat, updateDataFileParameter, updateDataSet, updateDataSetParameter, updateDataSetStatus, updateDataSetType, updateFacilityCycle, updateFacilityUser, updateInstrument, updateInvestigation, updateInvestigationType, updateParameter, updateSample, updateSampleParameter, updateStudy, updateStudyStatus

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

searchDataFile, searchDataSet, searchExperiment, searchProject, searchSample

Constructor Detail

AbstractICATClient

public AbstractICATClient()

Method Detail

normaliseLocation

public java.lang.String normaliseLocation(java.lang.String in)
                                   throws java.net.MalformedURLException

Convert the location into a standard form for easier searching. Remove usernames, lowercase server and method.

Specified by:

normaliseLocation in interface ICATHelpers

Returns:

Throws:

java.net.MalformedURLException

getDataSetsFor

public java.util.List<DataSet> getDataSetsFor(Sample s)
                                       throws ICATServiceException

Specified by:

getDataSetsFor in interface ICATTraversal

Throws:

ICATServiceException

getDataFilesFor

public java.util.List<DataFile> getDataFilesFor(DataSet ds)
                                         throws ICATServiceException

Specified by:

getDataFilesFor in interface ICATTraversal

Throws:

ICATServiceException

getDataSetFor

public DataSet getDataSetFor(DataFile df)
                      throws ICATServiceException

Specified by:

getDataSetFor in interface ICATTraversal

Throws:

ICATServiceException

getDataSetsFor

public java.util.List<DataSet> getDataSetsFor(Investigation i)
                                       throws ICATServiceException

Specified by:

getDataSetsFor in interface ICATTraversal

Throws:

ICATServiceException

getInvestigationFor

public Investigation getInvestigationFor(DataSet ds)
                                  throws ICATServiceException

Specified by:

getInvestigationFor in interface ICATTraversal

Throws:

ICATServiceException

getInvestigationFor

public Investigation getInvestigationFor(Sample s)
                                  throws ICATServiceException

Specified by:

getInvestigationFor in interface ICATTraversal

Throws:

ICATServiceException

getInvestigationsFor

public java.util.List<Investigation> getInvestigationsFor(Study s)
                                                   throws ICATServiceException

Specified by:

getInvestigationsFor in interface ICATTraversal

Throws:

ICATServiceException

getSamplesFor

public java.util.List<Sample> getSamplesFor(Investigation i)
                                     throws ICATServiceException

Specified by:

getSamplesFor in interface ICATTraversal

Throws:

ICATServiceException

getStudyFor

public Study getStudyFor(Investigation i)
                  throws ICATServiceException

Specified by:

getStudyFor in interface ICATTraversal

Throws:

ICATServiceException

getDataFileFormatById

public DataFileFormat getDataFileFormatById(DataFileFormatPK id)
                                     throws ICATServiceException

Specified by:

getDataFileFormatById in interface ICAT

Throws:

ICATServiceException

getDataFileParameterById

public DataFileParameter getDataFileParameterById(DataFileParameterPK key)
                                           throws ICATServiceException

Throws:

ICATServiceException

getDataSetParameterById

public DataSetParameter getDataSetParameterById(DataSetParameterPK key)
                                         throws ICATServiceException

Throws:

ICATServiceException