Package io.goobi.viewer.controller

Class XmlTools

java.lang.Object
io.goobi.viewer.controller.XmlTools
public final class XmlTools extends Object
XML utilities.

  • Method Details

    • getSAXBuilder

      public static org.jdom2.input.SAXBuilder getSAXBuilder()

    • readXmlFile

      public static org.jdom2.Document readXmlFile(String filePath) throws IOException, org.jdom2.JDOMException
      readXmlFile.
      Parameters:
      filePath - absolute path to the XML file to read
      Returns:
      the parsed XML document
      Throws:
      FileNotFoundException - if any.
      IOException - if any.
      org.jdom2.JDOMException - if any.

    • readXmlFile

      public static org.jdom2.Document readXmlFile(URL url) throws IOException, org.jdom2.JDOMException
      Reads an XML document from the given URL and returns a JDOM2 document. Works with XML files within JARs.
      Parameters:
      url - URL pointing to the XML resource to read
      Returns:
      the parsed XML document
      Throws:
      FileNotFoundException - if any.
      IOException - if any.
      org.jdom2.JDOMException - if any.

    • readXmlFile

      public static org.jdom2.Document readXmlFile(Path path) throws IOException, org.jdom2.JDOMException
      readXmlFile.
      Parameters:
      path - path to the XML file to read
      Returns:
      the parsed XML document
      Throws:
      FileNotFoundException - if any.
      IOException - if any.
      org.jdom2.JDOMException - if any.

    • writeXmlFile

      public static File writeXmlFile(org.jdom2.Document doc, String filePath) throws IOException
      writeXmlFile.
      Parameters:
      doc - the JDOM2 document to serialize
      filePath - absolute path of the output file to write
      Returns:
      the written file
      Throws:
      FileNotFoundException - if any.
      IOException - if any.

    • getDocumentFromString

      public static org.jdom2.Document getDocumentFromString(String string, String encoding) throws org.jdom2.JDOMException, IOException
      Create a JDOM document from an XML string.
      Parameters:
      string - the XML content as a string
      encoding - character encoding to use when converting the string to bytes
      Returns:
      the parsed XML document
      Throws:
      org.jdom2.JDOMException - if any.
      IOException - if any.

    • getStringFromElement

      public static String getStringFromElement(Object element, String encoding)
      getStringFromElement.
      Parameters:
      element - the Document or Element to serialize to a string
      encoding - character encoding to apply to the XML output
      Returns:
      the XML serialization of the given document or element as a string

    • evaluateToElements

      public static List<org.jdom2.Element> evaluateToElements(String expr, org.jdom2.Element element, List<org.jdom2.Namespace> namespaces)
      Evaluates the given XPath expression to a list of elements.
      Parameters:
      expr - XPath expression to evaluate.
      element - the root element to evaluate the expression against
      namespaces - namespace bindings required by the XPath expression
      Returns:
      ArrayList or null

    • evaluateToFirstElement

      public static Optional<org.jdom2.Element> evaluateToFirstElement(String expr, org.jdom2.Element element, List<org.jdom2.Namespace> namespaces)

    • evaluate

      public static List<Object> evaluate(String expr, Object parent, org.jdom2.filter.Filter filter, List<org.jdom2.Namespace> namespaces)
      XPath evaluation with a given return type filter.
      Parameters:
      expr - XPath expression to evaluate.
      parent - If not null, the expression is evaluated relative to this element.
      filter - Return type filter.
      namespaces - namespace bindings required by the XPath expression
      Returns:
      a list of XPath evaluation results matching the given filter type

    • evaluateAttributeString

      public static List<String> evaluateAttributeString(String expr, Object parent, List<org.jdom2.Namespace> namespaces)

    • evaluateString

      public static List<String> evaluateString(String expr, Object parent, List<org.jdom2.Namespace> namespaces)

    • evaluateToFirstAttributeString

      public static Optional<String> evaluateToFirstAttributeString(String expr, Object parent, List<org.jdom2.Namespace> namespaces)

    • evaluateToFirstString

      public static Optional<String> evaluateToFirstString(String expr, Object parent, List<org.jdom2.Namespace> namespaces)

    • determineFileFormat

      public static String determineFileFormat(String xml, String encoding) throws org.jdom2.JDOMException, IOException
      determineFileFormat.
      Parameters:
      xml - the XML content as a string to inspect
      encoding - character encoding used to parse the XML string
      Returns:
      the detected source document format (e.g. "METS", "LIDO"), or null if the format cannot be determined
      Throws:
      org.jdom2.JDOMException - if any.
      IOException - if any.

    • determineFileFormat

      public static String determineFileFormat(org.jdom2.Document doc)
      Determines the format of the given XML file by checking for namespaces.
      Parameters:
      doc - the parsed JDOM2 document to inspect
      Returns:
      the detected source document format (e.g. "METS", "LIDO"), or null if the format cannot be determined

    • checkXMLWellformed

      public static List<XMLError> checkXMLWellformed(String xml) throws ParserConfigurationException, SAXException, IOException
      Parameters:
      xml - XML string to validate
      Returns:
      List
      Throws:
      ParserConfigurationException
      SAXException
      IOException

    • getXMLOutputter

      public static org.jdom2.output.XMLOutputter getXMLOutputter()
      Creates an XMLOutputter with default encoding and system linebreaks.
      Returns:
      a new XMLOutputter instance with standard format settings