Package com.inet.report.parser

Interface NodeParser

All Known Implementing Classes:
AbstractFontElement, AbstractLineElement, AbstractPictureElement, AbstractValueElement, Area, Box, BySummaryOrder, CascadingValueProvider, Chart2, CrossTab, CrossTabBodyCell, CrossTabDescriptionSection, CrossTabHeader, DatabaseField, DatabasePicture, Element, Engine, FacturXSettings, Field, FieldElement, FieldPart, Fields.UnknownField, FieldValueProvider, FormulaField, Group, GroupField, JavaBean, Join, Line, Paragraph, Picture, PromptField, QueryValueProvider, Region, ReportComponent, ReportProperties, Section, SignatureForm, SortField, SpecialField, SpecifiedOrder, SQLField, SQLValueProvider, Subreport, SubreportLink, SummaryField, TableSource, Text, TextPart
public interface NodeParser
Interface for report components which are to be able to parse XML nodes. This interface is only for internal use of i-net Clear Reports.

  • Method Details

    • parseElement

      NodeParser parseElement(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String,Object> parserMap) throws FatalParserException
      Internal method for reading report XML

      Parses an XML node with the given information, and returns either a sub-element which was created as a result, or null if no sub-element was created, i.e. the information was applied to the ReportComponent itself. Note that the parsing is highly tolerant, i.e. exceptions are intercepted and suppressed if at all possible.

      Parameters:
      group - XMLTag of the current node to be parsed, or null if there is no such current group. An XMLTag is a group of nodes bundled together, usually it is a Properties node such as CommonProperties, BorderProperties, etc.
      tag - The XMLTag to be parsed
      atts - The set of attributes in the current XMLTag
      parserMap - The map of current Parser.
      Returns:
      The NodeParser sub-element if one needed to be created, or null if none was created.
      Throws:
      FatalParserException - if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.
      Since:
      8.0

    • parseText

      void parseText(String text, Map<String,Object> parserMap)
      Internal method for reading report XML

      This method is called if text was encountered in the context of this node. (Examples would be a formula's text or a text element's text)

      Parameters:
      text - text encountered and to be stored
      parserMap - The map of current Parser.
      Since:
      8.0

    • parseEndElement

      void parseEndElement(com.inet.report.parser.XMLTag group, String tag, Map<String,Object> parserMap) throws FatalParserException
      Internal method for reading report XML

      Receive notification of the end of an XML tag.

      Parameters:
      group - XMLTag of the current node to be parsed, or null if there is no such current group.
      tag - The XMLTag to be parsed
      parserMap - The map of current Parser.
      Throws:
      FatalParserException - if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.
      Since:
      8.0

    • isDOMParser

      boolean isDOMParser()
      Internal method for reading report XML

      Returns whether this node is to be read via a DOM parser.

      Returns:
      true if this node is to be read via a DOM parser, false otherwise.
      Since:
      8.0

    • parseDOM

      void parseDOM(Node node, Map<String,Object> parserMap) throws FatalParserException
      Internal method for reading report XML

      Parses the node.

      Parameters:
      node - the node
      parserMap - The map of current Parser.
      Throws:
      FatalParserException - if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.
      Since:
      8.0