Package org.gedcomx.types

Enum Class SourceReferenceQualifierType

java.lang.Object
java.lang.Enum<SourceReferenceQualifierType>
org.gedcomx.types.SourceReferenceQualifierType
All Implemented Interfaces:
Serializable, Comparable<SourceReferenceQualifierType>, Constable, ControlledVocabulary
public enum SourceReferenceQualifierType extends Enum<SourceReferenceQualifierType> implements ControlledVocabulary
Enumeration of standard source reference qualifiers.

  • Enum Constant Details

    • CharacterRegion

      public static final SourceReferenceQualifierType CharacterRegion
      A region of text in a digital document, in the form of `a,b` where `a` is the start character and `b` is the end character.

    • RectangleRegion

      public static final SourceReferenceQualifierType RectangleRegion
      A rectangular region of a digital image. The value of the qualifier is interpreted as a series of four comma-separated numbers. If all of the numbers is less than 1, the value is interpreted in the form of `x1,y1,x2,y2` where `x1,y1` is the relative percentage-based coordinates of the top-left corner of the rectangle and `x2,y2` is the relative percentage-based coordinates of the bottom-right corner of the rectangle. If any of the numbers is more than 1, the value is interpreted in the form of `x,y,w,h` where `x` is the point on the X axis of the image in pixels, `y` is the point on the Y axis in pixels, `w` is the width of the rectangle in pixels, and `h` in the height of the rectangle in pixels.

    • TimeRegion

      public static final SourceReferenceQualifierType TimeRegion
      A region of time of an audio or video recording, in the form of `a,b` where `a` is the starting point in milliseconds and `b` is the ending point in milliseconds.

    • OTHER

      public static final SourceReferenceQualifierType OTHER

  • Method Details

    • values

      public static SourceReferenceQualifierType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SourceReferenceQualifierType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • toQNameURI

      public URI toQNameURI()
      Return the QName value for this enum.
      Specified by:
      toQNameURI in interface ControlledVocabulary
      Returns:
      The QName value for this enum.

    • fromQNameURI

      public static SourceReferenceQualifierType fromQNameURI(URI qname)
      Get the enumeration from the QName.
      Parameters:
      qname - The qname.
      Returns:
      The enumeration.