Class BivesTools


  • public class BivesTools
    extends Object
    The Class BivesTools providing some utils for document comparison.
    Author:
    Martin Scharm
    • Constructor Summary

      Constructors 
      Constructor Description
      BivesTools()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void genAttributeMarkupStats​(de.unirostock.sems.xmlutils.ds.DocumentNode a, de.unirostock.sems.xmlutils.ds.DocumentNode b, MarkupElement markupElement)
      Generate some Attribute difference report for Markup Documents.
      static void genMathMarkupStats​(de.unirostock.sems.xmlutils.ds.DocumentNode a, de.unirostock.sems.xmlutils.ds.DocumentNode b, MarkupElement markupElement)
      Generate some MathML difference report for Markup Documents .
      static String getBivesVersion()
      Returns the bives version that is currently running.
      static void markDeleted​(de.unirostock.sems.xmlutils.ds.DocumentNode dn)
      Mark a document node as deleted.
      static void markInserted​(de.unirostock.sems.xmlutils.ds.DocumentNode dn)
      Mark a document node as inserted.
      static void markMoved​(de.unirostock.sems.xmlutils.ds.DocumentNode dn)
      Mark a document node as moved.
      static void markUpdated​(de.unirostock.sems.xmlutils.ds.DocumentNode dn)
      Mark a document node as updated.
      static void markUpdated​(de.unirostock.sems.xmlutils.ds.TextNode tn)
      Mark a text node as updated.
    • Constructor Detail

      • BivesTools

        public BivesTools()
    • Method Detail

      • getBivesVersion

        public static String getBivesVersion()
        Returns the bives version that is currently running. This string also contains the version numbers of all modules that are compiled into the current running binary.
        Returns:
        the bives version
      • genMathMarkupStats

        public static void genMathMarkupStats​(de.unirostock.sems.xmlutils.ds.DocumentNode a,
                                              de.unirostock.sems.xmlutils.ds.DocumentNode b,
                                              MarkupElement markupElement)
        Generate some MathML difference report for Markup Documents .
        Parameters:
        a - the node rooting the MathML in document A
        b - the node rooting the MathML in document B
        markupElement - the markup element
      • markDeleted

        public static void markDeleted​(de.unirostock.sems.xmlutils.ds.DocumentNode dn)
        Mark a document node as deleted.
        Parameters:
        dn - the document node
      • markInserted

        public static void markInserted​(de.unirostock.sems.xmlutils.ds.DocumentNode dn)
        Mark a document node as inserted.
        Parameters:
        dn - the document node
      • markMoved

        public static void markMoved​(de.unirostock.sems.xmlutils.ds.DocumentNode dn)
        Mark a document node as moved.
        Parameters:
        dn - the document node
      • markUpdated

        public static void markUpdated​(de.unirostock.sems.xmlutils.ds.TextNode tn)
        Mark a text node as updated.
        Parameters:
        tn - the text node
      • markUpdated

        public static void markUpdated​(de.unirostock.sems.xmlutils.ds.DocumentNode dn)
        Mark a document node as updated.
        Parameters:
        dn - the document node
      • genAttributeMarkupStats

        public static void genAttributeMarkupStats​(de.unirostock.sems.xmlutils.ds.DocumentNode a,
                                                   de.unirostock.sems.xmlutils.ds.DocumentNode b,
                                                   MarkupElement markupElement)
        Generate some Attribute difference report for Markup Documents.
        Parameters:
        a - the nodes carrying the attributes in document A
        b - the nodes carrying the attributes in document B
        markupElement - the markup element