org.lsst.ccs.utilities.image

Class MetaDataSet

java.lang.Object

org.lsst.ccs.utilities.image.MetaDataSet

public class MetaDataSet
extends Object

A MetaDataSet is used to provide values for the fits header keywords. Since there can be multiple sources of header keywords, this class provides methods for adding key-value maps for a given source. The key corresponds to the header keyword and the value represents it value. The source of origin is used when resolving expressions for header keywords as described in spec files as: ${metaMap.metaName}. "metaMap" corresponds to the source and "metaName" to a key as coming from that specific source. The corresponding value is used when writing out fits files. Internally it uses a Map of Maps to store the meta-data.

Author:

The LSST CCS Team.

Constructor Summary

Constructors

Constructor and Description
MetaDataSet()

Method Summary

Modifier and Type	Method and Description
void	addMetaData(String name, String key, Object value) Add a meta-data entry to a named meta-data object.
void	addMetaDataMap(String name, Map<String,Object> data) Add a set of meta-data to a named meta-data object.
void	addMetaDataSet(MetaDataSet metaDataSet) Add a MetaDataSet to an existing MetaDataSet.
void	addProperties(String name, Properties props) Add a set of properties to a MetaDataSet.
Properties	convertToProperties() Convert a MetaDataSet to a Properties object.
Object	getValue(String name)
Object	getValue(String map, String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaDataSet

public MetaDataSet()

Method Detail

addProperties

public void addProperties(String name,
                          Properties props)

Add a set of properties to a MetaDataSet. The properties will be converted to the appropriate object type based on their value.

Parameters:

name - The name of the map to which the properties should be added

props - The properties.

addMetaData

public void addMetaData(String name,
                        String key,
                        Object value)

Add a meta-data entry to a named meta-data object. The named object will be created if it does not already exist.

Parameters:

name - The name of the map to which the new meta-data should be added

key - The key of the meta-data to add

value - The value of the meta-data to add

addMetaDataMap

public void addMetaDataMap(String name,
                           Map<String,Object> data)

Add a set of meta-data to a named meta-data object. The named object will be created if it does not already exist.

Parameters:

name - The name of the map to which the new meta-data should be added

data - The meta-data to add

addMetaDataSet

public void addMetaDataSet(MetaDataSet metaDataSet)

Add a MetaDataSet to an existing MetaDataSet. A named set will be created if it does not exist. If it already exists the content of the new MetaDataSet will be added to the existing one.

Parameters:

metaDataSet - The MetaDataSet to add to the existing one.

convertToProperties

public Properties convertToProperties()

Convert a MetaDataSet to a Properties object. Each entry is added with both with its full name (mapName.keyName) and with its keyName alone.

Returns:

The Properties object with the valued in this MetaDataSet.

getValue

public Object getValue(String name)

getValue

public Object getValue(String map,
                       String name)