org.yawlfoundation.yawl.schema

Class SchemaHandler

java.lang.Object

org.yawlfoundation.yawl.schema.SchemaHandler

public class SchemaHandler
extends java.lang.Object

This object acts as a reusable Schema validator for a given schema. Once the schema has been successfully compiled, any number of XML documents can be validated by calling either of the validate methods.

Author:

Mike Fowler Date: 04-Jul-2006

Constructor Summary

Constructors

Constructor and Description
SchemaHandler(java.io.InputStream is) Constructs a new SchemaHandler
SchemaHandler(java.lang.String xml) Constructs a new SchemaHandler
SchemaHandler(java.net.URL url) Constructs a new SchemaHandler

Method Summary

Modifier and Type	Method and Description
boolean	compileAndValidate(java.lang.String xml) Compiles the schema, and if successful validates an XML String against it
boolean	compileSchema() Attempts to compile the schema.
java.lang.String	getConcatenatedMessage()
Element	getDataTypeDefinition(java.lang.String typeName) Gets the schema element definition of a data type by name
java.util.List<java.lang.String>	getErrorMessages()
java.util.List<java.lang.String>	getMessages()
java.util.Set<java.lang.String>	getPrimaryTypeNames()
java.lang.String	getSchema()
java.util.Map<java.lang.String,Element>	getTypeMap() Gets the map of data type names to their definitions
java.util.List<java.lang.String>	getWarningMessages()
void	setSchema(java.lang.String schema)
boolean	validate(java.lang.String xml) Validates the given XML document against the compiled schema.

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaHandler

public SchemaHandler(java.lang.String xml)

Constructs a new SchemaHandler

Parameters:

xml - XML String representing the schema this handler will use for validation

SchemaHandler

public SchemaHandler(java.io.InputStream is)

Constructs a new SchemaHandler

Parameters:

is - a Stream representing the schema this handler will use for validation

SchemaHandler

public SchemaHandler(java.net.URL url)

Constructs a new SchemaHandler

Parameters:

url - a URL to the XSD representing the schema this handler will use for validation

Method Detail

compileAndValidate

public boolean compileAndValidate(java.lang.String xml)

Compiles the schema, and if successful validates an XML String against it

Parameters:

xml - the XML String to validate against Schema

Returns:

true if the Schema compiles without error AND the XML is a valid instance of the Schema

compileSchema

public boolean compileSchema()

Attempts to compile the schema. If successful, allows an XML document to be validated.

Returns:

true if the schema has compiled successfully.

validate

public boolean validate(java.lang.String xml)

Validates the given XML document against the compiled schema.

Parameters:

xml - instance document to be validated.

Returns:

true if the xml is a valid instance of the schema

Throws:

java.lang.IllegalStateException - if schema has not been compiled successfully

getErrorMessages

public java.util.List<java.lang.String> getErrorMessages()

Returns:

all error messages from the last validation/compilation

getWarningMessages

public java.util.List<java.lang.String> getWarningMessages()

Returns:

all warning messages from the last validation/compilation

getMessages

public java.util.List<java.lang.String> getMessages()

Returns:

all messages from the last validation/compilation

getConcatenatedMessage

public java.lang.String getConcatenatedMessage()

Returns:

all messages since the last validation/compilation

getSchema

public java.lang.String getSchema()

Returns:

String representation of the schema

setSchema

public void setSchema(java.lang.String schema)

Parameters:

schema - new schema to use (resets everything)

getPrimaryTypeNames

public java.util.Set<java.lang.String> getPrimaryTypeNames()

Returns:

the set of (first-level) type names defined in this schema

getDataTypeDefinition

public Element getDataTypeDefinition(java.lang.String typeName)

Gets the schema element definition of a data type by name

Parameters:

typeName - the data type name

Returns:

the corresponding definition, or null if the type name is unknown

getTypeMap

public java.util.Map<java.lang.String,Element> getTypeMap()

Gets the map of data type names to their definitions

Returns:

the map of names to definitions