Interface ExcelDateUtils

  • All Known Implementing Classes:
    DefaultExcelDateUtils

    public interface ExcelDateUtils
    Utility for excel date operations.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Date convertToImportedDate​(java.lang.String date)
      Converts given date in excel date timezone into system date in system timezone.
      java.lang.String exportDate​(java.util.Date date)
      Exports given date in excel date timezone using getDateTimeFormat()
      java.lang.String exportDateRange​(java.util.Date start, java.util.Date end)
      Exports date range
      org.apache.commons.lang3.tuple.Pair<java.lang.String,​java.lang.String> extractDateRange​(java.lang.String cellValue)
      Extracts from given value start and end date.
      java.lang.String getDateRangeParamKey()
      Returns date range param key which will be getDateRangePattern() without [ and ] around the range.
      java.lang.String getDateRangePattern()
      Returns date range patter used in excel column header e.g.
      java.lang.String getDateTimeFormat()
      Return date and time format e.g.
      java.lang.String getExportTimeZone()
      Timezone in which dates are exported into excel e.g.
      java.lang.String importDate​(java.lang.String date)
      Converts date in excel date timezone into system date zone date string.
    • Method Detail

      • extractDateRange

        org.apache.commons.lang3.tuple.Pair<java.lang.String,​java.lang.String> extractDateRange​(java.lang.String cellValue)
        Extracts from given value start and end date. Expected format is "start to end"
        Parameters:
        cellValue - value from which date range will be extracted.
        Returns:
        pair of start and end date.
      • getDateRangePattern

        java.lang.String getDateRangePattern()
        Returns date range patter used in excel column header e.g. [dd.MM.yyyy HH:mm:ss to dd.MM.yyyy HH:mm:ss]
        Returns:
        string with date range pattern.
      • getDateRangeParamKey

        java.lang.String getDateRangeParamKey()
        Returns date range param key which will be getDateRangePattern() without [ and ] around the range.
        Returns:
        date range param key.
      • exportDateRange

        java.lang.String exportDateRange​(java.util.Date start,
                                         java.util.Date end)
        Exports date range
        Parameters:
        start - start date
        end - end date
        Returns:
        string representation of date range which follows pattern from getDateRangePattern()
      • getDateTimeFormat

        java.lang.String getDateTimeFormat()
        Return date and time format e.g. dd.MM.yyyy HH:mm:ss.
        Returns:
        dateTime format.
      • exportDate

        java.lang.String exportDate​(java.util.Date date)
        Exports given date in excel date timezone using getDateTimeFormat()
        Parameters:
        date - date to be exported
        Returns:
        date string representation in excel date timezone getExportTimeZone().
      • importDate

        java.lang.String importDate​(java.lang.String date)
        Converts date in excel date timezone into system date zone date string.
        Parameters:
        date - date in excel date timezone getExportTimeZone()
        Returns:
        date string in system timezone.
      • convertToImportedDate

        java.util.Date convertToImportedDate​(java.lang.String date)
        Converts given date in excel date timezone into system date in system timezone.
        Parameters:
        date - date in excel date timezone getExportTimeZone()
        Returns:
        date in system timezone.
      • getExportTimeZone

        java.lang.String getExportTimeZone()
        Timezone in which dates are exported into excel e.g. UTC
        Returns:
        excel timezone