org.kurator.validation.utility

Class EventUtility

java.lang.Object

org.kurator.validation.utility.EventUtility

public class EventUtility
extends Object

Author:

mole

Field Summary

Fields

Modifier and Type	Field and Description
static String	INTERVAL
static String	INTERVAL_PERIOD
static String	INTERVAL_RECURRINGPERIOD
static String	INTERVAL_ToDayYearMonthOmitted
static String	INTERVAL_ToDayYearOmmitted
static String	INTERVAL_ToMonthYearOmmitted
static String	ISO_DATE
static String	ISO_DATE_TIME
static String	ISO_MONTH
static String	ISO_YEAR
static String	RFC_1123_DATE_TIME
static String	RFC3339_DATETIME

Constructor Summary

Constructors

Constructor and Description
EventUtility()

Method Summary

Modifier and Type	Method and Description
static String	assembleEventDate(Integer year, Integer month, Integer day, Integer startDayOfYear, Integer endDayOfYear)
static boolean	eventDateExists(String eventDate) validation: eventDate contains a valid date or date range (e.g.
static boolean	eventDateInBritishGregorianRange(String eventDate) Test for a measure of quality, does an eventDate fall after the adoption of the Gregorian calendar in the British empire.
static boolean	eventDateInProlepticGregorianRange(String eventDate) Test for a measure of quality, does an eventDate precede the earliest adoption of the Gregorian calendar.
static boolean	eventDateInRussianGregorianRange(String eventDate) Test for a measure of quality, does an eventDate fall after the adoption of the Gregorian calendar by Russia.
static boolean	eventDatePopulated(String eventDate) Test for a measure of quality, does an eventDate have a non-empty value.
static boolean	eventDateSingleDay(String eventDate) Test for a measure of quality, does an event date specify a date to the precision of one day.
static boolean	eventDateStandardFormat(String eventDate) validation: eventDate format conforms to ISO date format.
static boolean	eventDateVerbatimDateConsistent(String EventDate, Integer year, Integer month, Integer day, Integer startDayOfYear, Integer endDayOfYear) validation: eventDate is consistent with verbatimEventDate
static boolean	eventDateWithinOneYear(String eventDate) Test for measure of quality, does an event date specify a date to within a single year.
static boolean	eventInternallyConsistent(String EventDate, Integer year, Integer month, Integer day, Integer startDayOfYear, Integer endDayOfYear) validation: eventDate is consistent with day, month, year, startDayOfYear, endDatOfYear.
static LocalDate	getLocalDateFromString(String date)
static String	identifyDateFormat(String date)
static List<String>	splitDateRange(String date) Given a string that may represent a date or a date range, split into beginning and end dates.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ISO_DATE_TIME

public static final String ISO_DATE_TIME

See Also:

Constant Field Values

RFC_1123_DATE_TIME

public static final String RFC_1123_DATE_TIME

See Also:

Constant Field Values

INTERVAL_ToDayYearOmmitted

public static final String INTERVAL_ToDayYearOmmitted

See Also:

Constant Field Values

INTERVAL_ToDayYearMonthOmitted

public static final String INTERVAL_ToDayYearMonthOmitted

See Also:

Constant Field Values

INTERVAL_ToMonthYearOmmitted

public static final String INTERVAL_ToMonthYearOmmitted

See Also:

Constant Field Values

INTERVAL_PERIOD

public static final String INTERVAL_PERIOD

See Also:

Constant Field Values

INTERVAL_RECURRINGPERIOD

public static final String INTERVAL_RECURRINGPERIOD

See Also:

Constant Field Values

INTERVAL

public static final String INTERVAL

See Also:

Constant Field Values

ISO_DATE

public static final String ISO_DATE

See Also:

Constant Field Values

ISO_MONTH

public static final String ISO_MONTH

See Also:

Constant Field Values

ISO_YEAR

public static final String ISO_YEAR

See Also:

Constant Field Values

RFC3339_DATETIME

public static final String RFC3339_DATETIME

See Also:

Constant Field Values

Constructor Detail

EventUtility

public EventUtility()

Method Detail

eventDatePopulated

public static boolean eventDatePopulated(String eventDate)

Test for a measure of quality, does an eventDate have a non-empty value. Does not test if content has the format for a date.

Parameters:

eventDate - value to test.

Returns:

true if event date is not null and not blank.

eventDateSingleDay

public static boolean eventDateSingleDay(String eventDate)

Test for a measure of quality, does an event date specify a date to the precision of one day.

Parameters:

eventDate -

Returns:

eventDateInProlepticGregorianRange

public static boolean eventDateInProlepticGregorianRange(String eventDate)

Test for a measure of quality, does an eventDate precede the earliest adoption of the Gregorian calendar.

Parameters:

eventDate - value to test.

Returns:

true if event date includes an element prior to 1582-October-15.

eventDateInBritishGregorianRange

public static boolean eventDateInBritishGregorianRange(String eventDate)

Test for a measure of quality, does an eventDate fall after the adoption of the Gregorian calendar in the British empire. In biodiversity data, dates earlier than this date are unlikely.

Parameters:

eventDate - value to test.

Returns:

true if event date falls entirely after 1752-September-14

eventDateInRussianGregorianRange

public static boolean eventDateInRussianGregorianRange(String eventDate)

Test for a measure of quality, does an eventDate fall after the adoption of the Gregorian calendar by Russia.

Parameters:

eventDate - value to test.

Returns:

true if event date falls entirely after 1900-January-7

eventDateWithinOneYear

public static boolean eventDateWithinOneYear(String eventDate)

Test for measure of quality, does an event date specify a date to within a single year.

Parameters:

eventDate -

Returns:

eventDateStandardFormat

public static boolean eventDateStandardFormat(String eventDate)

validation: eventDate format conforms to ISO date format.

Parameters:

eventDate - the event date to assess

Returns:

return true if the provided eventDate conforms to the ISO date format, false otherwise.

eventDateExists

public static boolean eventDateExists(String eventDate)

validation: eventDate contains a valid date or date range (e.g. not 1990-Feb-31).

Parameters:

eventDate - the event date to assess.

Returns:

true if the provided eventDate contatains a valid date or date range value, false otherwise.

eventInternallyConsistent

public static boolean eventInternallyConsistent(String EventDate,
                                                Integer year,
                                                Integer month,
                                                Integer day,
                                                Integer startDayOfYear,
                                                Integer endDayOfYear)

validation: eventDate is consistent with day, month, year, startDayOfYear, endDatOfYear.

Parameters:

EventDate -

year -

month -

day -

startDayOfYear -

endDayOfYear -

Returns:

eventDateVerbatimDateConsistent

public static boolean eventDateVerbatimDateConsistent(String EventDate,
                                                      Integer year,
                                                      Integer month,
                                                      Integer day,
                                                      Integer startDayOfYear,
                                                      Integer endDayOfYear)

validation: eventDate is consistent with verbatimEventDate

Parameters:

EventDate -

year -

month -

day -

startDayOfYear -

endDayOfYear -

Returns:

assembleEventDate

public static String assembleEventDate(Integer year,
                                       Integer month,
                                       Integer day,
                                       Integer startDayOfYear,
                                       Integer endDayOfYear)

splitDateRange

public static List<String> splitDateRange(String date)

Given a string that may represent a date or a date range, split into beginning and end dates. Input order is preserved, no attempt is made to check if beginning date is before end date.

Parameters:

date - a string that may contain an ISO date or date range

Returns:

a list containing date if date does not contain one / otherwise a list of two parts of date split on /.

identifyDateFormat

public static String identifyDateFormat(String date)

getLocalDateFromString

public static LocalDate getLocalDateFromString(String date)
                                        throws DateTimeParseException

Throws:

DateTimeParseException