Package net.sf.saxon.trans

Class XmlProcessingIncident

java.lang.Object
net.sf.saxon.trans.XmlProcessingIncident
All Implemented Interfaces:
XmlProcessingError
public class XmlProcessingIncident extends Object implements XmlProcessingError
The XmlProcessingIncident class is a concrete implementation of the XmlProcessingError interface that holds all the required information internally. (That is, no exception objects are involved.)

  • Constructor Details

    • XmlProcessingIncident

      public XmlProcessingIncident(String message, String errorCode, Location location)
      Create an XmlProcessingIncident
      Parameters:
      message - the error message
      errorCode - the error code, supplied either as a local name, or in Q{uri}local format. If supplied as a local name, the standard error namespace is assumed.
      location - the location of the error

    • XmlProcessingIncident

      public XmlProcessingIncident(String message)
      Create an Incident
      Parameters:
      message - the error message

    • XmlProcessingIncident

      public XmlProcessingIncident(String message, String errorCode)
      Create an Incident
      Parameters:
      message - the error message
      errorCode - the error code, supplied either as a local name, or in Q{uri}local format. If supplied as a local name, the standard error namespace is assumed.

    • XmlProcessingIncident

      public XmlProcessingIncident(TransformerException err, boolean isWarning)

  • Method Details

    • setWarning

      public void setWarning(boolean warning)

    • asWarning

      public XmlProcessingIncident asWarning()
      Description copied from interface: XmlProcessingError
      Return an XmlProcessingError containing the same information, but to be treated as a warning condition
      Specified by:
      asWarning in interface XmlProcessingError
      Returns:
      an XmlProcessingError to be treated as a warning

    • setTerminationMessage

      public void setTerminationMessage(String message)
      Indicate that this error is to be treated as fatal; that is, execution will be abandoned after reporting this error. This method may be called by an ErrorReporter, for example if the error is considered so severe that further processing is not worthwhile, or if too many errors have been signalled. There is no absolute guarantee that setting this property will cause execution to be abandoned. If a dynamic error is marked as fatal, it will generally not be caught by any try/catch mechanism within the stylesheet or query.
      Specified by:
      setTerminationMessage in interface XmlProcessingError
      Parameters:
      message - an error message giving the reason for the fatal error

    • getTerminationMessage

      public String getTerminationMessage()
      Ask whether this error is to be treated as fatal, and return the associated message
      Specified by:
      getTerminationMessage in interface XmlProcessingError
      Returns:
      a non-null message if the error has been marked as a fatal error.

    • isAlreadyReported

      public boolean isAlreadyReported()
      Ask whether this static error has already been reported
      Specified by:
      isAlreadyReported in interface XmlProcessingError
      Returns:
      true if the error has already been reported

    • setAlreadyReported

      public void setAlreadyReported(boolean reported)
      Say whether this error has already been reported
      Specified by:
      setAlreadyReported in interface XmlProcessingError
      Parameters:
      reported - true if the error has been reported

    • getHostLanguage

      public HostLanguage getHostLanguage()
      Specified by:
      getHostLanguage in interface XmlProcessingError

    • setHostLanguage

      public void setHostLanguage(HostLanguage language)

    • isTypeError

      public boolean isTypeError()
      Description copied from interface: XmlProcessingError
      Ask whether this is a type error. Saxon reports type errors statically if it can establish that a supplied value will never satisfy the required type
      Specified by:
      isTypeError in interface XmlProcessingError
      Returns:
      true if this is a type error

    • setTypeError

      public void setTypeError(boolean isTypeError)

    • isStaticError

      public boolean isStaticError()
      Description copied from interface: XmlProcessingError
      Ask whether this is a static error, defined as an error that can be detected during static analysis of a stylesheet, query, schema, or XPath expression.
      Specified by:
      isStaticError in interface XmlProcessingError
      Returns:
      true if this is a static error

    • setStaticError

      public void setStaticError(boolean isStaticError)

    • getErrorCode

      public QName getErrorCode()
      The error code, as a QName. May be null if no error code has been assigned
      Specified by:
      getErrorCode in interface XmlProcessingError
      Returns:
      QName

    • setErrorCodeAsEQName

      public void setErrorCodeAsEQName(String code)

    • getMessage

      public String getMessage()
      Return the error message associated with this error
      Specified by:
      getMessage in interface XmlProcessingError
      Returns:
      String

    • getModuleUri

      public String getModuleUri()
      The URI of the query or stylesheet module in which the error was detected (as a string) May be null if the location of the error is unknown, or if the error is not localized to a specific module, or if the module in question has no known URI (for example, if it was supplied as an anonymous Stream)
      Specified by:
      getModuleUri in interface XmlProcessingError
      Returns:
      String

    • getFailingExpression

      public Expression getFailingExpression()
      Description copied from interface: XmlProcessingError
      Get the Expression that failed, if known
      Specified by:
      getFailingExpression in interface XmlProcessingError
      Returns:
      the failing expression, or null

    • setFailingExpression

      public void setFailingExpression(Expression expr)

    • getLocation

      public Location getLocation()
      Description copied from interface: XmlProcessingError
      Get the location information associated with the error
      Specified by:
      getLocation in interface XmlProcessingError
      Returns:
      the location of the error. The result is never null, though it may be a location with little useful information.

    • setLocation

      public void setLocation(Location loc)

    • getColumnNumber

      public int getColumnNumber()
      The column number locating the error within a query or stylesheet module
      Returns:
      int

    • getLineNumber

      public int getLineNumber()
      The line number locating the error within a query or stylesheet module
      Returns:
      int

    • getInstructionName

      public String getInstructionName()
      Get a name identifying the kind of instruction, in terms meaningful to a user. This method is not used in the case where the instruction name code is a standard name (<1024).
      Returns:
      a name identifying the kind of instruction, in terms meaningful to a user. The name will always be in the form of a lexical XML QName, and should match the name used in explain() output displaying the instruction.

    • isWarning

      public boolean isWarning()
      Ask whether this error is being reported as a warning condition. If so, applications may ignore the condition, though the results may not be as intended.
      Specified by:
      isWarning in interface XmlProcessingError
      Returns:
      boolean

    • getPath

      public String getPath()
      Get the absolute XPath expression that identifies the node within its document where the error occurred, if available
      Specified by:
      getPath in interface XmlProcessingError
      Returns:
      String - a path expression

    • getCause

      public Throwable getCause()
      Return the underlying exception. This method may not be stable across Saxon releases.
      Specified by:
      getCause in interface XmlProcessingError
      Returns:
      the underlying exception if there was one, or null otherwise

    • setCause

      public void setCause(Throwable cause)

    • maybeSetHostLanguage

      public static void maybeSetHostLanguage(XmlProcessingError error, HostLanguage lang)

    • maybeSetLocation

      public static void maybeSetLocation(XmlProcessingError error, Location loc)