org.opengis.metadata.citation.PresentationForm Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gt-opengis Show documentation
Standard interfaces implemented throughout the library.
There is a newer version: 24.2-oss84-1
/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2011, Open Source Geospatial Foundation (OSGeo)
 *    (C) 2004-2005, Open Geospatial Consortium Inc.
 *
 *    All Rights Reserved. http://www.opengis.org/legal/
 */
package org.opengis.metadata.citation;

import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;

import java.util.ArrayList;
import java.util.List;
import org.opengis.annotation.UML;
import org.opengis.util.CodeList;

/**
 * Mode in which the data is represented.
 *
 * @version ISO 19115
 * @author Martin Desruisseaux (IRD)
 * @since GeoAPI 2.0
 */
@UML(identifier = "CI_PresentationFormCode", specification = ISO_19115)
public final class PresentationForm extends CodeList {
    /** Serial number for compatibility with different versions. */
    private static final long serialVersionUID = 5668779490885399888L;

    /** List of all enumerations of this type. Must be declared before any enum declaration. */
    private static final List VALUES = new ArrayList(14);

    /** Digital representation of a primarily textual item (can contain illustrations also). */
    @UML(identifier = "documentDigital", obligation = CONDITIONAL, specification = ISO_19115)
    public static final PresentationForm DOCUMENT_DIGITAL =
            new PresentationForm("DOCUMENT_DIGITAL");

    /**
     * Representation of a primarily textual item (can contain illustrations also) on paper,
     * photographic material, or other media.
     */
    @UML(identifier = "documentHardcopy", obligation = CONDITIONAL, specification = ISO_19115)
    public static final PresentationForm DOCUMENT_HARDCOPY =
            new PresentationForm("DOCUMENT_HARDCOPY");

    /**
     * Likeness of natural or man-made features, objects, and activities acquired through the
     * sensing of visual or any other segment of the electromagnetic spectrum by sensors, such as
     * thermal infrared, and high resolution radar and stored in digital format.
     */
    @UML(identifier = "imageDigital", obligation = CONDITIONAL, specification = ISO_19115)
    public static final PresentationForm IMAGE_DIGITAL = new PresentationForm("IMAGE_DIGITAL");

    /**
     * Likeness of natural or man-made features, objects, and activities acquired through the
     * sensing of visual or any other segment of the electromagnetic spectrum by sensors, such as
     * thermal infrared, and high resolution radar and reproduced on paper, photographic material,
     * or other media for use directly by the human user.
     */
    @UML(identifier = "imageHardcopy", obligation = CONDITIONAL, specification = ISO_19115)
    public static final PresentationForm IMAGE_HARDCOPY = new PresentationForm("IMAGE_HARDCOPY");

    /** Map represented in raster or vector form. */
    @UML(identifier = "mapDigital", obligation = CONDITIONAL, specification = ISO_19115)
    public static final PresentationForm MAP_DIGITAL = new PresentationForm("MAP_DIGITAL");

    /**
     * Map printed on paper, photographic material, or other media for use directly by the human
     * user.
     */
    @UML(identifier = "mapHardcopy", obligation = CONDITIONAL, specification = ISO_19115)
    public static final PresentationForm MAP_HARDCOPY = new PresentationForm("MAP_HARDCOPY");

    /** Multi-dimensional digital representation of a feature, process, etc. */
    @UML(identifier = "modelDigital", obligation = CONDITIONAL, specification = ISO_19115)
    public static final PresentationForm MODEL_DIGITAL = new PresentationForm("MODEL_DIGITAL");

    /** 3-dimensional, physical model. */
    @UML(identifier = "modelHardcopy", obligation = CONDITIONAL, specification = ISO_19115)
    public static final PresentationForm MODEL_HARDCOPY = new PresentationForm("MODEL_HARDCOPY");

    /** Vertical cross-section in digital form. */
    @UML(identifier = "profileDigital", obligation = CONDITIONAL, specification = ISO_19115)
    public static final PresentationForm PROFILE_DIGITAL = new PresentationForm("PROFILE_DIGITAL");

    /** Vertical cross-section printed on paper, etc. */
    @UML(identifier = "profileHardcopy", obligation = CONDITIONAL, specification = ISO_19115)
    public static final PresentationForm PROFILE_HARDCOPY =
            new PresentationForm("PROFILE_HARDCOPY");

    /**
     * Digital representation of facts or figures systematically displayed, especially in columns.
     */
    @UML(identifier = "tableDigital", obligation = CONDITIONAL, specification = ISO_19115)
    public static final PresentationForm TABLE_DIGITAL = new PresentationForm("TABLE_DIGITAL");

    /**
     * Representation of facts or figures systematically displayed, especially in columns, printed
     * on paper, photographic material, or other media.
     */
    @UML(identifier = "tableHardcopy", obligation = CONDITIONAL, specification = ISO_19115)
    public static final PresentationForm TABLE_HARDCOPY = new PresentationForm("TABLE_HARDCOPY");

    /** Digital video recording. */
    @UML(identifier = "videoDigital", obligation = CONDITIONAL, specification = ISO_19115)
    public static final PresentationForm VIDEO_DIGITAL = new PresentationForm("VIDEO_DIGITAL");

    /** Video recording on film. */
    @UML(identifier = "videoHardcopy", obligation = CONDITIONAL, specification = ISO_19115)
    public static final PresentationForm VIDEO_HARDCOPY = new PresentationForm("VIDEO_HARDCOPY");

    /**
     * Constructs an enum with the given name. The new enum is automatically added to the list
     * returned by {@link #values}.
     *
     * @param name The enum name. This name must not be in use by an other enum of this type.
     */
    private PresentationForm(final String name) {
        super(name, VALUES);
    }

    /**
     * Returns the list of {@code PresentationForm}s.
     *
     * @return The list of codes declared in the current JVM.
     */
    public static PresentationForm[] values() {
        synchronized (VALUES) {
            return VALUES.toArray(new PresentationForm[VALUES.size()]);
        }
    }

    /** Returns the list of enumerations of the same kind than this enum. */
    public PresentationForm[] family() {
        return values();
    }

    /**
     * Returns the presentation form that matches the given string, or returns a new one if none
     * match it.
     *
     * @param code The name of the code to fetch or to create.
     * @return A code matching the given name.
     */
    public static PresentationForm valueOf(String code) {
        return valueOf(PresentationForm.class, code);
    }
}