nom.tam.fits.HeaderCommentsMap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nom-tam-fits Show documentation

Java library for reading and writing FITS files. FITS, the Flexible Image Transport System, is the format commonly used in the archiving and transport of astronomical data.

There is a newer version: 1.20.2

Show newest version

package nom.tam.fits;

/*
 * #%L
 * nom.tam FITS library
 * %%
 * Copyright (C) 2004 - 2015 nom-tam-fits
 * %%
 * This is free and unencumbered software released into the public domain.
 * 
 * Anyone is free to copy, modify, publish, use, compile, sell, or
 * distribute this software, either in source code form or as a compiled
 * binary, for any purpose, commercial or non-commercial, and by any
 * means.
 * 
 * In jurisdictions that recognize copyright laws, the author or authors
 * of this software dedicate any and all copyright interest in the
 * software to the public domain. We make this dedication for the benefit
 * of the public at large and to the detriment of our heirs and
 * successors. We intend this dedication to be an overt act of
 * relinquishment in perpetuity of all present and future rights to this
 * software under copyright law.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 * #L%
 */

import nom.tam.fits.header.Standard;

/**
 * This class provides a modifiable map in which the comment fields for FITS
 * header keywords produced by this library are set. The map is a simple String
 * -> String map where the key Strings are normally class:keyword:id where
 * class is the class name where the keyword is set, keyword is the keyword set
 * and id is an integer used to distinguish multiple instances. Most users need
 * not worry about this class, but users who wish to customize the appearance of
 * FITS files may update the map. The code itself is likely to be needed to
 * understand which values in the map must be modified.
 */
@Deprecated
public final class HeaderCommentsMap {

    @Deprecated
    public static void deleteComment(String key) {
        key = simplyfyKey(key);
        for (Standard value : Standard.values()) {
            value.setCommentByKey(key, "");
        }
    }

    @Deprecated
    public static String getComment(String key) {
        key = simplyfyKey(key);
        for (Standard value : Standard.values()) {
            String comment = value.getCommentByKey(key);
            if (comment != null) {
                return comment;
            }
        }
        return null;
    }

    private static String simplyfyKey(String key) {
        int firstDbPoint = key.indexOf(':');
        if (firstDbPoint > 0) {
            int secondDoublePoint = key.indexOf(':', firstDbPoint + 1);
            if (secondDoublePoint > 0) {
                return key.substring(0, secondDoublePoint);
            }
        }
        return key;
    }

    @Deprecated
    public static void updateComment(String key, String comment) {
        key = simplyfyKey(key);
        for (Standard value : Standard.values()) {
            value.setCommentByKey(key, comment);
        }
    }

    private HeaderCommentsMap() {
    }
}