objectlabkit.sourceforge.netObjectLab-Kit - Introduction

Last Published: 2022-01-11 | Version: 1.4.8 | ObjectLab Kit datecalc-common | datecalc-jdk | datecalc-joda | utils | fxcalc | report | excel | GitHub | sf.net/projects/objectlabkit Kit Introduction Currency Dates Currency Rates Holiday Handling Tenor Handling JavaDocs Code Metrics Download In the press FAQ Modules Kit Utils Date Calculator Common Date Calc JDK Date Calc JODA Date Calc JDK8 FX Calc Portfolio Kit Utils Excel Kit Utils Report Project Documentation Project Information Continuous Integration Dependencies Dependency Convergence Dependency Information Dependency Management Distribution Management About Issue Tracking Project License Mailing Lists Project Modules Plugin Management Project Plugins Project Team Source Repository Project Summary Project Reports Interesting Projects QALab JTreeMap FlatPack StatSVN ObjectLab Joda Time Quick News Reminder: we have moved to GitHub . 2022-01-11 : version 1.4.8 is out, updated dependencies to remove Security warnings. 2014-08-26 : version 1.4.0 is out and contains a new Immutable and thread safe Currency Calculator. This uses a Builder pattern. You should use this for any calculation for a currency pair, do not forget to register the holidays for each currency prior to getting the calculator. Spot rules for Latin American currencies on T+1 are handled as well as the Arabic currencies with different weekends. More info about Currency Date Calculation and on the changes here . Finally, we are also introducing a new module the ObjectLab Kit FX Calculator use it for determining Cross Currency Market Conventions and calculating FX Cross Rates. 2014-05-26 : version 1.3.0 is out and contains a couple of changes to make the usage of the interfaces more fluent but mainly include a NEW MODULE FOR JDK8. We also officially release the objectlab-utils module for the first time, if you deal with BigDecimal, Collections etc and are fed up with nulls, this is for you! More info on the changes here . 2010-05-10 : version 1.2.0 is out and contains a couple of changes, including the ability to see the registered calendar and unregistering calendars (useful if calendars are dynamic). More info on the changes here . Also, one of the authors is on Twitter, follow your favorite Belgian at http://twitter.com/benoitx . 2007-03-25 : version 1.1.0 is out and contains a couple of changes, a new HolidayHandler and the ability to define a valid range for the holiday (and if the calculation is beyond that range, an exception is thrown). This is done via HolidayCalendar which should replace the simple SetE for holidays. More info on the changes here . ObjectLab Kit Introduction ObjectLab Kit came out of our frustration to have to re-do the same kind of code over and over each time we joined a new company and Bank. Most banks will require basic Date calculation, we did spot another open source project for this but their licence forbids most financial institution from using it. This one is released under the business-friendly Apache 2.0 license. The KIT Date Calculators: JDK implementation , Joda Time implementation , JDK8 implementation The FX Calc for handling Currencies and Rates within the Foreign Exchange business The Utils package for a bunch of very useful classes for Pair, Triplet, BigDecimal, Average, Standard Deviations, Console Menu, Self Caching Collections, etc see implementation The Utils Report package for creating simple ASCII Tabular reports, see here The Utils Excel package for reading and creating simple Excel spreadsheet with Apache POI, see here Getting Started DateCalc comes in 3 different implementations, both run on JDK 1.8 or higher : The vanilla JDK implementation has no external dependencies. The Joda Time implementation , which depends on the Joda Time library (we recommend using this one). The JDK8 implementation , which obviously is compiled with JDK8 and makes use of the new LocalDate. Maven If you’re using Maven, setup is easy, as DateCalc is in the Maven Central Repository. To use the JDK Version: dependency groupIdnet.objectlab.kit/groupId artifactIddatecalc-common/artifactId version1.4.1/version /dependency dependency groupIdnet.objectlab.kit/groupId artifactIddatecalc-jdk/artifactId version1.4.1/version /dependency To use the JODA Version (recommended): dependency groupIdnet.objectlab.kit/groupId artifactIddatecalc-common/artifactId version1.4.1/version /dependency dependency groupIdnet.objectlab.kit/groupId artifactIddatecalc-joda/artifactId version1.4.1/version /dependency To use the JDK8 Version: dependency groupIdnet.objectlab.kit/groupId artifactIddatecalc-common/artifactId version1.4.1/version /dependency dependency groupIdnet.objectlab.kit/groupId artifactIddatecalc-jdk8/artifactId version1.4.1/version /dependency Download the Jars If you are not using Maven, you can download the jars here . Date Calculations? What is that? Apart from the very basic "add days" features, most business have to deal with Holidays and what to do when a calculated day falls on a holiday . This library does not attempt to create or guess the holidays, we all know that some bank holidays can be decided at a moment’s notice in some markets. All financial institutions or big business will have their own official list of ’holidays’ anyway. Furthermore, "weekends" also need to be handled and some market have a different week to the conventional Monday - Friday, our library provides you with full flexibility to design a Working Week. As such a Non-working Day can be a holiday or a ’weekend’. Also note that CurrencyPairs have a specialised calculator as the rules can be ’weird’. See for more info . Ok, what algorithm for handling a holiday do you support? At the moment, we support the following 6 algorithms: Do Nothing , i.e. leave the date as-is, even if it is a non-working day. Forward , if the date is a non-working day, move forward to the next working day. Backward , if the date is a non-working day, move backward to the previous working day. Modified Following , if the date is a non-working day, move forward to the next working day, UNLESS it crosses over a new month, in which case we revert to find the last working day of the current month. Modified Preceeding , if the date is a non-working day, move backward to the previous working day, UNLESS it crosses over a new month, in which case we revert to find the next working day of the current month. ForwardUnlessNegative (new with v1.1.0), acts like a Forward algo unless the increment is negative, in which case it behaves like Backward. See this page for some examples . Main interfaces The main interfaces are: DateCalculator for all Date calculations. PeriodCountCalculator for all day, month and year diff calculations. IMMDateCalculator for all IMM calculations (International Money Market). Here are the examples of how to get a DateCalculator "forward" for the "UK" holidays (if you have registered the holidays). The WorkingWeek is Mon-Fri by default. JDK 2 implementations for Pure ’old’ JDK have been released Calendar : Date : JODA 2 implementations for Joda have been released LocalDate (recommended): YearMonthDay : JDK8 1 implementations for JDK8 has been released LocalDate : How do I use it? There are several steps Register holidays in the factory by calling registerHolidays(final String name, HolidayCalendarDate holidays) Use the factory to get a DateCalculator with a given Handler (forward/backward etc), it is a disposable object that should not be shared accross threads, each thread should get its own! when you get a DateCalculator, you can set the startDate, this sets the currentDate too. The startDate does not move. The current date is the result of your calculations. If the startDate is a non-working day, it may be moved automatically according to the HolidayHandler. when you call moveByDays(..), moveByBusinessDays(..), moveByTenor the currentDate is moved in the Calculator. Using Joda CurrencyDateCalculator Using Joda CurrencyDateCalculator with Builder...