Skip to content

MIGRATING_FROM_BATIK.md

Latest commit

 

History

History
108 lines (80 loc) · 5.3 KB

MIGRATING_FROM_BATIK.md

File metadata and controls

108 lines (80 loc) · 5.3 KB

Migrating from Apache Batik

There are several reasons why EchoSVG is not a drop-in replacement for Apache Batik:

  • Avoid using Apache Software Foundation package names and trademarks.

  • Improved conformance to the SVG and CSS specifications.

  • Better user experience (e.g. the codec classes that got merged into transcoder, or the cleaner module interdependencies).

  • A circularity with Apache FOP. To render PDF images, Batik uses FOP which in turn uses Batik, so depending on FOP would imply mixing EchoSVG and Batik. See issue #10.

  • Changes in the Java™ Platform.


Migration checklist

To migrate from Apache Batik, you generally have to deal with the following:

  1. Package names are now prefixed by io.sf.carte.echosvg instead of org.apache.batik.

  2. Class names that included the name "Batik" now have "EchoSVG".

  3. The codec-transcoder circular dependency was removed in the following way: a few classes from the codec module were moved to transcoder. Now transcoder explicitly depends on codec (but not the other way around).

  4. Tcl and Python 2.x scripting was removed (see issues #12 and #13). That scripting wasn't functional in Batik anyway.

  5. The generic rasterizer module (and related files) was removed (svgrasterizer is still available but no longer supports PDF graphics). See issue #10 for more details.

  6. SAXDocumentFactory and SAXSVGDocumentFactory no longer have constructors with String arguments. Either remove the string argument or replace it by a null and you should be fine. Alternatively, you can now use your own XMLReader in place of the parser class name. (The API change was made for security reasons)

  7. EchoSVG does not depend on xml-apis-ext-1.3.04.jar to provide the SVGOM and SMIL APIs (see #15). If xml-apis-ext happens to be in your modulepath, you could configure an exclusion for it (in Maven or Gradle), and let svgom-api and smil-api (transitive dependencies of EchoSVG from the Web APIs project) do the job, as they are compatible with Batik. If your project requires the old SAC api which is provided by xml-apis-ext as well, you can use sac.jar as a replacement.

  8. EchoSVGSecurityManager is deprecated for removal due to Security Manager API being deprecated for removal since Java 17. Similarly, RhinoClassLoader.getAccessControlContext() and other security-related methods in other classes are deprecated for removal as well. The constructor ApplicationSecurityEnforcer(Class, String) is no longer public, please use ApplicationSecurityEnforcer.createSecurityEnforcer(Class, String) instead.

  9. BridgeContext (in the bridge module) gained a close method.

  10. SVGAnimationElementBridge.initializeAnimation() gained a BridgeContext argument and now returns a boolean.

Upgrading to EchoSVG 2.0

  1. The old and deprecated CSSValue API was replaced by an API close to W3C's Typed OM. One of the consequences is that if your scripts call getPresentationAttribute on SVGStylable objects, getPresentationAttributeValue should be called instead, obtaining a CSSStyleValue. Note that modern SVGOM has neither of those methods.

  2. The line-height property now has a global default of 1.1, instead of the mixture of 1.1 and 1 that Batik uses.

  3. The css.engine.value.css2 package was renamed to css.engine.value.css, given that CSS as a whole isn't versioned anymore.

  4. You can keep using the old transcoder module, but that one was split in four sub-modules. For example, for converting SVG to any image format (like PNG) you only need the echosvg-transcoder-svg module. Note that if you have a user agent that inherits from the SVGAbstractTranscoderUserAgent, that class is now located inside a new SVGAbstractTranscoder class that was created in the io.sf.carte.echosvg.transcoder.svg package, which shadows the old class of the same name located at io.sf.carte.echosvg.transcoder.

  5. Field SVGDOMImplementation.svg11Factories was renamed to svgFactories.

  6. Package io.sf.carte.echosvg.ext.swing was moved from echosvg-awt-util to a new io.sf.carte.echosvg.ext.swing module (echosvg-ext-swing Gradle name).

  7. Methods that took an ICCColorSpaceWithIntent (from xmlgraphics-commons), like ImageTagRegistry.readStream(stream, space), now take a ColorSpace. The legacy ICC color stuff was removed, as it did not produce actual colors outside of the sRGB gamut, is not supported by browsers and was just adding bloat.

  8. Protected method SVGAbstractTranscoder.createBridgeContext(String) was deprecated, due to the version attribute being dropped from SVG. If you wanted to override it, please do that with createBridgeContext() and createSVG12BridgeContext() instead. The former creates a BridgeContext which is intended for the current SVG specification, not just 1.1 as in Batik, while the latter produces one for the deprecated 1.2 version.