Module org.apache.sis.feature
Package org.apache.sis.feature

Class AbstractIdentifiedType

Object
AbstractIdentifiedType
All Implemented Interfaces:
Serializable, Deprecable
Direct Known Subclasses:
Abstract­Operation, Default­Association­Role, Default­Attribute­Type, Default­Feature­Type
public class AbstractIdentifiedType extends Object implements Deprecable, Serializable
Identification and description information inherited by property types and feature types.
Warning: This class is expected to implement a GeoAPI Identified­Type interface in a future version. When such interface will be available, most references to Abstract­Identified­Type in the API will be replaced by references to the Identified­Type interface.
Since:
0.5
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • getName

      public final GenericName getName()
      Returns the name of this type. The namespace can be either explicit (scoped name) or implicit (local name).

      For feature types, the name is mandatory and shall be unique in the unit processing the data (e.g. a Data­Store reading a file).

      API design note

      This method is final because it is invoked (indirectly) by subclass constructors, and invoking a user-overrideable method at construction time is not recommended. Furthermore, this attribute is often used as the primary key for Identified­Type instances and need some guarantees about its stability.
      Returns:
      the type name.

    • getDefinition

      public InternationalString getDefinition()
      Returns a concise definition of the element.
      Returns:
      concise definition of the element.

    • getDesignation

      public InternationalString getDesignation()
      Returns a natural language designator for the element. This can be used as an alternative to the name in user interfaces.
      Returns:
      natural language designator for the element, or null if none.

    • getDescription

      public InternationalString getDescription()
      Returns optional information beyond that required for concise definition of the element. The description may assist in understanding the element scope and application.

      If this type is deprecated, then the description should give indication about the replacement (e.g. "superceded by …").

      Returns:
      information beyond that required for concise definition of the element, or null if none.

    • getRemarks

      public InternationalString getRemarks()
      Returns comments on or information about this type. The default implementation performs the following choice:
      • If this type is deprecated, returns the description. The description of deprecated types should give indication about the replacement (e.g. "superceded by …").
      • Otherwise returns null since remarks are not part of the ISO 19109 feature model.
      Specified by:
      get­Remarks in interface Deprecable
      Returns:
      the remarks, or null if none.
      Since:
      0.8

    • isDeprecated

      public boolean isDeprecated()
      Returns true if this type is deprecated. If this method returns true, then the remarks should give indication about the replacement (e.g. "superceded by …").
      Specified by:
      is­Deprecated in interface Deprecable
      Returns:
      whether this type is deprecated.
      Since:
      0.8

    • hashCode

      public int hashCode()
      Returns a hash code value for this type.
      Overrides:
      hash­Code in class Object
      Returns:
      the hash code for this type.

    • equals

      public boolean equals(Object obj)
      Compares this type with the given object for equality.
      Overrides:
      equals in class Object
      Parameters:
      obj - the object to compare with this type.
      Returns:
      true if the given object is equal to this type.