net.sf.saxon.type

Class ValidationException

Implemented Interfaces:
Locator, SourceLocator

public class ValidationException
extends XPathException
implements SourceLocator, Locator

This exception indicates a failure when validating an instance against a type defined in a schema.

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.saxon.trans.XPathException

XPathException.Circularity

Constructor Summary

ValidationException(Exception exception)
Creates a new ValidationException with the given nested exception.
ValidationException(String message)
Creates a new ValidationException with the given message.
ValidationException(String message, Exception exception)
Creates a new ValidationException with the given message and nested exception.
ValidationException(String message, SourceLocator locator)
Create a new ValidationException from a message and a Locator.

Method Summary

int
getColumnNumber()
String
getConstraintClauseNumber()
Get the constraint clause number
String
getConstraintName()
Get the constraint name
String
getConstraintReference()
Get the constraint name and clause in the format defined in XML Schema Part C (Outcome Tabulations).
String
getConstraintReferenceMessage()
Get the constraint reference as a string for inserting into an error message.
int
getConstraintSchemaPart()
Get the "schema part" component of the constraint reference
int
getLineNumber()
SourceLocator
getLocator()
String
getPublicId()
String
getSystemId()
void
setColumnNumber(int column)
void
setConstraintReference(int schemaPart, String constraintName, String clause)
Set a reference to the constraint in XML Schema that is not satisfied
void
setConstraintReference(ValidationException e)
Copy the constraint reference from another exception object
void
setLineNumber(int line)
void
setLocator(Locator locator)
void
setPublicId(String id)
void
setSourceLocator(SourceLocator locator)
void
setSystemId(String id)
String
toString()
Returns the String representation of this Exception

Methods inherited from class net.sf.saxon.trans.XPathException

getErrorCodeLocalPart, getErrorCodeNamespace, getErrorObject, getXPathContext, hasBeenReported, isStaticError, isTypeError, makeStatic, makeXPathException, maybeSetContext, maybeSetLocation, setErrorCode, setErrorCode, setErrorObject, setHasBeenReported, setIsStaticError, setIsTypeError, setXPathContext

Constructor Details

ValidationException

public ValidationException(Exception exception)
Creates a new ValidationException with the given nested exception.
Parameters:
exception - the nested exception

ValidationException

public ValidationException(String message)
Creates a new ValidationException with the given message.
Parameters:
message - the message for this Exception

ValidationException

public ValidationException(String message,
                           Exception exception)
Creates a new ValidationException with the given message and nested exception.
Parameters:
message - the detail message for this exception
exception - the nested exception

ValidationException

public ValidationException(String message,
                           SourceLocator locator)
Create a new ValidationException from a message and a Locator.
Parameters:
message - The error or warning message.
locator - The locator object for the error or warning.

Method Details

getColumnNumber

public int getColumnNumber()

getConstraintClauseNumber

public String getConstraintClauseNumber()
Get the constraint clause number
Returns:
the section number of the clause containing the constraint that has been violated. Generally a decimal number in the form n.n.n; possibly a sequence of such numbers separated by semicolons. Or null if the information is not available.

getConstraintName

public String getConstraintName()
Get the constraint name
Returns:
the name of the violated constraint, in the form of a fragment identifier within the published XML Schema specification; or null if the information is not available.

getConstraintReference

public String getConstraintReference()
Get the constraint name and clause in the format defined in XML Schema Part C (Outcome Tabulations). This mandates the format validation-rule-name.clause-number
Returns:
the constraint reference, for example "cos-ct-extends.1.2"; or null if the reference is not known.

getConstraintReferenceMessage

public String getConstraintReferenceMessage()
Get the constraint reference as a string for inserting into an error message.
Returns:
the reference as a message, or null if no information is available

getConstraintSchemaPart

public int getConstraintSchemaPart()
Get the "schema part" component of the constraint reference
Returns:
1 or 2 depending on whether the violated constraint is in XML Schema Part 1 or Part 2; or -1 if there is no constraint reference

getLineNumber

public int getLineNumber()

getLocator

public SourceLocator getLocator()

getPublicId

public String getPublicId()

getSystemId

public String getSystemId()

setColumnNumber

public void setColumnNumber(int column)

setConstraintReference

public void setConstraintReference(int schemaPart,
                                   String constraintName,
                                   String clause)
Set a reference to the constraint in XML Schema that is not satisfied
Parameters:
schemaPart - - 1 or 2, depending whether the constraint is in XMLSchema part 1 or part 2
constraintName - - the short name of the constraint in XMLSchema, as a fragment identifier in the HTML of the XML Schema Part 1 specification
clause - - the clause number within the description of that constraint

setConstraintReference

public void setConstraintReference(ValidationException e)
Copy the constraint reference from another exception object
Parameters:
e - the other exception object from which to copy the information

setLineNumber

public void setLineNumber(int line)

setLocator

public void setLocator(Locator locator)

setPublicId

public void setPublicId(String id)

setSourceLocator

public void setSourceLocator(SourceLocator locator)

setSystemId

public void setSystemId(String id)

toString

public String toString()
Returns the String representation of this Exception
Returns:
the String representation of this Exception