org.lsst.ccs.daq.ims

Class Folder

java.lang.Object

org.lsst.ccs.daq.ims.Folder

All Implemented Interfaces:

Comparable<Folder>

public class Folder
extends Object
implements Comparable<Folder>

Represents a Folder in the DAQ catalog. Folders can contain images but not nested folders.

Author:

tonyj

See Also:

Catalog.list()

Method Summary

Modifier and Type	Method and Description
int	compareTo(Folder o)
boolean	equals(Object obj)
Image	find(String name) Find an image by name
String	getName() Get the name of the folder
int	hashCode()
Image	insert(ImageMetaData meta) Create a new image in this folder.
List<Image>	listImages() Obtain a list of images in this folder.

Methods inherited from class java.lang.Object

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

Method Detail

listImages

public List<Image> listImages()
                       throws DAQException

Obtain a list of images in this folder. The returned list is not sorted, but implements comparable so can easily be sorted if required.

Returns:

The list of folders.

Throws:

DAQException

find

public Image find(String name)
           throws DAQException

Find an image by name

Parameters:

name - The name of the image to search for

Returns:

The found image, or null if the image cannot be found

Throws:

DAQException - If some other error occurs.

insert

public Image insert(ImageMetaData meta)
             throws DAQException

Create a new image in this folder. The new image will initially have no data associated with it, but will be writable.

Parameters:

meta - The meta data corresponding to the image to be created.

Returns:

The newly created image

Throws:

DAQException - if the image cannot be created, or some other error occurs.

See Also:

ImageMetaData#ImageMetaData(java.lang.String, java.lang.String, int, java.util.Set)

compareTo

public int compareTo(Folder o)

Specified by:

compareTo in interface Comparable<Folder>

getName

public String getName()

Get the name of the folder

Returns:

The folder name

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object