Package org.gedcomx.date

Class GedcomxDateSimple

java.lang.Object
org.gedcomx.date.GedcomxDate
org.gedcomx.date.GedcomxDateSimple
All Implemented Interfaces:
Comparable<GedcomxDate>
public class GedcomxDateSimple extends GedcomxDate
A Simple Date
Author:
John Clark.

  • Constructor Details

    • GedcomxDateSimple

      public GedcomxDateSimple(String date)
      Instantiate a new Simple date based off of a formal date string.
      Parameters:
      date - The date

  • Method Details

    • getType

      public GedcomxDateType getType()
      Get the Date Type
      Specified by:
      getType in class GedcomxDate
      Returns:
      The type

    • isApproximate

      public boolean isApproximate()
      Whether or not this date can be considered approximate
      Specified by:
      isApproximate in class GedcomxDate
      Returns:
      True if this is approximate

    • toFormalString

      public String toFormalString()
      Output the formal string for this date
      Specified by:
      toFormalString in class GedcomxDate
      Returns:
      The formal date string

    • getYear

      public Integer getYear()
      Get the year
      Returns:
      The Year

    • getMonth

      public Integer getMonth()
      Get the month
      Returns:
      The Month

    • getDay

      public Integer getDay()
      Get the day
      Returns:
      The Day

    • getHours

      public Integer getHours()
      Get the hours
      Returns:
      The Hours

    • getMinutes

      public Integer getMinutes()
      Get the minutes
      Returns:
      The Minutes

    • getSeconds

      public Integer getSeconds()
      Get the seconds
      Returns:
      The seconds

    • getTzHours

      public Integer getTzHours()
      Get the timezone hours
      Returns:
      The Timezone Hours

    • getTzMinutes

      public Integer getTzMinutes()
      Get the timezone minutes
      Returns:
      The Timezone Minutes

    • compareTo

      public int compareTo(GedcomxDate other)
      Compares this GedcomxDateSimple object with either another GedcomxDateSimple object or a GedcomxDateApproximate object. Comparison is achieved by using an ISO 8601 date format using the populated temporal fields in this object amd the fields in the other object. If a field is null it defaults to a "0th" value. So in the case of the simplest date of only a year field value it would default to January 1 at midnight UTC of the given year. ISO 8601 conversion occurs for both this and other. In other words, if there is missing field information it will reflect as the earliest possible ISO 8601 representation of the object to use in comparison.
      Specified by:
      compareTo in interface Comparable<GedcomxDate>
      Overrides:
      compareTo in class GedcomxDate
      Parameters:
      other - the object to be compared.
      Returns:
      a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object
      Throws:
      ClassCastException - if other is not of type GedcomxDateSimple or GedcomxDateApproximate
      NullPointerException - if other is null