|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.fits.HeaderCards
public class HeaderCards
Controlled access to a collection of FITS header cards.
Currently decorates the Header
class, but
could be implemented on top of some other (possibly custom)
header cards parser implementation.
Field Summary | |
---|---|
String[] |
BORING_KEYS
Keywords which are never used as table parameters. |
Constructor Summary | |
---|---|
HeaderCards(nom.tam.fits.Header hdr)
Constructor. |
Method Summary | |
---|---|
boolean |
containsKey(String key)
Indicates whether the header collection contains a card with the given keyword. |
Double |
getDoubleValue(String key)
Returns the double value for a card with a given key. |
Integer |
getIntValue(String key)
Returns the integer value for a card with a given key. |
Long |
getLongValue(String key)
Returns the long value for a card with a given key. |
String |
getStringValue(String key)
Returns the string value for a card with a given key. |
DescribedValue[] |
getUnusedParams()
Returns an array of DescribedValue objects suitable for use as items of per-table metadata derived from this FITS header. |
void |
useKey(String key)
Marks a given keyword as used. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public final String[] BORING_KEYS
Constructor Detail |
---|
public HeaderCards(nom.tam.fits.Header hdr)
hdr
- FITS header objectMethod Detail |
---|
public Integer getIntValue(String key)
key
- header keyword
public Long getLongValue(String key)
key
- header keyword
public Double getDoubleValue(String key)
key
- header keyword
public String getStringValue(String key)
key
- header keyword
public void useKey(String key)
get*Value
methods.
key
- header keywordpublic boolean containsKey(String key)
key
- header keyword
key
is presentpublic DescribedValue[] getUnusedParams()
useKey(java.lang.String)
has not been explicitly or implicitly called.
Certain standard structural FITS keywords (BORING_KEYS
)
are ignored as well.
The idea is that keywords which have already been read to determine table structure do not need to be recorded separately since their meaning is implicitly included in the table metadata already.
|
Copyright © 2004 CLRC: Central Laboratory of the Research Councils. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |