com.rgi.geopackage.metadata.Scope Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swagd Show documentation
SWAGD: Software to Aggregate Geospatial Data
The newest version!
/* The MIT License (MIT)
 *
 * Copyright (c) 2015 Reinventing Geospatial, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * 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 OR COPYRIGHT HOLDERS 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.
 */

package com.rgi.geopackage.metadata;

import java.util.stream.Stream;

/**
 * GeoPackage Metadata Scopes
 *
 * 
 * The initial contents of this table were obtained from the ISO 19115,
 * Annex B B.5.25 MD_ScopeCode code list, which was extended for use in the
 * GeoPackage specification by addition of entries with "NA" as the scope
 * code column in Metadata Table Definition.
 * 
 *
 * @see OGC® GeoPackage Encoding Standard - 2.4.2.1.2. Table Data Values
 *
 * @author Luke Lambert
 */

public enum Scope
{
    /**
     * Scope with the following values: "undefined", "NA",
     * "Metadata information scope is undefined"
     */
    // http://www.geopackage.org/spec/#metadata_scopes
    Undefined           ("undefined",             "NA", "Metadata information scope is undefined"),
    /**
     * Scope with the following values: "fieldSession", "012",
     * "Information applies to the field session"
     */
    FieldSession        ("fieldSession",         "012", "Information applies to the field session"),
    /**
     * Scope with the following values: "collectionSession", "004",
     * "Information applies to the collection session"
     */
    CollectionSession   ("collectionSession",    "004", "Information applies to the collection session"),
    /**
     * Scope with the following values: "collectionSession", "004",
     * "Information applies to the collection session"
     */
    Series              ("series",               "006", "Information applies to the (dataset) series"),
    /**
     * Scope with the following values: "dataset", "005",
     * "Information applies to the (geographic feature) dataset"
     */
    Dataset             ("dataset",              "005", "Information applies to the (geographic feature) dataset"),
    /**
     * Scope with the following values: "featureType", "010",
     * "Information applies to a feature type (class)"
     */
    FeatureType         ("featureType",          "010", "Information applies to a feature type (class)"),
    /**
     * Scope with the following values: "feature", "009",
     * "Information applies to a feature (instance)"
     */
    Feature             ("feature",              "009", "Information applies to a feature (instance)"),
    /**
     * Scope with the following values: "attributeType", "002",
     * "Information applies to the attribute class"
     */
    AttributeType       ("attributeType",        "002", "Information applies to the attribute class"),
    /**
     * Scope with the following values: "attribute", "001",
     * "Information applies to the characteristic of a feature (instance)"
     */
    Attribute           ("attribute",            "001", "Information applies to the characteristic of a feature (instance)"),
    /**
     * Scope with the following values: "tile", "016",
     * "Information applies to a tile a spatial subset of geographic data"
     */
    Tile                ("tile",                 "016", "Information applies to a tile a spatial subset of geographic data"),
    /**
     * Scope with the following values: "model", "015",
     * "Information applies to a copy or imitation of an existing or hypothetical object"
     */
    Model               ("model",                "015", "Information applies to a copy or imitation of an existing or hypothetical object"),
    /**
     *  Scope with the following values:
     *  "catalog", "NA", "Metadata applies to a feature catalog"
     */
    Catalog             ("catalog",               "NA", "Metadata applies to a feature catalog"),
    /**
     * Scope with the following values: "schema", "NA",
     * "Metadata applies to an application schema"
     */
    Schema              ("schema",                "NA", "Metadata applies to an application schema"),
    /**
     * Scope with the following values: "taxonomy", "NA",
     * "Metadata applies to a taxonomy or knowledge system"
     */
    Taxonomy            ("taxonomy",              "NA", "Metadata applies to a taxonomy or knowledge system"),
    /**
     * Scope with the following values: "software", "013",
     * "Information applies to a computer program or routine"
     */
    Software            ("software",             "013", "Information applies to a computer program or routine"),
    /**
     * Scope with the following values: ("service", "014",
     * "Information applies to a capability which a service provider entity makes available to a service user entity through a set of interfaces that define a behaviour such as a use case"
     */
    Service             ("service",              "014", "Information applies to a capability which a service provider entity makes available to a service user entity through a set of interfaces that define a behaviour such as a use case"),
    /**
     * Scope with the following values: "collectionHardware", "003",
     * "Information applies to the collection hardware class"
     */
    CollectionHardware  ("collectionHardware",   "003", "Information applies to the collection hardware class"),
    /**
     * Scope with the following values: "nonGeographicDataset", "007",
     * "Information applies to non-geographic data"
     */
    NonGeographicDataset("nonGeographicDataset", "007", "Information applies to non-geographic data"),
    /**
     * Scope with the following values: "dimensionGroup", "008",
     * "Information applies to a dimension group"
     */
    DimensionGroup      ("dimensionGroup",       "008", "Information applies to a dimension group");

    private Scope(final String name, final String code, final String description)
    {
        this.name        = name;
        this.code        = code;
        this.description = description;
    }

    /**
     * @param inName the name of the Scope value in form of a string
     * @return the Scope object that corresponds to the inName
     */
    public static Scope fromString(final String inName)
    {
        return Stream.of(Scope.values())
                     .filter(scope -> scope.toString().equalsIgnoreCase(inName))
                     .findFirst()
                     .orElse(null);
    }

    @Override
    public String toString()
    {
        return this.name;
    }

    /**
     * @return the code
     */
    public String getCode()
    {
        return this.code;
    }

    /**
     * @return the description
     */
    public String getDescription()
    {
        return this.description;
    }

    private final String name;
    private final String code;
    private final String description;
}