Interface Gazetteer


  • @UML(identifier="SI_Gazetteer",
         specification=ISO_19112)
    public interface Gazetteer
    A directory of geographic identifiers describing location instances. Gazetteers contain additional information regarding the position of each location instance. It may include a coordinate reference, but it may also be purely descriptive. If it contains a coordinate reference, this will enable transformation from the spatial reference system using geographic identifiers to the coordinate reference system. If it contains a descriptive reference, this will be a spatial reference using a different spatial reference system with geographic identifiers, for example the postcode of a property. For any location type, there may be more than one gazetteer.
    Since:
    3.1
    • Method Detail

      • getIdentifier

        @UML(identifier="identifier",
             obligation=MANDATORY,
             specification=ISO_19112)
        Identifier getIdentifier()
        Name of the gazetteer. Version date of the gazetteer is included in the name.
        Returns:
        name of the gazetteer, including version date.
        Departure from OGC/ISO specification:
        ISO 19112 defines this property as a CharacterString (free text). GeoAPI changes the type to Identifier for consistency with ReferenceSystemUsingIdentifiers.name and for providing a specific place where to store the version information.
      • getScope

        @UML(identifier="scope",
             obligation=OPTIONAL,
             specification=ISO_19112)
        InternationalString getScope()
        Description of the location types contained in the gazetteer.
        Examples: “streets of London”, “rivers of North America”.
        Returns:
        description of the location types contained in the gazetteer, or null if none.
        See Also:
        ReferenceSystem.getScope()
      • getTerritoryOfUse

        @UML(identifier="territoryOfUse",
             obligation=MANDATORY,
             specification=ISO_19112)
        GeographicExtent getTerritoryOfUse()
        Geographic domain covered by the gazetteer.
        Examples: “North America” for the geographic domain of a gazetteer of rivers, and “London” for a gazetteer of streets.
        Returns:
        geographic domain covered by the gazetteer.
        See Also:
        LocationType.getTerritoryOfUse(), ReferenceSystemUsingIdentifiers.getDomainOfValidity()
      • getCoordinateReferenceSystem

        @UML(identifier="coordinateSystem",
             obligation=OPTIONAL,
             specification=ISO_19112)
        CoordinateReferenceSystem getCoordinateReferenceSystem()
        Coordinate reference system used in the gazetteer for describing position.
        Returns:
        coordinate reference system used in the gazetteer, or null if none.
        Departure from OGC/ISO specification:
        Renamed coordinateSystem as coordinateReferenceSystem for consistency with the type and usage in the rest of GeoAPI.
      • getLocationTypes

        @UML(identifier="locationType",
             obligation=MANDATORY,
             specification=ISO_19112)
        Collection<? extends LocationType> getLocationTypes()
        Description of location type(s) for which instances are recorded in the gazetteer.
        Returns:
        description of location type(s) for which instances are recorded in the gazetteer.
        See Also:
        ReferenceSystemUsingIdentifiers.getLocationTypes()