Package org.apache.sis.internal.util

Class Constants

java.lang.Object
org.apache.sis.util.Static
org.apache.sis.internal.util.Constants
public final class Constants extends Static
Hard coded values (typically identifiers). The set of constants defined in this class may change in any SIS version - do not rely on them.

When to use

Those constants should be used mostly for names, aliases or identifiers. They should generally not be used for abbreviations for instance, even if the abbreviation result in the same string. Those constants do not need to be used systematically in tests neither, especially when the test creates itself the instance to be tested.
Since:
0.5
Version:
1.3

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    AFFINE
    The OGC name for "Affine parametric transformation".
    static final String
    CENTRAL_MERIDIAN
    The OGC parameter name for the central meridian.
    static final String
    CRS
    The "CRS" code space.
    static final byte
    CRS1
    The CRS:1 identifier for a coordinate reference system.
    static final byte
    CRS27
    The CRS:27 identifier for a coordinate reference system.
    static final byte
    CRS83
    The CRS:83 identifier for a coordinate reference system.
    static final byte
    CRS84
    The CRS:84 identifier for a coordinate reference system.
    static final byte
    CRS88
    The CRS:88 identifier for a coordinate reference system.
    static final byte
    DEFAULT_INDENTATION
    The default indentation value to use in various text formats (both WKT and XML).
    static final char
    DEFAULT_SEPARATOR
    The default separator, which is ':'.
    static final String
    DIM
    Name of a SIS-specific parameter for setting the number of dimensions of a coordinate operation.
    static final String
    EARTH_RADIUS
    The netCDF parameter name for the Earth radius.
    static final String
    EPSG
    The "EPSG" code space.
    static final short
    EPSG_A0
    EPSG code of the A0 coefficient used in affine (general parametric) and polynomial transformations.
    static final short
    EPSG_ANTARCTIC_POLAR_STEREOGRAPHIC
    EPSG code of "WGS 84 / Antarctic Polar Stereographic" projection.
    static final short
    EPSG_ARCTIC_POLAR_STEREOGRAPHIC
    EPSG code of "WGS 84 / Arctic Polar Stereographic" projection.
    static final short
    EPSG_AXIS_DEGREES
    The EPSG code for degrees when used in axes.
    static final short
    EPSG_B0
    EPSG code of the B0 coefficient used in affine (general parametric) and polynomial transformations.
    static final short
    EPSG_GREENWICH
    The EPSG code for the Greenwich prime meridian.
    static final short
    EPSG_METRE
    The EPSG code for metres.
    static final short
    EPSG_PARAM_DEGREES
    The EPSG code for degrees when used in parameters.
    static final String
    FALSE_EASTING
    The OGC parameter name for the false easting or northing.
    static final String
    FALSE_NORTHING
    The OGC parameter name for the false easting or northing.
    static final String
    GEOTIFF
    The "GeoTIFF" code space.
    static final String
    HTTP
    The "http:" protocol.
    static final String
    INVERSE_FLATTENING
    The netCDF parameter name for inverse flattening, and whether that parameter is definitive.
    static final String
    IOGP
    The "IOGP" authority, which is the maintainer of the EPSG database.
    static final String
    IS_IVF_DEFINITIVE
    The netCDF parameter name for inverse flattening, and whether that parameter is definitive.
    static final String
    LATITUDE_OF_ORIGIN
    The OGC parameter name for the latitude of origin.
    static final String
    NUM_COL
    Name of the "num_col" matrix parameters.
    static final String
    NUM_ROW
    Name of the "num_row" matrix parameters.
    static final String
    OGC
    The "OGC" authority and code space.
    static final String
    PROJ4
    The "Proj4" code space.
    static final String
    SCALE_FACTOR
    The OGC parameter name for the scale factor.
    static final String
    SEMI_MAJOR
    Name of the "semi_major" projection parameter, which is handled specially during WKT formatting.
    static final String
    SEMI_MINOR
    Name of the "semi_minor" projection parameter, which is handled specially during WKT formatting.
    static final String
    SIS
    The "SIS" code space.
    static final String
    STANDARD_PARALLEL
    The netCDF parameter name for the standard parallels.
    static final String
    STANDARD_PARALLEL_1
    The OGC parameter name for the standard parallels.
    static final String
    STANDARD_PARALLEL_2
    The OGC parameter name for the standard parallels.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    Constants()
    Do not allow instantiation of this class.

  • Method Summary

    Methods inherited from class java.lang.Object

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

  • Field Details

    • DEFAULT_SEPARATOR

      public static final char DEFAULT_SEPARATOR
      The default separator, which is ':'. The separator is inserted between the code space and the code in identifiers.
      See Also:

    • DEFAULT_INDENTATION

      public static final byte DEFAULT_INDENTATION
      The default indentation value to use in various text formats (both WKT and XML). We use a small value (2 instead of 4) because OGC's XML are very verbose.
      See Also:

    • HTTP

      public static final String HTTP
      The "http:" protocol. Used in XML namespaces.
      See Also:

    • GEOTIFF

      public static final String GEOTIFF
      The "GeoTIFF" code space.
      See Also:

    • EPSG

      public static final String EPSG
      The "EPSG" code space.
      See Also:

    • IOGP

      public static final String IOGP
      The "IOGP" authority, which is the maintainer of the EPSG database. Used as the EPSG authority, while EPSG is used as the code space.
      See Also:

    • OGC

      public static final String OGC
      The "OGC" authority and code space.
      See Also:

    • SIS

      public static final String SIS
      The "SIS" code space.
      See Also:

    • PROJ4

      public static final String PROJ4
      The "Proj4" code space. The project name is "Proj.4", but this constant omits the dot because this name is used as a code space and we want to avoid risk of confusion. We use "Proj4" instead of "PROJ" for historical reasons, because we use this identifier for parameters defined by old PROJ versions, before PROJ 6 introduced full support of EPSG names.
      See Also:

    • CRS

      public static final String CRS
      The "CRS" code space.
      See Also:

    • CRS27

      public static final byte CRS27
      The CRS:27 identifier for a coordinate reference system.
      See Also:

    • CRS83

      public static final byte CRS83
      The CRS:83 identifier for a coordinate reference system.
      See Also:

    • CRS84

      public static final byte CRS84
      The CRS:84 identifier for a coordinate reference system.
      See Also:

    • CRS88

      public static final byte CRS88
      The CRS:88 identifier for a coordinate reference system.
      See Also:

    • CRS1

      public static final byte CRS1
      The CRS:1 identifier for a coordinate reference system.
      See Also:

    • DIM

      public static final String DIM
      Name of a SIS-specific parameter for setting the number of dimensions of a coordinate operation. This constant should be used only in the context of coordinate operations, not in other contexts (e.g. not for the netCDF attribute of the same name).
      See Also:

    • EARTH_RADIUS

      public static final String EARTH_RADIUS
      The netCDF parameter name for the Earth radius.
      See Also:

    • SEMI_MAJOR

      public static final String SEMI_MAJOR
      Name of the "semi_major" projection parameter, which is handled specially during WKT formatting.
      See Also:

    • SEMI_MINOR

      public static final String SEMI_MINOR
      Name of the "semi_minor" projection parameter, which is handled specially during WKT formatting.
      See Also:

    • INVERSE_FLATTENING

      public static final String INVERSE_FLATTENING
      The netCDF parameter name for inverse flattening, and whether that parameter is definitive. The latter is specific to SIS.
      See Also:

    • IS_IVF_DEFINITIVE

      public static final String IS_IVF_DEFINITIVE
      The netCDF parameter name for inverse flattening, and whether that parameter is definitive. The latter is specific to SIS.
      See Also:

    • CENTRAL_MERIDIAN

      public static final String CENTRAL_MERIDIAN
      The OGC parameter name for the central meridian.
      See Also:

    • LATITUDE_OF_ORIGIN

      public static final String LATITUDE_OF_ORIGIN
      The OGC parameter name for the latitude of origin.
      See Also:

    • STANDARD_PARALLEL

      public static final String STANDARD_PARALLEL
      The netCDF parameter name for the standard parallels.
      See Also:

    • STANDARD_PARALLEL_1

      public static final String STANDARD_PARALLEL_1
      The OGC parameter name for the standard parallels.
      See Also:

    • STANDARD_PARALLEL_2

      public static final String STANDARD_PARALLEL_2
      The OGC parameter name for the standard parallels.
      See Also:

    • SCALE_FACTOR

      public static final String SCALE_FACTOR
      The OGC parameter name for the scale factor. While Apache SIS uses EPSG names when possible, the OGC names are convenient in this case because they do not depend on the projection. For example, EPSG has at least three different names for the scale factor, depending on the projection:
      • Scale factor at natural origin
      • Scale factor on initial line
      • Scale factor on pseudo standard parallel
      Usage of OGC names avoid the need to choose a name according the projection.
      See Also:

    • FALSE_EASTING

      public static final String FALSE_EASTING
      The OGC parameter name for the false easting or northing. While Apache SIS uses EPSG names when possible, the OGC names are convenient in this case because they do not depend on the projection. For example, EPSG has at least two different names for false northing, depending on the projection:
      • Northing at false origin
      • Northing at projection centre
      Usage of OGC names avoid the need to choose a name according the projection.
      See Also:

    • FALSE_NORTHING

      public static final String FALSE_NORTHING
      The OGC parameter name for the false easting or northing. While Apache SIS uses EPSG names when possible, the OGC names are convenient in this case because they do not depend on the projection. For example, EPSG has at least two different names for false northing, depending on the projection:
      • Northing at false origin
      • Northing at projection centre
      Usage of OGC names avoid the need to choose a name according the projection.
      See Also:

    • NUM_ROW

      public static final String NUM_ROW
      Name of the "num_row" matrix parameters.
      See Also:

    • NUM_COL

      public static final String NUM_COL
      Name of the "num_col" matrix parameters.
      See Also:

    • AFFINE

      public static final String AFFINE
      The OGC name for "Affine parametric transformation".
      See Also:

    • EPSG_A0

      public static final short EPSG_A0
      EPSG code of the A0 coefficient used in affine (general parametric) and polynomial transformations. Codes for parameters A1 to A8 inclusive follow, but the affine coefficients stop at A2.
      See Also:

    • EPSG_B0

      public static final short EPSG_B0
      EPSG code of the B0 coefficient used in affine (general parametric) and polynomial transformations. Codes for parameters B1 to B3 inclusive follow, but the affine coefficients stop at B2.
      See Also:

    • EPSG_METRE

      public static final short EPSG_METRE
      The EPSG code for metres.
      See Also:

    • EPSG_PARAM_DEGREES

      public static final short EPSG_PARAM_DEGREES
      The EPSG code for degrees when used in parameters.
      See Also:

    • EPSG_AXIS_DEGREES

      public static final short EPSG_AXIS_DEGREES
      The EPSG code for degrees when used in axes.
      See Also:

    • EPSG_GREENWICH

      public static final short EPSG_GREENWICH
      The EPSG code for the Greenwich prime meridian.
      See Also:

    • EPSG_ARCTIC_POLAR_STEREOGRAPHIC

      public static final short EPSG_ARCTIC_POLAR_STEREOGRAPHIC
      EPSG code of "WGS 84 / Arctic Polar Stereographic" projection. Latitude of standard parallel is 71°N. All other parameters are zero.
      See Also:

    • EPSG_ANTARCTIC_POLAR_STEREOGRAPHIC

      public static final short EPSG_ANTARCTIC_POLAR_STEREOGRAPHIC
      EPSG code of "WGS 84 / Antarctic Polar Stereographic" projection. Latitude of standard parallel is 71°S. All other parameters are zero.
      See Also:

  • Constructor Details

    • Constants

      private Constants()
      Do not allow instantiation of this class.