org.lsst.ccs.daq.ims

Class Catalog

java.lang.Object

org.lsst.ccs.daq.ims.Catalog

public class Catalog
extends Object

A catalog contains a list of folders associated with a store. The catalog can be obtained from the associated Store.

Author:

tonyj

See Also:

Store.getCatalog()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Catalog.CatalogException An exception throw when errors occur when operating on the catalog.

Method Summary

Modifier and Type	Method and Description
Folder	find(String folderName) Find the specified folder by name.
Folder	insert(String folderName) Insert a new folder into the catalog.
List<Folder>	list() Return a list of all available folders.The list is not sorted, but Folder implements Comparable so it can be readily sorted if desired.
void	remove(String folderName) Remove a folder.

Methods inherited from class java.lang.Object

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

Method Detail

find

public Folder find(String folderName)
            throws DAQException

Find the specified folder by name.

Parameters:

folderName - The folder name to search for

Returns:

The folder, or null if the folder does not exist

Throws:

DAQException - If some other error occurs

list

public List<Folder> list()
                  throws DAQException

Return a list of all available folders.The list is not sorted, but Folder implements Comparable so it can be readily sorted if desired.

Returns:

The list of folders

Throws:

DAQException

insert

public Folder insert(String folderName)
              throws Catalog.CatalogException,
                     DAQException

Insert a new folder into the catalog.

Parameters:

folderName - The name of the new folder to create

Returns:

The newly created folder

Throws:

Catalog.CatalogException - If the folder cannot be created.

DAQException - If something else goes wrong

remove

public void remove(String folderName)
            throws Catalog.CatalogException,
                   DAQException

Remove a folder.

Parameters:

folderName - The name of the folder to be removed

Throws:

Catalog.CatalogException - If the folder cannot be removed.

DAQException - If something else goes wrong