oracle-databasejava-8jodatimejdedwards

Does JodaTime or Java 8 have special support JD Edwards Date and Time?


The topic at hand is a messy domain-specific problem working with dates in Oracle's ERP software called JD Edwards. Its detail is documented in this question.

Before writing wrapper classes for handling the dates and times from JD Edwards, I want to know if JodaTime or Java 8 introduced any special support for this unique time format, or if I'll have to do significant string manipulation regardless of the libraries I use.

This is an obscure problem, so please only respond if you have specific knowledge of this problem, and/or JodaTime/Java 8/JSR 310.

ADDITION: Per Basil Bourque's request, adding example of timestamps that accompany said dates. Here are two example of date/time fields from different tables:

JCSBMDATE:115100, JCSBMTIME:120102.0

RLUPMJ:114317, RLUPMT:141805.0

Also, the date variable is being cast as a BigDecimal and the time is a Double. So, I'll probably keep the string parsers around, but also write factory methods that take the BigDecimal/Double values natively as well.

It seems that the time field is actually the number of Milliseconds (not seconds) from the start of the day, and the ".0" can be ignored. So, one will have to perform a conversion and calculation like so:

localDate.atTime(LocalTime.ofNanoOfDay(Long.parseLong(jdeTime) * 1000000))


Solution

  • JD Edwards date defined

    Actually the detail of a JD Edwards date is not so gory, according to this simple description on a page at Oracle.com:

    About the Julian Date Format

    Date fields in JD Edwards World files are stored in the Julian format. …

    The Julian (*JUL) date format is CYYDDD, where:

    C is added to 19 to create the century, i.e. 0 + 19 = 19, 1 + 19 = 20. YY is the year within the century, DDD is the day in the year.

    Terms:

    The java.time framework does not include direct support for parsing or generating strings of this format, not that I can find.

    JulianFields

    There is the java.time.temporal.JulianFields but those are for an redefined version of Julian dates where we count the number of days from an epoch (1970-01-01 (ISO) rather than the historic November 24, 4714 BC (proleptic Gregorian)), while ignoring years altogether. So this has nothing to do with the JD Edwards definition, contrary to some incorrect advice on that page linked in the Question.

    Ordinal Date

    This JD Edwards date is a version of an ordinal date. The ordinal date is sometimes referred to casually (and incorrectly) as a "julian" date only because it shares the idea of counting a sequence of days. But an ordinal date counts days from the beginning of the year to end of year for a number always between 1 and 365/366 (leap year), not counting since some epoch and growing into a number into the thousands.

    Back to the Question, handling the JD Edwards date in java.time…

    No, I do not find any direct or indirect support the JD Edwards date built into java.time.

    The java.date.format package seems unaware of the century of a date, only the year and the era. So no way that I can find to define the C part of a JD Edwards date.

    The last part of a JD Edwards date, the ordinal number of days in the year, is well-handled with within both the date-time classes and the formatting classes.

    Wrap LocalDate

    Since a JD Edwards date apparently has the same logic as the ISO chronology used by java.time, the only real issue at hand is parsing and generating String objects according to this particular format. All other behavior can be leveraged from a LocalDate.

    Since I cannot find a way to define a java.time.format.DateTimeFormatter for this purpose, I suggest writing a utility class to handle these chores.

    Ideally we would extend the LocalDate class, overriding its parse and toString methods. And perhaps a getCenturyOffset method. But the LocalDate class is marked final and cannot be extended. So I would create something like this class shown below, wrapping a LocalDate.

    CAVEAT: Use at your own risk. Fresh code, barely run, hardly tested. Meant as an example, not for use in production. Use according to terms of the ISC License.

    package com.example.whatever;
    
    import java.time.LocalDate;
    import java.time.ZoneId;
    
    /**
     * Wraps a 'LocalDate' to provide parsing/generating of strings in format known
     * as JD Edwards date.
     *
     * Format is CYYDDD where C is the number of centuries from 1900, YY is the year
     * within that century, and DDD is the ordinal day within the year (1-365 or
     * 1-366 in Leap Year).
     *
     * Immutable object. Thread-safe (hopefully! No guarantees).
     *
     * I would rather have done this by extending the 'java.time.LocalDate' class, but that class is marked 'final'.
     *
     * Examples: '000001' is January 1 of 1900. '116032' is February 1, 2016.
     *
     * © 2016 Basil Bourque. This source code may be used according to terms of the ISC License at https://opensource.org/licenses/ISC
     *
     * @author Basil Bourque
     */
    public class JDEdwardsLocalDate {
    
        private LocalDate localDate = null;
        private int centuryOffset;
        private int yearOfCentury;
        private String formatted = null;
    
        // Static Factory method, in lieu of public constructor.
        static public JDEdwardsLocalDate from ( LocalDate localDateArg ) {
            return new JDEdwardsLocalDate ( localDateArg );
        }
    
        // Static Factory method, in lieu of public constructor.
        static public JDEdwardsLocalDate parse ( CharSequence charSequenceArg ) {
            if ( null == charSequenceArg ) {
                throw new IllegalArgumentException ( "Passed CharSequence that is null. Message # 0072f897-b05f-4a0e-88d9-57cfd63a712c." );
            }
            if ( charSequenceArg.length () != 6 ) {
                throw new IllegalArgumentException ( "Passed CharSequence that is not six characters in length. Message # eee1e134-8ec9-4c92-aff3-9296eac1a84a." );
            }
            String string = charSequenceArg.toString ();
            // Should have all digits. Test by converting to an int.
            try {
                int testAsInteger = Integer.parseInt ( string );
            } catch ( NumberFormatException e ) {
                throw new IllegalArgumentException ( "Passed CharSequence contains non-digits. Fails to convert to an integer value. Message # 0461f0ee-b6d6-451c-8304-6ceface05332." );
            }
    
            // Validity test passed.
            // Parse.
            int centuryOffset = Integer.parseInt ( string.substring ( 0 , 1 ) ); // Plus/Minus from '19' (as in '1900').
            int yearOfCentury = Integer.parseInt ( string.substring ( 1 , 3 ) );
            int ordinalDayOfYear = Integer.parseInt ( string.substring ( 3 ) );
            int centuryStart = ( ( centuryOffset + 19 ) * 100 ); // 0 -> 1900. 1 -> 2000. 2 -> 2100.
            int year = ( centuryStart + yearOfCentury );
            LocalDate localDate = LocalDate.ofYearDay ( year , ordinalDayOfYear );
    
            return new JDEdwardsLocalDate ( localDate );
        }
    
        // Constructor.
        private JDEdwardsLocalDate ( LocalDate localDateArg ) {
            this.localDate = localDateArg;
            // Calculate century offset, how many centuries plus/minus from 1900.
            int year = this.localDate.getYear ();
            int century = ( year / 100 );
            this.yearOfCentury = ( year - ( century * 100 ) ); // example: if 2016, return 16.
            this.centuryOffset = ( century - 19 );
            // Format as string.
            String paddedYearOfCentury = String.format ( "%02d" , this.yearOfCentury );
            String paddedDayOfYear = String.format ( "%03d" , this.localDate.getDayOfYear () );
            this.formatted = ( this.centuryOffset + paddedYearOfCentury + paddedDayOfYear );
        }
    
        @Override
        public String toString () {
            return this.formatted;
        }
    
        public LocalDate toLocalDate () {
            // Returns a java.time.LocalDate which shares the same ISO chronology as a JD Edwards Date.
            return this.localDate;
        }
    
        public int getDayOfYear () {
            // Returns ordinal day number within the year, 1-365 inclusive or 1-366 for Leap Year. 
            return this.localDate.getDayOfYear();
        }
    
        public int getYear () {
            // Returns a year number such as 2016. 
            return this.localDate.getYear();
        }
    
        public int getYearOfCentury () { 
            // Returns a number within 0 and 99 inclusive.
            return this.yearOfCentury;
        }
    
        public int getCenturyOffset () {
            // Returns 0 for 19xx dates, 1 for 20xx dates, 2 for 21xx dates, and so on.
            return this.centuryOffset;
        }
    
        public static void main ( String[] args ) {
            // '000001' is January 1, 1900.
            JDEdwardsLocalDate jde1 = JDEdwardsLocalDate.parse ( "000001" );
            System.out.println ( "'000001' = JDEdwardsLocalDate: " + jde1 + " = LocalDate: " + jde1.toLocalDate () + " Should be: January 1, 1900. " );
    
            // '116032' is February 1, 2016.
            JDEdwardsLocalDate jde2 = JDEdwardsLocalDate.parse ( "116032" );
            System.out.println ( "'116032' = JDEdwardsLocalDate: " + jde2 + " = LocalDate: " + jde2.toLocalDate () + " Should be: February 1, 2016." );
    
            // Today
            LocalDate today = LocalDate.now ( ZoneId.systemDefault () );
            JDEdwardsLocalDate jdeToday = JDEdwardsLocalDate.from ( today );
            System.out.println ( "LocalDate.now(): " + today + " = JDEdwardsLocalDate: " + jdeToday + " to LocalDate: " + jdeToday.toLocalDate () );
        }
    
    }
    

    When run.

    '000001' = JDEdwardsLocalDate: 000001 = LocalDate: 1900-01-01 Should be: January 1, 1900.

    '116032' = JDEdwardsLocalDate: 116032 = LocalDate: 2016-02-01 Should be: February 1, 2016.

    LocalDate.now(): 2016-05-09 = JDEdwardsLocalDate: 116130 to LocalDate: 2016-05-09

    JD Edwards time-of-day

    As for JD Edwards time-of-day formats, I searched and could not find any documentation. If you know of some, please edit your Question to add links. The only mentions of JDE times seemed to be a count of seconds from midnight.

    If that is the case (a count since midnight), the java.time.LocalTime class has you covered. A LocalTime can be instantiated and read as either:

    Nanosecond resolution means up to nine digits of a decimal fraction. No problem handling the six digits you mentioned. Just do the math, multiply/divide by 1_000L. Just be aware that means possible data loss as you could be truncating those last three digits of fraction (7th, 8th, 9th digits of decimal fraction) if the LocalTime value came from outside of JD Edwards data. [FYI, the old java.util.Date/.Calendar classes, as well as Joda-Time, are limited to milliseconds resolution, for three digits of decimal fraction.]

    Not recommended: You could do some kind of combo class, composed of a LocalDate and a LocalTime. Or use a LocalDateTime. The key issue is time zone. If a JD Edwards date-time is always in a certain time zone such as UTC, then it might make sense to combine and use an OffsetDateTime . But if it has no specific time zone context, if the values are just a fuzzy idea of a date-time rather than specific points on the timeline, then use LocalDateTime as it has no time zone. If a JDE is always in UTC, use OffsetDateTime set to ZoneOffset.UTC. If you want to specify a time zone (an offset plus rules for handling anomalies such as DST), use ZonedDateTime.

    Recommended: Use a LocalTime separately. I do not think you want to be using my JDEdwardsLocalDate class in your business logic, especially because it is not a full implementation fitting into the java.time framework. My intention is to use that class to immediately convert to LocalDate when you encounter a JDE date. Same goes for a JDE time-of-day, convert to LocalTime immediately. If their context is always UTC, create an OffsetDateTime with UTC, and then pass that around your business logic. Only go back to a JDE date & time when necessary (persisting to database column of that JDE type, or reporting to user expecting that JDE presentation).

    OffsetDateTime odt = OffsetDateTime.of( myLocalDate , myLocalTime , ZoneOffset.UTC );
    

    If the JDE date & time has some other context implied, then assign the intended time zone.

    ZoneId zoneId = ZoneId.of( "America/Montreal" );
    ZonedDateTime zdt = ZonedDateTime.of( myLocalDate , myLocalTime , zoneId );
    

    Time zone is crucial here. You must understand the concepts in general. Be clear that LocalDate and LocalTime and LocalDateTime are not a moment on the timeline. They have no specific meaning until you adjust them into a time zone (or at least an offset-from-UTC).

    My diagram of date-time types included on this Answer may help you if not familiar with the java.time types.

    And you must understand the meaning of JDE date & time and their use in your apps/databases. As I could not find anything about JDE time, I could not learn anything about the JD Edwards intentions towards time zones. So I cannot suggest anything more specific.