src.gov.nasa.worldwind.ogc.kml.KMLConstants Maven / Gradle / Ivy

/*
 * Copyright (C) 2012 United States Government as represented by the Administrator of the
 * National Aeronautics and Space Administration.
 * All Rights Reserved.
 */

package gov.nasa.worldwind.ogc.kml;

import gov.nasa.worldwind.ogc.collada.ColladaConstants;

/**
 * Defines constants used by the KML parser classes.
 *
 * @author tag
 * @version $Id: KMLConstants.java 1171 2013-02-11 21:45:02Z dcollins $
 */
public interface KMLConstants
{
    /** The KML 2.2 namespace URI. */
    final String KML_2dot0_NAMESPACE = "http://earth.google.com/kml/2.0";
    final String KML_2dot1_NAMESPACE = "http://earth.google.com/kml/2.1";
    final String KML_2dot2_NAMESPACE = "http://www.opengis.net/kml/2.2";
    final String KML_GOOGLE_2dot2_NAMESPACE = "http://earth.google.com/kml/2.2";
    final String KML_NAMESPACE = KML_2dot2_NAMESPACE;

    /** List of the versioned KML namespaces. */
    final String[] KML_NAMESPACES = {
        KML_2dot2_NAMESPACE,
        KML_GOOGLE_2dot2_NAMESPACE,
        KML_2dot1_NAMESPACE,
        KML_2dot0_NAMESPACE
    };

    /** The mime type for KML documents. */
    final String KML_MIME_TYPE = "application/vnd.google-earth.kml+xml";
    /** The mime type for KMZ documents. */
    final String KMZ_MIME_TYPE = "application/vnd.google-earth.kmz";

    /** @deprecated Use {@link ColladaConstants#COLLADA_MIME_TYPE}. */
    @Deprecated
    final String COLLADA_MIME_TYPE = ColladaConstants.COLLADA_MIME_TYPE;

    /** Most recent version of KML that WorldWind supports. */
    final String KML_VERSION = "2.2";

    // Style state enums
    final String NORMAL = "normal";
    final String HIGHLIGHT = "highlight";
    final String STYLE_STATE = "styleState"; // a key for a style state field

    // The key that identifies resolved styles in a parser's field map.
    final String BALOON_STYLE_FIELD = "BaloonStyle";
    final String ICON_STYLE_FIELD = "IconStyle";
    final String LABEL_STYLE_FIELD = "LabelStyle";
    final String LINE_STYLE_FIELD = "LineStyle";
    final String LIST_STYLE_FIELD = "ListStyle";
    final String POLY_STYLE_FIELD = "PolyStyle";
    final String STYLE_FIELD = "Style";
    final String STYLE_MAP_FIELD = "StyleMap";
    final String STYLE_URL_FIELD = "styleUrl";

    /**
     * The KML view refresh mode never. Indicates that a resource referenced by a KMLLink
     * should ignore changes in the geographic view, and ignore the link's viewFormat property.
     */
    final String NEVER = "never";
    /**
     * The KML view refresh mode onRequest. Indicates that a resource referenced by a KMLLink
     * should refresh only when the user explicitly requests it.
     */
    final String ON_REQUEST = "onRequest";
    /**
     * The KML view refresh mode onStop. Indicates that a resource referenced by a KMLLink
     * should refresh at an elapsed time after view movement stops. The time is specified by the link's
     * viewRefreshTime property.
     */
    final String ON_STOP = "onStop";
    /**
     * The KML view refresh mode onRegion. Indicates that a resource referenced by a KMLLink
     * should refresh if a certain KMLRegion becomes active. The KMLRegion is specified by an
     * ancestor of the KMLLink.
     */
    final String ON_REGION = "onRegion";
    /**
     * The KML link refresh mode onInterval. Indicates that a resource referenced by a KMLLink
     * should refresh periodically.
     */
    final String ON_INTERVAL = "onInterval";
    /**
     * The KML view refresh mode onExpire. Indicates that a resource referenced by a KMLLink
     * should refresh when the resource expires. The expiration time can be set by a HTTP header, or by a {@link
     * KMLNetworkLinkControl} element.
     */
    final String ON_EXPIRE = "onExpire";
    /**
     * The KML view refresh mode onChange. Indicates that a resource referenced by a KMLLink
     * should refresh when the file containing the link is loaded, or when the link parameters change.
     */
    final String ON_CHANGE = "onChange";
}