Package net.sf.saxon.type
Class ValidationFailure
java.lang.Object
net.sf.saxon.type.ValidationFailure
- All Implemented Interfaces:
SourceLocator
,ConversionResult
,Locator
This exception indicates a failure when validating an instance against a type
defined in a schema.
This class holds the same information as a ValidationException, except that it is not an exception, and does not carry system overheads such as a stack trace. It is used because operations such as "castable", and validation of values in a union, cause validation failures on a success path and it is costly to throw, or even to create, exception objects on a success path.
-
Constructor Summary
ConstructorsConstructorDescriptionValidationFailure
(Exception exception) Creates a new ValidationFailure with the given nested exception.ValidationFailure
(String message) Creates a new ValidationException with the given message. -
Method Summary
Modifier and TypeMethodDescriptionasAtomic()
Calling this method on a ConversionResult returns the AtomicValue that results from the conversion if the conversion was successful, and throws a ValidationException explaining the conversion error otherwise.int
Get the constraint clause numberGet the constraint nameGet the constraint name and clause in the format defined in XML Schema Part C (Outcome Tabulations).Get the constraint reference as a string for inserting into an error message.int
Get the "schema part" component of the constraint referenceint
makeException
(String contextMessage) void
setColumnNumber
(int column) void
setConstraintReference
(int schemaPart, String constraintName, String clause) Set a reference to the constraint in XML Schema that is not satisfiedvoid
Copy the constraint reference from another exception objectvoid
setErrorCode
(String errorCode) void
setErrorCodeQName
(StructuredQName errorCode) void
setLineNumber
(int line) void
setLocator
(SourceLocator locator) void
setPublicId
(String id) void
setSourceLocator
(SourceLocator locator) void
setSystemId
(String id) toString()
Returns the String representation of this Exception
-
Constructor Details
-
ValidationFailure
Creates a new ValidationException with the given message.- Parameters:
message
- the message for this Exception
-
ValidationFailure
Creates a new ValidationFailure with the given nested exception.- Parameters:
exception
- the nested exception
-
-
Method Details
-
setConstraintReference
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 2constraintName
- - the short name of the constraint in XMLSchema, as a fragment identifier in the HTML of the XML Schema Part 1 specificationclause
- - the clause number within the description of that constraint
-
setConstraintReference
Copy the constraint reference from another exception object- Parameters:
e
- the other exception object from which to copy the information
-
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
-
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.
-
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.
-
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.
-
getMessage
-
toString
Returns the String representation of this Exception -
getPublicId
- Specified by:
getPublicId
in interfaceLocator
- Specified by:
getPublicId
in interfaceSourceLocator
-
getSystemId
- Specified by:
getSystemId
in interfaceLocator
- Specified by:
getSystemId
in interfaceSourceLocator
-
getLineNumber
public int getLineNumber()- Specified by:
getLineNumber
in interfaceLocator
- Specified by:
getLineNumber
in interfaceSourceLocator
-
getColumnNumber
public int getColumnNumber()- Specified by:
getColumnNumber
in interfaceLocator
- Specified by:
getColumnNumber
in interfaceSourceLocator
-
setPublicId
-
setSystemId
-
setLineNumber
public void setLineNumber(int line) -
setColumnNumber
public void setColumnNumber(int column) -
setLocator
-
setSourceLocator
-
getLocator
-
setErrorCode
-
setErrorCodeQName
-
getErrorCode
-
getErrorCodeQName
-
makeException
-
makeException
-
asAtomic
Calling this method on a ConversionResult returns the AtomicValue that results from the conversion if the conversion was successful, and throws a ValidationException explaining the conversion error otherwise.Use this method if you are calling a conversion method that returns a ConversionResult, and if you want to throw an exception if the conversion fails.
- Specified by:
asAtomic
in interfaceConversionResult
- Returns:
- the atomic value that results from the conversion if the conversion was successful
- Throws:
ValidationException
- if the conversion was not successful
-