org.lsst.ccs.imagenaming

Class ImageNameAssigner

java.lang.Object

org.lsst.ccs.imagenaming.ImageNameAssigner

All Implemented Interfaces:

AutoCloseable

public class ImageNameAssigner
extends Object
implements AutoCloseable

A utility for assigning image names according to LSST observatory naming conventions.

Author:

tonyj

Constructor Summary

Constructors

Constructor and Description
ImageNameAssigner(String dbURL) Create an instant of the image name assignment class.

Method Summary

Modifier and Type	Method and Description
ImageName	assignImageName(Source source, Controller controller, TimeZone zone, Duration offset) Assign an image name for the given source, controller, time zone and offset and using the current timestamp.
ImageName	assignImageName(Source source, Controller controller, TimeZone zone, Duration offset, Instant time) Assign an image name for the given source, controller, time zone and offset and using the given timestamp.
List<ImageName>	assignImageNames(Source source, Controller controller, TimeZone zone, Duration offset, int n) Assign a set of sequential image names for the given source, controller, time zone and offset and using the current timestamp.
List<ImageName>	assignImageNames(Source source, Controller controller, TimeZone zone, Duration offset, int n, Instant time) Assign a set of sequential image names for the given source, controller, time zone and offset and using the given timestamp.
void	close()

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageNameAssigner

public ImageNameAssigner(String dbURL)

Create an instant of the image name assignment class.

Parameters:

dbURL - The database connection URL to be used.

Method Detail

assignImageName

public ImageName assignImageName(Source source,
                                 Controller controller,
                                 TimeZone zone,
                                 Duration offset)
                          throws SQLException

Assign an image name for the given source, controller, time zone and offset and using the current timestamp.

Parameters:

source - The source to be used for the image name

controller - The controller to be used for the image name

zone - The time-zone to be used for assigning dates

offset - The offset from midnight in the specified time zone when the date assigned to the image will rollover.

Returns:

The image name.

Throws:

SQLException - If there is an error communicating with the database.

assignImageName

public ImageName assignImageName(Source source,
                                 Controller controller,
                                 TimeZone zone,
                                 Duration offset,
                                 Instant time)
                          throws SQLException

Assign an image name for the given source, controller, time zone and offset and using the given timestamp.

Parameters:

source - The source to be used for the image name

controller - The controller to be used for the image name

zone - The time-zone to be used for assigning dates

offset - The offset from midnight in the specified time zone when the date assigned to the image will rollover.

time - The instant to be used for generating the image date, or null to use the current time.

Returns:

The image name.

Throws:

SQLException - If there is an error communicating with the database.

assignImageNames

public List<ImageName> assignImageNames(Source source,
                                        Controller controller,
                                        TimeZone zone,
                                        Duration offset,
                                        int n)
                                 throws SQLException

Assign a set of sequential image names for the given source, controller, time zone and offset and using the current timestamp.

Parameters:

source - The source to be used for the image name

controller - The controller to be used for the image name

zone - The time-zone to be used for assigning dates

offset - The offset from midnight in the specified time zone when the date assigned to the image will rollover.

n - The number of consecutive names to assign

Returns:

A list of image names.

Throws:

SQLException - If there is an error communicating with the database.

assignImageNames

public List<ImageName> assignImageNames(Source source,
                                        Controller controller,
                                        TimeZone zone,
                                        Duration offset,
                                        int n,
                                        Instant time)
                                 throws SQLException

Assign a set of sequential image names for the given source, controller, time zone and offset and using the given timestamp.

Parameters:

source - The source to be used for the image name

controller - The controller to be used for the image name

zone - The time-zone to be used for assigning dates

offset - The offset from midnight in the specified time zone when the date assigned to the image will rollover.

n - The number of consecutive names to assign

time - The instant to be used for generating the image date, or null to use the current time.

Returns:

The image name.

Throws:

SQLException - If there is an error communicating with the database.

close

public void close()
           throws SQLException

Specified by:

close in interface AutoCloseable

Throws:

SQLException