<dependency>
  <groupId>org.apache.daffodil</groupId>
  <artifactId>daffodil-japi_2.12</artifactId>
  <version>2.4.0</version>
</dependency>

libraryDependencies += "org.apache.daffodil" %% "daffodil-sapi" % "2.4.0"

[apache-daffodil]
name=Apache Daffodil
baseurl=https://apache.jfrog.io/artifactory/daffodil-rpm/
enabled=1
gpgkey=https://downloads.apache.org/daffodil/KEYS
gpgcheck=1
repo_gpgcheck=0

sudo dnf install apache-daffodil

Release Notes

Explicit Length Choices

Support is added for the property dfdl:choiceLengthKind="explicit" and dfdl:choiceLength. Previously, Daffodil ignored the choiceLengthKind property, always acting as if it had the value of implicit. The property is now required to be defined in scope for all choices.

• [DAFFODIL-640] choiceLengthKind='explicit'

Extension Namespace

A new dfdlx namespace (http://www.ogf.org/dfdl/dfdl-1.0/extensions) was created to support Daffodil extensions to the DFDL specification. The existing daf namespace is deprecated and all uses should be switched to dfdlx. Some properties, such as the layering extension properties are also moved to this namespace with backwards compatibility supported for now. Extensions should be considered experimental–support may change or be removed in a future release.

• [DAFFODIL-2096] Add dfdlx extensions namespace prefix. Convert existing extensions to this namespace.

Extension: Empty Element Parse Policy [Proposal]

A new DFDL property named dfdlx:emptyElementParsePolicy is added to control the behavior of empty string and hexBinary elements. This property allows one to switch between different behaviors for empty elements which correspond to currently described behavior in the DFDL v1.0 specification document, and an alternate behavior planned for future inclusion in the DFDL v1.0 specification which also increase compatibility with IBM DFDL.

• [DAFFODIL-110] Implement separator suppression policies
• [DAFFODIL-1080] RepUnbounded Error: Sequence of Optional Comma-separated String items
• [DAFFODIL-1400] broken test: test_text_entities_6_03b - separators with different encoding than terms they separate
• [DAFFODIL-1919] Trailing Separator Suppression
• [DAFFODIL-1975] Incorrect separator behavior - missing separator for empty sequence (non-backward compatible)
• [DAFFODIL-1976] Incorrect creation of empty-string element
• [DAFFODIL-2134] emptyElementParsePolicyError not accepted as warning ID in TDML define config.
• [DAFFODIL-2135] Array index not maintained properly. Causes nillable failures among others.
• [DAFFODIL-2143] dfdl:initiatedContent="yes" on sequence should only affect optional children
• [DAFFODIL-2154] nilled element of zero length inside optional complex element is deleted
• [DAFFODIL-2162] direct dispatch choice that has an array branch causes abort during compilation

Extension: Enumeration Values [Proposal]

New DFDL properties and functions are added to support translation of enumeration values.

• [DAFFODIL-2107] Implement Enum Support
• [DAFFODIL-2146] Incorrectly recognize keyset-value transform as identity transfrom
• [DAFFODIL-2148] No compile time error when using nonexistent TypeCalc function
• [DAFFODIL-2165] Add *Double functions to the typeCalc family of functions

Extension: Ranged Direct Dispatch [Proposal]

A new property named dfdlx:choiceBranchKeyRanges is added to support direct dispatch based on a range of numeric values.

• [DAFFODIL-2157] Implement choiceBranchKeyRanges

Extension: Lookahead Expression Function [Proposal]

A new DFDL expression function named dfdlx:lookAhead() is added to support a simple way to consider data that occurs at a future point in the bitstream.

• [DAFFODIL-2140] Implement dfdl:lookAhead()

Improved DFDL Schema Validation

Daffodil now does a better job at validating attribute-, short-, and element-form DFDL properties, which will now result in an error if unknown properties are used, mostly commonly caused by typos. Additionally, if DFDL properties are ignored (e.g. dfdl:textPattern is provided when dfdl:lengthKind is not "pattern"), Daffodil will now provide a warning.

• [DAFFODIL-598] No validation of short-form DFDL properties
• [DAFFODIL-1619] Warn of when dfdl annotations are ignored
• [DAFFODIL-2142] DFDL annotation on complex type is silently ignored
• [DAFFODIL-2150] Excessive emptyElementParsePolicy warnings
• [DAFFODIL-2163] False warning about unused dfdl:choiceBranchKey on direct dispatch array

Deprecation/Compatibility

The following changes have been made which affect compatibility with past releases:

• The behavior of separators has been revised to better conform to the DFDL specification, which enables more DFDL schemas to work without Daffodil specific modifications. Schemas that relied on the previous non-comformant behavior may require changes.
• The dfdl:choiceLengthKind property must now be defined in scope of all xs:choice's. Allowed values are either implicit or explicit. The previous behavior always treated the property as if it had the value of implicit.
• The daf namespace has been deprecated and replaced with the dfdlx namespace. Some properties were also moved to the new dfdlx namespace. The following properties/functions should be updated to use the new namespace, with backwards compatibility supported for now:
  • dfdl:layerTransform
  • dfdl:layerEncoding
  • dfdl:layerLengthKind
  • dfdl:layerLength
  • dfdl:layerLengthUnits
  • dfdl:layerBoundaryMark
  • daf:parseUnparsePolicy
  • daf:trace()
  • daf:error()

DFDL Schema Compatibility

Many changes and bug fixes specifically made to improve compatibility with more DFDL schemas. With these fixes and features, the schemas HL7-v2.7, IBM4690-TLOG, and EDIFACT now work with Daffodil.

• [DAFFODIL-784] Update default properties in examples to have missing required properties for portability.
• [DAFFODIL-828] IBM Compatibility - Test out HL7 schemas
• [DAFFODIL-1639] IBM Compatibility - EDIFACT
• [DAFFODIL-1720] missing properties not reported
• [DAFFODIL-1853] ipfix data format parse and unparse tests for "Schema Definition Error"
• [DAFFODIL-1886] TLOG: Delimited parsing with occursCountKind="implicit" with separators is not handling missing optional elements correctly
• [DAFFODIL-1916] Properties leadingSkip alignment alignmentUnits trailingSkip should not be required by text formats.
• [DAFFODIL-2121] occursStopValue="-1" in test schemas is non-portable (currently)
• [DAFFODIL-2156] daffodil-test-ibm1-crossTest now fails

Infrastructure and Website

• [DAFFODIL-1380] Update genjavadoc plugin to 10 when released and enable doclint
• [DAFFODIL-2003] Add Coverage Testing
• [DAFFODIL-2070] KEYS file should not be included in source releases
• [DAFFODIL-2073] Contact information in README.me is incorrect
• [DAFFODIL-2074] Tests fail on non-US locales
• [DAFFODIL-2080] Prepare for Daffodil 2.4.0 development
• [DAFFODIL-2082] Links to hashes sigs and KEYS should use https
• [DAFFODIL-2093] Cannot build and test daffodil in IntelliJ
• [DAFFODIL-2095] Confirm all commented out tests either work or have an associated bug number
• [DAFFODIL-2098] Update README to be more consistent and have extra information
• [DAFFODIL-2105] TravisCI builds take too long
• [DAFFODIL-2106] Update Line counter utility
• [DAFFODIL-2113] Eclipse classpath fixup for removal of scala-debug directories
• [DAFFODIL-2117] Generate WarnID.scala and DaffodilTunables.scala off of dafext.xsd
• [DAFFODIL-2160] Ignore vim temp files
• [DAFFODIL-2166] TravisCI open jdk 11 fails to download

Miscellaneous Changes and Bug Fixes

• [DAFFODIL-1024] Property inputValueCalc should not be on element that is optional, global, or an array
• [DAFFODIL-1106] Catch of Exception in DFDLSchemaFile.scala
• [DAFFODIL-1109] Remove catch of Exception from OccursCountExpressionParser
• [DAFFODIL-1387] Data dump no longer showing for left over data
• [DAFFODIL-1407] xml comments not accepted in defineFormat, config files
• [DAFFODIL-1475] Runtime terminator containing isolated %ES; provides poor diagnostic.
• [DAFFODIL-1477] ES now allowed in terminator - causes a test to fail now.
• [DAFFODIL-1478] Debugger uses the term arrayIndex. Really should be occursIndex to match the function of the same name.
• [DAFFODIL-1493] %ES; delimiter doesn't work right
• [DAFFODIL-1525] Determine if there is a better way to convert an XML String to a date/time
• [DAFFODIL-1701] dfdl:outputValueCalc on a complex element causes a ClassCastException
• [DAFFODIL-1931] Debug/trace - prints spurious error message about ".."
• [DAFFODIL-1955] Missing closing dfdl:format tag causes FatalError exception
• [DAFFODIL-1956] Terminator with leading space causes assertion failure
• [DAFFODIL-2058] Some CLI tests do not work cleanly on the Windows platform.
• [DAFFODIL-2062] NadaParser not optimized out
• [DAFFODIL-2064] CLI XML text output incorrect with empty complex elements.
• [DAFFODIL-2065] Incorrectly attempting to cast signed to unsigned type
• [DAFFODIL-2069] Unparser interaction of outputValueCalc with hexBinary with following bitOrder LSBF element.
• [DAFFODIL-2071] Performance of Schema Compiler - Need to eliminate redundant XML loading
• [DAFFODIL-2075] dfdl:hexBinary does not correcty reduce xs:integer
• [DAFFODIL-2076] fn:ceiling does not work on xs:decimal
• [DAFFODIL-2078] Unexpected exception with dfdl:contentLength
• [DAFFODIL-2083] abort in parser runtime - invariant failed with dynamic separator test
• [DAFFODIL-2084] attributeFormDefault="unqualified" appears in SchemaUtils used by TDML - generates spurious warning
• [DAFFODIL-2089] Unparser escaping doesn't escape all the delimiters
• [DAFFODIL-2092] Bad diagnostic when using dynamic separator the value of which is NUL (ascii 0)
• [DAFFODIL-2097] Non-thread safe code related to EvCalendar
• [DAFFODIL-2099] Original errors being surpressed in doParse loop
• [DAFFODIL-2100] Error handling some parseErrors
• [DAFFODIL-2108] Facet restrictions not allowed on xs:decimal types with bad errror
• [DAFFODIL-2114] Delimiter expression should SDE when empty string returned
• [DAFFODIL-2118] DFDLSchemas BMP does not work on Daffodil 2.3.0
• [DAFFODIL-2119] Debugger RTL data dumps are nibbles-reversed
• [DAFFODIL-2123] Exception on error when parsing hex data with trace on
• [DAFFODIL-2125] Incorrect unsparse with suspensions and changing bitOrder
• [DAFFODIL-2126] XML Catalog uri should use the same semantics as import/include schemaLocation
• [DAFFODIL-2128] XML preamble encoding ignored when CLI unparsing with "xml" infoset type
• [DAFFODIL-2130] Error on schema with large numbers of files
• [DAFFODIL-2136] Fix whitespace spurious changes.
• [DAFFODIL-2155] Add support for Link16 Charset DFI311:DUI002
• [DAFFODIL-2164] Support Link16 charset DFI1661 DUI001
• [DAFFODIL-2167] NITF schema fails to unparse with exception