net.ontopia.topicmaps.schema.utils

Class HTMLValidationHandler

java.lang.Object

net.ontopia.topicmaps.schema.utils.HTMLValidationHandler

All Implemented Interfaces:

ValidationHandlerIF

public class HTMLValidationHandler
extends Object
implements ValidationHandlerIF

INTERNAL: Validation handler that writes error reports (using some HTML markup) on each violation out to the given Writer.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	errors
protected Writer	out

Constructor Summary

Constructors

Constructor and Description
HTMLValidationHandler(Writer out)

Method Summary

Modifier and Type	Method and Description
void	endValidation() PUBLIC: Called after the validation of an entire topic map.
int	getErrors()
protected String	printAssociationRole(AssociationRoleIF role)
protected String	printConstraint(ConstraintIF constraint)
protected String	printMatcher(TMObjectMatcherIF matcher)
protected void	printScope(Collection scope)
protected String	printScopeSpec(ScopeSpecification scopespec)
protected String	printTopic(TopicIF topic)
protected String	printTypes(TopicIF topic)
protected String	printTypeSpec(TypeSpecification typespec)
protected String	printTypeSpecs(Collection specs)
void	startValidation() PUBLIC: Called before the validation of an entire topic map begins.
void	violation(String message, TMObjectIF container, Object offender, ConstraintIF constraint) PUBLIC: Called when violations of the schema are discovered.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

out

protected Writer out

errors

protected int errors

Constructor Detail

HTMLValidationHandler

public HTMLValidationHandler(Writer out)

Method Detail

startValidation

public void startValidation()

Description copied from interface: ValidationHandlerIF

PUBLIC: Called before the validation of an entire topic map begins. When single topics or associations are validated this method is not called.

Specified by:

startValidation in interface ValidationHandlerIF

violation

public void violation(String message,
                      TMObjectIF container,
                      Object offender,
                      ConstraintIF constraint)
               throws SchemaViolationException

Description copied from interface: ValidationHandlerIF

PUBLIC: Called when violations of the schema are discovered.

Specified by:

violation in interface ValidationHandlerIF

Parameters:

message - A message describing the nature of the violation.

container - The container of the offending object.

offender - The object that violated the schema.

constraint - The constraint that was violated.

Throws:

SchemaViolationException - Implementations may throw this exception if they wish to halt validation.

endValidation

public void endValidation()

Description copied from interface: ValidationHandlerIF

PUBLIC: Called after the validation of an entire topic map. When single topics or associations are validated this method is not called.

Specified by:

endValidation in interface ValidationHandlerIF

printScope

protected void printScope(Collection scope)
                   throws IOException

Throws:

IOException

printTypes

protected String printTypes(TopicIF topic)

printTopic

protected String printTopic(TopicIF topic)

printConstraint

protected String printConstraint(ConstraintIF constraint)

printMatcher

protected String printMatcher(TMObjectMatcherIF matcher)

printTypeSpecs

protected String printTypeSpecs(Collection specs)

printTypeSpec

protected String printTypeSpec(TypeSpecification typespec)

printScopeSpec

protected String printScopeSpec(ScopeSpecification scopespec)

printAssociationRole

protected String printAssociationRole(AssociationRoleIF role)

getErrors

public int getErrors()