Interface Location


  • @UML(identifier="SI_LocationInstance",
         specification=ISO_19112)
    public interface Location
    Identifiable geographic place. Properties of location instances are described by LocationType. The minimum set of attributes of each location instance is:
    • geographic identifier (the value, for example a name or code)
    • geographic extent (the position of the identified thing)
    • administrator (who is responsible for this identifier)
    • location type (which specifies the nature of the identifier and its associated geographic location)
    The following may also be recorded:
    • temporal extent
    • alternative geographic identifier
    • position (mandatory if the geographic identifier contains insufficient information to identify location)
    • parent location instance
    • child location instance
    Since:
    3.1
    See Also:
    LocationType
    • Method Detail

      • getGeographicIdentifier

        @UML(identifier="geographicIdentifier",
             obligation=MANDATORY,
             specification=ISO_19112)
        InternationalString getGeographicIdentifier()
        Unique identifier for the location instance. The methods of identifying locations is specified by the location type identifications.
        Examples: if LocationType.getIdentifications() contain “name”, then geographic identifiers may be country names like “Japan” or “France”, or places like “Eiffel Tower”. If location type identifications contain “code”, then geographic identifiers may be “SW1P 3AD” postcode.
        In order to ensure that a geographic identifier is unique within a wider geographic domain, the geographic identifier may need to include an identifier of an instance of a parent location type, for example “Paris, Texas”.
        Returns:
        unique identifier for the location instance.
        See Also:
        LocationType.getIdentifications()
      • getGeographicExtent

        @UML(identifier="geographicExtent",
             obligation=MANDATORY,
             specification=ISO_19112)
        GeographicExtent getGeographicExtent()
        Description of the location instance. The geographic extent shall be defined in one of the following ways:
        • As a collection of smaller geographic features. Example: the European Union, defined by its constituent countries;
        • By a bounding polygon, described by either of the following:
          • As a closed set of boundary segments (each defined by one or more geographic features). Example: a block defined by the bounding streets.
          • By a set of coordinates. Example: a land parcel defined by the coordinates of its boundary.
        Returns:
        description of the location instance.
        See Also:
        GeographicDescription, GeographicBoundingBox, BoundingPolygon
      • getEnvelope

        Envelope getEnvelope()
        Returns an envelope that encompass the location. This property is partially redundant with getGeographicExtent(), except that this method allows envelopes in projected CRS.
        Returns:
        envelope that encompass the location, or null if none.
        Departure from OGC/ISO specification:
        This method has been added because getGeographicExtent() does not provide an easy way to get the spatial extent in location "native" coordinate reference system (CRS) if that CRS is not geographic. For example if the location provides coordinates in a projected CRS, then its envelope can not be represented directly in a GeographicBoundingBox.
      • getPosition

        @UML(identifier="position",
             obligation=CONDITIONAL,
             specification=ISO_19112)
        Position getPosition()
        Coordinates of a representative point for the location instance. An example of the position is the coordinates of the centroid of the location instance. This provides a linking mechanism to spatial referencing by coordinates.

        Position must be recorded if the geographic identifier contains insufficient information to identify location.

        Returns:
        coordinates of a representative point for the location instance, or null if none.
        Departure from OGC/ISO specification:
        ISO 19112 declares the GM_Point type. GeoAPI uses the Position union for allowing the use of either GM_Point or DirectPosition.