org.xins.common.types

Class XMLType

java.lang.Object

org.xins.common.types.Type

org.xins.common.types.standard.XML

org.xins.common.types.XMLType

public abstract class XMLType
extends XML

Abstract base class for XML types with XSD validation.

Since:

XINS 3.0

Version:

$Revision: 1.3 $ $Date: 2012/05/12 08:03:00 $

Author:

Anthony Goubard

Field Summary

Fields inherited from class org.xins.common.types.standard.XML

SINGLETON

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XMLType(String name, String xsdLocation) Creates a new XMLType instance.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Retrieves the description of this type.
protected Source	getSource(String xsdLocation)
protected boolean	isValidValueImpl(String value) Determines if the specified String value is considered valid for this type (implementation method).

Methods inherited from class org.xins.common.types.standard.XML

fromStringForOptional, fromStringForRequired, fromStringImpl, toString, toString

Methods inherited from class org.xins.common.types.Type

checkValue, fromString, getName, getValueClass, isValidValue, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLType

protected XMLType(String name,
       String xsdLocation)
           throws IllegalArgumentException,
                  Exception

Creates a new XMLType instance. The name of the type needs to be specified. The value class (see Type.getValueClass()) is set to org.w3c.dom.Element.class.

Parameters:

name - the name of the type, not null.

xsdLocation - the location of the schema, can be absolute or relative URI, not null.

Throws:

IllegalArgumentException - if name == null || xsdLocation == null.

PatternCompileException - if the specified pattern is considered invalid.

Exception

Method Detail

getSource

protected Source getSource(String xsdLocation)

isValidValueImpl

protected final boolean isValidValueImpl(String value)

Description copied from class: Type

Determines if the specified String value is considered valid for this type (implementation method).

This method is called from Type.isValidValue(String). When called from that method, it is guaranteed that the argument is not null.

The implementation of this method in class Type returns true.

Overrides:

isValidValueImpl in class XML

Parameters:

value - the String value that should be checked for validity, never null.

Returns:

true if and only if the specified String value is valid, false otherwise.

getDescription

public String getDescription()

Description copied from class: Type

Retrieves the description of this type.

Overrides:

getDescription in class XML

Returns:

the description of this type, never null.