org.lsst.ccs.imagenaming

Class ImageName

java.lang.Object

org.lsst.ccs.imagenaming.ImageName

All Implemented Interfaces:

Serializable, Comparable<ImageName>

public class ImageName
extends Object
implements Serializable, Comparable<ImageName>

A class representing an image name in the standard format.

Author:

tonyj

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImageName(String name) Create an image name from a string in the standard image name format.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ImageName other)
boolean	equals(Object obj)
Controller	getController() Get the controller that initiated the image
LocalDate	getDate() Get the data of the image.
String	getDateString() Get the formatted date of the image
int	getNumber() Get the image sequence number
String	getNumberString() Get the formatted image number
Source	getSource() Get the source of the image
int	getSourceIndex() Get the source index (or 0 if no source index)
String	getSourceWithIndex()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageName

public ImageName(String name)

Create an image name from a string in the standard image name format.

Parameters:

name - The string to parse

Throws:

IllegalArgumentException - if the string is not a valid image name

Method Detail

getSource

public Source getSource()

Get the source of the image

Returns:

The source

getSourceIndex

public int getSourceIndex()

Get the source index (or 0 if no source index)

Returns:

The source index (or 0 if no source index)

getSourceWithIndex

public String getSourceWithIndex()

getController

public Controller getController()

Get the controller that initiated the image

Returns:

The controller

getDate

public LocalDate getDate()

Get the data of the image. Note that this is the date allocated using LSST naming conventions, and not necessarily the actual date on which the image was taken.

Returns:

The date

getDateString

public String getDateString()

Get the formatted date of the image

Returns:

The date formatted in the standard way

getNumber

public int getNumber()

Get the image sequence number

Returns:

The number

getNumberString

public String getNumberString()

Get the formatted image number

Returns:

The sequence number formatted in the standard way

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(ImageName other)

Specified by:

compareTo in interface Comparable<ImageName>