Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> de >> caffeine >> [ jargus overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of de.caffeine.jargus.XMLValidationHandler JAVADOC | Sourc code of de.caffeine.jargus.XMLValidationHandler SOURCE | Download de.caffeine.jargus.XMLValidationHandler DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

de.caffeine.jargus
Class XMLValidationHandler  view XMLValidationHandler download XMLValidationHandler.java

java.lang.Object
  extended byde.caffeine.jargus.XMLValidationHandler
All Implemented Interfaces:
ExtendedValidationHandler, ValidationHandler
public class XMLValidationHandler
extends java.lang.Object
implements ExtendedValidationHandler

A validation handler which uses xml configuration files for setup.
Sample configuration file:

 <jargus>

Mapping tags are used for mapping parameter keys to labels which are put in error messages instead. 

  <mapping parameter="p1" label="Name"/>
	<mapping parameter="p2" label="E-Mail" />

Summarized error message starts with: 

	<error-message>Validation Failed</error-message>

For every error type of validation an error message text can be set. The tokens:

will be replaced. 

	<check validation="exist">
		<error-message>Parameter ${parameter} has to be inserted</error-message>
	</check>

	<check validation="contains">
		<error-message>Parameter ${parameter} must contain ${arguments}.</error-message>
	</check>

 </jargus>

Version:
$Id: XMLValidationHandler.java,v 1.1 2001/04/25 18:18:52 blob79 Exp $

Nested Class Summary
private  class XMLValidationHandler.AbstractHandler
          For each tag in the configuration file is one Handler reponsible.
private  class XMLValidationHandler.CheckHandler
          Handle check tag.
private  class XMLValidationHandler.ConfReader
          Reads configuration file.
private  class XMLValidationHandler.ErrorMessageHandler
          Handler for error-message tag.
private  class XMLValidationHandler.JargusHandler
          Jargus tag handler.
private  class XMLValidationHandler.MappingHandler
          Handle mapping tag.
 
Field Summary
private  java.lang.String _errorMessage
          Summary error message (begins with _errorMessageHead).
private  java.lang.String _errorMessageHead
          Error message head from config file.
private  java.util.HashMap _errorMessages
          errorMessages
key - validator, value - message
private  java.util.HashMap _failed
          Failed Parameter
private  java.lang.String _file
          URI of conf file.
private  java.util.HashMap _mapping
          Mapping from parameter names to labels in error message.
private  java.lang.String _newLineToken
           
private  org.xml.sax.XMLReader _parser
          XML Parser entity.
private  StringUtil _util
          String processing.
 
Constructor Summary
XMLValidationHandler()
           
XMLValidationHandler(java.lang.String uri)
           
 
Method Summary
 void error(Validator validator)
          Called if a error occures.
 void failed()
          Validation failed.
 java.lang.String getMessage()
           
 void ok()
          Description of the Method
 boolean parameterFailed(java.lang.String parameter)
          check if parameter validation failed
 void setFile(java.lang.String file)
          Set file uri and start reading xml file.
 void start()
          Validation started.
 void warning(Validator validator)
          Called if a warning occures.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_failed

private java.util.HashMap _failed
Failed Parameter

_errorMessages

private java.util.HashMap _errorMessages
errorMessages
key - validator, value - message

_errorMessageHead

private java.lang.String _errorMessageHead
Error message head from config file.

_errorMessage

private java.lang.String _errorMessage
Summary error message (begins with _errorMessageHead).

_parser

private org.xml.sax.XMLReader _parser
XML Parser entity.

_util

private StringUtil _util
String processing.

_file

private java.lang.String _file
URI of conf file. e.g. file:/somewhere/configuration/jargus.xml

_mapping

private java.util.HashMap _mapping
Mapping from parameter names to labels in error message.

_newLineToken

private java.lang.String _newLineToken
Constructor Detail

XMLValidationHandler

public XMLValidationHandler()

XMLValidationHandler

public XMLValidationHandler(java.lang.String uri)
                     throws java.io.IOException,
                            org.xml.sax.SAXException
Method Detail

setFile

public void setFile(java.lang.String file)
             throws java.io.IOException,
                    org.xml.sax.SAXException
Set file uri and start reading xml file.

getMessage

public java.lang.String getMessage()
Specified by:
getMessage in interface ExtendedValidationHandler

start

public void start()
Description copied from interface: ValidationHandler
Validation started.

Specified by:
start in interface ValidationHandler

error

public void error(Validator validator)
Description copied from interface: ValidationHandler
Called if a error occures.

Specified by:
error in interface ValidationHandler

warning

public void warning(Validator validator)
Description copied from interface: ValidationHandler
Called if a warning occures. Not implemented yet!

Specified by:
warning in interface ValidationHandler

ok

public void ok()
Description of the Method

Specified by:
ok in interface ValidationHandler

failed

public void failed()
Description copied from interface: ValidationHandler
Validation failed.

Specified by:
failed in interface ValidationHandler

parameterFailed

public boolean parameterFailed(java.lang.String parameter)
check if parameter validation failed

Specified by:
parameterFailed in interface ExtendedValidationHandler
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> de >> caffeine >> [ jargus overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of de.caffeine.jargus.XMLValidationHandler JAVADOC | Sourc code of de.caffeine.jargus.XMLValidationHandler SOURCE | Download de.caffeine.jargus.XMLValidationHandler DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD