org.lsst.ccs.utilities.image

Class HeaderSpecification

java.lang.Object

org.lsst.ccs.utilities.image.HeaderSpecification

public class HeaderSpecification
extends Object

A specification for a fits file header. Typically read from a .spec file. For a given HeaderSpecification it is possible to read multiple spec files to allow for overwriting of information on the part of subsystems. Any uploaded spec file will overwrite the existing information.

Author:

tonyj

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HeaderSpecification.DataType
static class	HeaderSpecification.GroupLine A Class defining each Group line contained in a HeaderSpecification.
static class	HeaderSpecification.HeaderLine A Class defining each Header line contained in a HeaderSpecification.

Field Summary

Fields

Modifier and Type	Field and Description
static Object	NULL

Constructor Summary

Constructors

Constructor and Description
HeaderSpecification(HeaderSpecification spec)
HeaderSpecification(String name, InputStream in)
HeaderSpecification(String name, Reader in)

Method Summary

Modifier and Type	Method and Description
Collection<HeaderSpecification.GroupLine>	getGroups() Get the full collection of GroupLines for this HeaderSpecification.
HeaderSpecification.HeaderLine	getHeader(String keyWord) Get a specific HeaderLine object specifying the full definition for a given header keyword.
Collection<HeaderSpecification.HeaderLine>	getHeaders() Get the full collection of HeaderLines for this HeaderSpecification.
Collection<HeaderSpecification.HeaderLine>	getHeadersForGroup(String groupName) Get the full collection of HeaderLines for a given group name.
String	getName() The name of the HeaderSpecification.
static void	main(String[] argv)

Methods inherited from class java.lang.Object

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

Field Detail

NULL

public static final Object NULL

Constructor Detail

HeaderSpecification

public HeaderSpecification(String name,
                           InputStream in)
                    throws IOException

Throws:

IOException

HeaderSpecification

public HeaderSpecification(String name,
                           Reader in)
                    throws IOException

Throws:

IOException

HeaderSpecification

public HeaderSpecification(HeaderSpecification spec)

Method Detail

getName

public String getName()

The name of the HeaderSpecification. It is used to map the HeaderSpecification with the fits header being written out.

Returns:

getHeader

public HeaderSpecification.HeaderLine getHeader(String keyWord)

Get a specific HeaderLine object specifying the full definition for a given header keyword.

Parameters:

keyWord - The keyword name for the HeaderLine

Returns:

The HeaderLine defining the content of the header.

getHeaders

public Collection<HeaderSpecification.HeaderLine> getHeaders()

Get the full collection of HeaderLines for this HeaderSpecification. The returned collection is unmodifiable.

Returns:

The unmodifiable collection of HeaderLine objects.

getHeadersForGroup

public Collection<HeaderSpecification.HeaderLine> getHeadersForGroup(String groupName)

Get the full collection of HeaderLines for a given group name. The returned collection is unmodifiable.

Returns:

The unmodifiable collection of HeaderLine objects for the given group.

getGroups

public Collection<HeaderSpecification.GroupLine> getGroups()

Get the full collection of GroupLines for this HeaderSpecification. The returned collection is unmodifiable.

Returns:

The unmodifiable collection of GroupLine objects.

main

public static void main(String[] argv)
                 throws Exception

Throws:

Exception