Package org.geotools.api.filter.identity

Interface FeatureId

All Superinterfaces:
Identifier
All Known Subinterfaces:
ResourceId
All Known Implementing Classes:
FeatureIdImpl, FeatureIdVersionedImpl, ResourceIdImpl
public interface FeatureId extends Identifier
Feature identifier.

Features are identified as strings.

Since:
GeoAPI 2.0
Author:
Chris Dillard (SYS Technologies), Justin Deoliveira (The Open Planning Project)

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final char
    VERSION_SEPARATOR
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equalsExact(FeatureId id)
    Check if the provided FeatureId is an exact match (including any optional version information).
    boolean
    equalsFID(FeatureId id)
    Checks if the provided FeatureId reflects the same feature.
    String
    getFeatureVersion()
    Version identifier for the feature instance, may be null
    String
    getID()
    The identifier value, which is a string.
    String
    getPreviousRid()
    previousRid attribute may be used, in implementations that support versioning, to report the previous identifier of a resource.
    String
    getRid()
    id of the resource that shall be selected by the predicate.
    boolean
    matches(Object feature)
    Evaluates the identifer value against the given feature.

    Methods inherited from interface Identifier

    equals, hashCode, toString

  • Field Details

  • Method Details

    • getID

      String getID()
      The identifier value, which is a string.
      Specified by:
      getID in interface Identifier

    • matches

      boolean matches(Object feature)
      Evaluates the identifer value against the given feature.
      Specified by:
      matches in interface Identifier
      Parameters:
      feature - The feature to be tested.
      Returns:
      true if a match, otherwise false.

    • equalsExact

      boolean equalsExact(FeatureId id)
      Check if the provided FeatureId is an exact match (including any optional version information).
      Returns:
      true if this is an exact match (including any optional version information)

    • equalsFID

      boolean equalsFID(FeatureId id)
      Checks if the provided FeatureId reflects the same feature.

      This comparison does not compare any optional version information.

      Returns:
      true if both identifiers describe the same feature (does not compare version information).

    • getRid

      String getRid()
      id of the resource that shall be selected by the predicate.

      Equals to getID() if no feature version is provided, or getID() + "@" + getFeatureVersion() if getFeatureVersion() != null

      If an implementation that references this International Standard supports versioning, the rid shall be a system generated hash containing a logical resource identifier and a version number. The specific details of the hash are implementation dependant and shall be opaque to a client

      If versioning is not supported, the same value than getID() shall be returned.

      Returns:
      Resource identifier made up of FID (combined with FeatureVersion if available)

    • getPreviousRid

      String getPreviousRid()
      previousRid attribute may be used, in implementations that support versioning, to report the previous identifier of a resource.
      Returns:
      Previous rid if available; or null

    • getFeatureVersion

      String getFeatureVersion()
      Version identifier for the feature instance, may be null
      Returns:
      Optional version information; null if not available
      See Also: