Package org.docx4j.model.datastorage

Class BindingTraverserCommonImpl

java.lang.Object
org.docx4j.model.datastorage.BindingTraverserCommonImpl
All Implemented Interfaces:
BindingTraverserInterface
Direct Known Subclasses:
BindingTraverserNonXSLT, BindingTraverserXSLT
public abstract class BindingTraverserCommonImpl
extends java.lang.Object
implements BindingTraverserInterface

  • Field Summary

    Fields
    Modifier and Type Field Description
    protected java.util.concurrent.atomic.AtomicInteger bookmarkId  

  • Constructor Summary

    Constructors
    Constructor Description
    BindingTraverserCommonImpl()  

  • Method Summary

    Modifier and Type Method Description
    java.util.concurrent.atomic.AtomicInteger getNextBookmarkId()
    Since we are potentially processing multiple parts (ie main document part, headers, footers), we need to be able to pass the number from part to part.
    void setStartingIdForNewBookmarks​(java.util.concurrent.atomic.AtomicInteger bookmarkId)
    Provide a way to set the starting bookmark ID number for the purposes of Binding Traverse.
    abstract java.lang.Object traverseToBind​(JaxbXmlPart part, OpcPackage pkg, java.util.Map<java.lang.String,​Xpaths.Xpath> xpathsMap)  

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • bookmarkId

      protected java.util.concurrent.atomic.AtomicInteger bookmarkId

  • Constructor Details

    • BindingTraverserCommonImpl

      public BindingTraverserCommonImpl()

  • Method Details

    • traverseToBind

      public abstract java.lang.Object traverseToBind​(JaxbXmlPart part, OpcPackage pkg, java.util.Map<java.lang.String,​Xpaths.Xpath> xpathsMap) throws Docx4JException
      Specified by:
      traverseToBind in interface BindingTraverserInterface
      Throws:
      Docx4JException

    • setStartingIdForNewBookmarks

      public void setStartingIdForNewBookmarks​(java.util.concurrent.atomic.AtomicInteger bookmarkId)
      Description copied from interface: BindingTraverserInterface
      Provide a way to set the starting bookmark ID number for the purposes of Binding Traverse. For efficiency, user code needs to pass this value through from the previous stage (repeats/condition handing). If it isn't, the value will be calculated (less efficient). New bookmarks could be created from XHTML, or renumbered in Flat OPC XML (TODO).
      Specified by:
      setStartingIdForNewBookmarks in interface BindingTraverserInterface

    • getNextBookmarkId

      public java.util.concurrent.atomic.AtomicInteger getNextBookmarkId()
      Description copied from interface: BindingTraverserInterface
      Since we are potentially processing multiple parts (ie main document part, headers, footers), we need to be able to pass the number from part to part.
      Specified by:
      getNextBookmarkId in interface BindingTraverserInterface