Skip navigation links
A D E G M O P R Z 

A

ArchiveStorageInterface - Interface in org.icatproject.ids.plugin
An IDS interface which for which an implementation must be provided for an IDS deployment with archive storage.
ArchiveStorageReadOnly - Class in org.icatproject.ids.plugin
This is a partial implementation of an ArchiveStorageInterface providing dummy implementations of those operations not needed when the readOnly flag has been set in the ids.properties file
ArchiveStorageReadOnly() - Constructor for class org.icatproject.ids.plugin.ArchiveStorageReadOnly
 

D

delete(DsInfo) - Method in interface org.icatproject.ids.plugin.ArchiveStorageInterface
Delete the specified data set.
delete(String) - Method in interface org.icatproject.ids.plugin.ArchiveStorageInterface
Remove the data file from the specified location.
delete(DsInfo) - Method in class org.icatproject.ids.plugin.ArchiveStorageReadOnly
This is a dummy implementation
delete(String) - Method in class org.icatproject.ids.plugin.ArchiveStorageReadOnly
This is a dummy implementation
delete(DsInfo) - Method in interface org.icatproject.ids.plugin.MainStorageInterface
Deletes the files of the specified data set.
delete(String, String, String) - Method in interface org.icatproject.ids.plugin.MainStorageInterface
Deletes the specified file A dummy may be provided if the readOnly flag is set and no archive storage has been configured with storageUnit = DATAFILE
delete(DsInfo) - Method in class org.icatproject.ids.plugin.MainStorageWithoutArchive
This is a dummy implementation
delete(String, String, String) - Method in class org.icatproject.ids.plugin.MainStorageWithoutArchiveReadOnly
This is a dummy implementation
DfInfo - Interface in org.icatproject.ids.plugin
 
DsInfo - Interface in org.icatproject.ids.plugin
Information about an ICAT data set

E

exists(DsInfo) - Method in interface org.icatproject.ids.plugin.MainStorageInterface
See if the data set exists.
exists(String) - Method in interface org.icatproject.ids.plugin.MainStorageInterface
See if the data file exists.
exists(DsInfo) - Method in class org.icatproject.ids.plugin.MainStorageWithoutArchive
This is a dummy implementation
exists(String) - Method in class org.icatproject.ids.plugin.MainStorageWithoutArchiveReadOnly
This is a dummy implementation

G

get(DsInfo, Path) - Method in interface org.icatproject.ids.plugin.ArchiveStorageInterface
Get the specified data set.
get(String, String, String) - Method in interface org.icatproject.ids.plugin.MainStorageInterface
Return a stream of data from the specified data file
getCreateId() - Method in interface org.icatproject.ids.plugin.DfInfo
Return the id of whoever created the data file
getDatafilesToArchive(long, long) - Method in interface org.icatproject.ids.plugin.MainStorageInterface
Return the list of DfInfos which should be archived to reduce the used storage to between lowArchivingLevel and highArchivingLevel.
getDatafilesToArchive(long, long) - Method in class org.icatproject.ids.plugin.MainStorageWithoutArchive
 
getDatasetsToArchive(long, long) - Method in interface org.icatproject.ids.plugin.MainStorageInterface
Return the list of DsInfos which should be archived to reduce the used storage to between lowArchivingLevel and highArchivingLevel.
getDatasetsToArchive(long, long) - Method in class org.icatproject.ids.plugin.MainStorageWithoutArchive
 
getDfId() - Method in interface org.icatproject.ids.plugin.DfInfo
Return the data file id
getDfLocation() - Method in interface org.icatproject.ids.plugin.DfInfo
Return the data file location
getDfName() - Method in interface org.icatproject.ids.plugin.DfInfo
Return the data file name
getDsId() - Method in interface org.icatproject.ids.plugin.DsInfo
Return the data set id
getDsLocation() - Method in interface org.icatproject.ids.plugin.DsInfo
Return the data set location
getDsName() - Method in interface org.icatproject.ids.plugin.DsInfo
Return the data set name
getFacilityId() - Method in interface org.icatproject.ids.plugin.DsInfo
Return the facility id
getFacilityName() - Method in interface org.icatproject.ids.plugin.DsInfo
Return the facility name
getFileName(String) - Method in interface org.icatproject.ids.plugin.ZipMapperInterface
Derive Datafile.name as known in ICAT for the zip file entry fullEntryName
getFullEntryName(DsInfo, DfInfo) - Method in interface org.icatproject.ids.plugin.ZipMapperInterface
Derive full entry name for the file specified by the dsInfo and dfInfo
getInvId() - Method in interface org.icatproject.ids.plugin.DsInfo
Return the investigation id
getInvName() - Method in interface org.icatproject.ids.plugin.DsInfo
Return the investigation name
getModId() - Method in interface org.icatproject.ids.plugin.DfInfo
Return the id of whoever modified the data file last
getPath(String, String, String) - Method in interface org.icatproject.ids.plugin.MainStorageInterface
Return the physical path corresponding to a location for a datafile.
getVisitId() - Method in interface org.icatproject.ids.plugin.DsInfo
Return the investigation visitId

M

MainStorageInterface - Interface in org.icatproject.ids.plugin
An IDS interface which for which an implementation must be provided for any IDS deployment.
MainStorageReadOnly - Class in org.icatproject.ids.plugin
This is a partial implementation of a MainStorageInterface providing dummy implementations of those operations not needed when the readOnly flag has been set in the ids.properties file
MainStorageReadOnly() - Constructor for class org.icatproject.ids.plugin.MainStorageReadOnly
 
MainStorageWithoutArchive - Class in org.icatproject.ids.plugin
This is a partial implementation of a MainStorageInterface providing dummy implementations of those operations not needed when no archive storage is being used.
MainStorageWithoutArchive() - Constructor for class org.icatproject.ids.plugin.MainStorageWithoutArchive
 
MainStorageWithoutArchiveReadOnly - Class in org.icatproject.ids.plugin
This is a partial implementation of a MainStorageInterface providing dummy implementations of those operations not needed when no archive storage is being used and when the readOnly flag has been set in the ids.properties file
MainStorageWithoutArchiveReadOnly() - Constructor for class org.icatproject.ids.plugin.MainStorageWithoutArchiveReadOnly
 

O

org.icatproject.ids.plugin - package org.icatproject.ids.plugin
 

P

put(DsInfo, InputStream) - Method in interface org.icatproject.ids.plugin.ArchiveStorageInterface
Store the specified data set.
put(InputStream, String) - Method in interface org.icatproject.ids.plugin.ArchiveStorageInterface
Store the data file at the specified location.
put(DsInfo, InputStream) - Method in class org.icatproject.ids.plugin.ArchiveStorageReadOnly
This is a dummy implementation
put(InputStream, String) - Method in class org.icatproject.ids.plugin.ArchiveStorageReadOnly
This is a dummy implementation
put(DsInfo, String, InputStream) - Method in interface org.icatproject.ids.plugin.MainStorageInterface
Store the specified data file and return the chosen location of the file to allow it to be retrieved.
put(InputStream, String) - Method in interface org.icatproject.ids.plugin.MainStorageInterface
Store the data file at the specified location.
put(DsInfo, String, InputStream) - Method in class org.icatproject.ids.plugin.MainStorageReadOnly
This is a dummy implementation
put(InputStream, String) - Method in class org.icatproject.ids.plugin.MainStorageWithoutArchive
This is a dummy implementation - only used when a file is restored from archive so the Datafile.location field in ICAT is already known.
put(DsInfo, String, InputStream) - Method in class org.icatproject.ids.plugin.MainStorageWithoutArchiveReadOnly
This is a dummy implementation

R

restore(MainStorageInterface, List<DfInfo>) - Method in interface org.icatproject.ids.plugin.ArchiveStorageInterface
Restore the datafiles from archive to main storage.

Z

ZipMapperInterface - Interface in org.icatproject.ids.plugin
Handle the generation of the full entry name for a zip file entry and derive the Datafile.name from it.
A D E G M O P R Z 
Skip navigation links

Copyright © 2016 The ICAT Collaboration. All rights reserved.