net.sf.saxon.trans
Class XPathException
TransformerException
net.sf.saxon.trans.XPathException
public class XPathException
extends TransformerException
XPathException is used to indicate an error in an XPath expression.
It will generally be either a StaticError or a DynamicError;
ValidationExceptions (arising from schema validation) form a third category
XPathException(String message) - Create an XPathException with an error message
|
XPathException(String message, SourceLocator loc) - Create an XPathException that supplies an error message and supplies location information
|
XPathException(String message, SourceLocator loc, Throwable err) - Create an XPathException that supplies an error message and wraps an underlying exception
and supplies location information
|
XPathException(String message, String errorCode) - Create an XPathException that supplies an error message and an error code
|
XPathException(String message, String errorCode, XPathContext context) - Create an XPathException that supplies an error message and an error code and provides the
dynamic context
|
XPathException(String message, Throwable err) - Create an XPathException that supplies an error message and wraps an underlying exception
|
XPathException(Throwable err) - Create an XPathException that wraps another exception
|
XPathException
public XPathException(String message)
Create an XPathException with an error message
message
- the message explaining what is wrong. This should not include location information.
XPathException
public XPathException(String message,
SourceLocator loc)
Create an XPathException that supplies an error message and supplies location information
message
- the error messageloc
- indicates where in the user-written query or stylesheet (or sometimes in a source
document) the error occurred
XPathException
public XPathException(String message,
SourceLocator loc,
Throwable err)
Create an XPathException that supplies an error message and wraps an underlying exception
and supplies location information
message
- the error message (which should generally explain what Saxon was doing when the
underlying exception occurred)loc
- indicates where in the user-written query or stylesheet (or sometimes in a source
document) the error occurrederr
- the underlying exception (the cause of this exception)
XPathException
public XPathException(String message,
String errorCode)
Create an XPathException that supplies an error message and an error code
message
- the error messageerrorCode
- the error code - an eight-character code, which is taken to be in the standard
system error code namespace
XPathException
public XPathException(String message,
String errorCode,
XPathContext context)
Create an XPathException that supplies an error message and an error code and provides the
dynamic context
message
- the error messageerrorCode
- the error code - an eight-character code, which is taken to be in the standard
system error code namespacecontext
- the dynamic evaluation context
XPathException
public XPathException(String message,
Throwable err)
Create an XPathException that supplies an error message and wraps an underlying exception
message
- the error message (which should generally explain what Saxon was doing when the
underlying exception occurred)err
- the underlying exception (the cause of this exception)
XPathException
public XPathException(Throwable err)
Create an XPathException that wraps another exception
err
- the wrapped error or exception
getErrorCodeLocalPart
public String getErrorCodeLocalPart()
Get the local part of the name of the error code
- the local part of the name of the error code
getErrorCodeNamespace
public String getErrorCodeNamespace()
Get the namespace URI part of the name of the error code
- the namespace URI part of the name of the error code
getErrorObject
public Value getErrorObject()
Get the error object associated with this error. This is used by the standard XPath fn:error() function
- the error object, as supplied to the fn:error() function
getXPathContext
public XPathContext getXPathContext()
Get the dynamic context at the time the exception occurred
- the dynamic context if known; otherwise null
hasBeenReported
public boolean hasBeenReported()
Ask whether this error is marked to indicate that it has already been reported to the error listener,
and should not be reported again
- true if this error has already been reported
isStaticError
public boolean isStaticError()
Ask whether this exception represents a static error
- true if this exception is a static error
isTypeError
public boolean isTypeError()
Ask whether this exception represents a type error
- true if this exception is a type error
makeStatic
public XPathException makeStatic()
Force an exception to a static error
- this exception, marked as a static error
makeXPathException
public static XPathException makeXPathException(TransformerException err)
Create an XPathException from a JAXP TransformerException. If the TransformerException is an XPathException,
or if its cause is an XPathException, that XPathException is returned unchanged; otherwise the
TransformerException is wrapped.
err
- the supplied JAXP TransformerException
- an XPathException obtained from the supplied TransformerException
maybeSetContext
public void maybeSetContext(XPathContext context)
Set the context of a message, only if it is not already set
context
- the current XPath context (or null)
maybeSetLocation
public void maybeSetLocation(SourceLocator locator)
Set the location of a message, only if it is not already set
locator
- the current location (or null)
setErrorCode
public void setErrorCode(String code)
Set the error code. The error code is a QName; this method sets the local part of the name,
and if no other namespace has been set, it sets the namespace of the error code to the standard
system namespace
NamespaceConstant.ERR
code
- The local part of the name of the error code
setErrorCode
public void setErrorCode(String namespace,
String code)
Set the error code. The error code is a QName; this method sets both parts of the name.
namespace
- The namespace URI part of the name of the error codecode
- The local part of the name of the error code
setErrorObject
public void setErrorObject(Value value)
Set the error object associated with this error. This is used by the standard XPath fn:error() function
value
- the error object, as supplied to the fn:error() function
setHasBeenReported
public void setHasBeenReported()
Mark this error to indicate that it has already been reported to the error listener, and should not be
reported again
setIsStaticError
public void setIsStaticError(boolean is)
Mark this exception to indicate that it represents (or does not represent) a static error
is
- true if this exception is a static error
setIsTypeError
public void setIsTypeError(boolean is)
Mark this exception to indicate that it represents (or does not represent) a type error
is
- true if this exception is a type error
setXPathContext
public void setXPathContext(XPathContext context)
Set dynamic context information in the exception object
context
- the dynamic context at the time the exception occurred