org.exolab.castor.xml.schema

Class Facet

java.lang.Object

org.exolab.castor.xml.schema.Structure

org.exolab.castor.xml.schema.Annotated

org.exolab.castor.xml.schema.Facet

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MaxExclusive, MaxInclusive, MinExclusive, MinInclusive

public class Facet
extends Annotated

Represents the base type for XML Schema Facets

Version:

$Revision: 7492 $ $Date: 2005-12-13 14:58:48 -0700 (Tue, 13 Dec 2005) $

Author:

Keith Visco

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENUMERATION
static String	FRACTIONDIGITS
static String	LENGTH
static String	MAX_EXCLUSIVE
static String	MAX_INCLUSIVE
static String	MAX_LENGTH
static String	MIN_EXCLUSIVE
static String	MIN_INCLUSIVE
static String	MIN_LENGTH
static String	PATTERN
static String	PRECISION
static String	TOTALDIGITS
static String	WHITESPACE
static String	WHITESPACE_COLLAPSE
static String	WHITESPACE_PRESERVE
static String	WHITESPACE_REPLACE

Fields inherited from class org.exolab.castor.xml.schema.Structure

ANNOTATION, ANYTYPE, APPINFO, ATTRIBUTE, ATTRIBUTE_GROUP, COMPLEX_CONTENT, COMPLEX_TYPE, DOCUMENTATION, ELEMENT, FACET, GROUP, IDENTITY_FIELD, IDENTITY_SELECTOR, KEY, KEYREF, LIST, MODELGROUP, MODELGROUP_REF, REDEFINE, SCHEMA, SIMPLE_CONTENT, SIMPLE_TYPE, UNION, UNIQUE, UNKNOWN, WILDCARD

Constructor Summary

Constructors

Constructor and Description
Facet(String name, String value) Creates a new Facet with the given name.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkConstraints(Enumeration localFacets, Enumeration baseFacets) Checks the constraints on the current facet against the other local facets of the same derived data type and facets of the base data type.
String	getName() Returns the name of this Facet.
SimpleType	getOwningType() Returns the owning SimpleType instance.
short	getStructureType() Returns the type of this Schema Structure.
String	getValue() Returns the character (String) representation of this facet.
boolean	isMultivalued() Returns true if this Facet can occur more than once, such as the "enumeration" facet.
boolean	overridesBase(Facet baseFacet) Checks whether the current facet overrides a facet of the base data type.
void	setOwningType(SimpleType owningType) Sets the owning SimpleType instance.
BigDecimal	toBigDecimal() Returns a BigDecimal representation of the value of this facet.
byte	toByte() Returns a byte representation of the value of this facet.
double	toDouble() Returns a double representation of the value of this facet.
float	toFloat() Returns a double representation of the value of this facet.
int	toInt() Returns an int representation of the value of this facet.
long	toLong() Returns a long representation of the value of this facet.
short	toShort() Returns an short representation of the value of this facet.
void	validate() Checks the validity of this Schema defintion.

Methods inherited from class org.exolab.castor.xml.schema.Annotated

addAnnotation, getAnnotations, removeAnnotation

Methods inherited from class org.exolab.castor.xml.schema.Structure

isValid

Methods inherited from class java.lang.Object

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

Field Detail

ENUMERATION

public static final String ENUMERATION

See Also:

Constant Field Values

LENGTH

public static final String LENGTH

See Also:

Constant Field Values

PATTERN

public static final String PATTERN

See Also:

Constant Field Values

PRECISION

public static final String PRECISION

See Also:

Constant Field Values

MAX_EXCLUSIVE

public static final String MAX_EXCLUSIVE

See Also:

Constant Field Values

MAX_INCLUSIVE

public static final String MAX_INCLUSIVE

See Also:

Constant Field Values

MIN_EXCLUSIVE

public static final String MIN_EXCLUSIVE

See Also:

Constant Field Values

MIN_INCLUSIVE

public static final String MIN_INCLUSIVE

See Also:

Constant Field Values

MAX_LENGTH

public static final String MAX_LENGTH

See Also:

Constant Field Values

MIN_LENGTH

public static final String MIN_LENGTH

See Also:

Constant Field Values

WHITESPACE

public static final String WHITESPACE

See Also:

Constant Field Values

TOTALDIGITS

public static final String TOTALDIGITS

See Also:

Constant Field Values

FRACTIONDIGITS

public static final String FRACTIONDIGITS

See Also:

Constant Field Values

WHITESPACE_PRESERVE

public static final String WHITESPACE_PRESERVE

See Also:

Constant Field Values

WHITESPACE_REPLACE

public static final String WHITESPACE_REPLACE

See Also:

Constant Field Values

WHITESPACE_COLLAPSE

public static final String WHITESPACE_COLLAPSE

See Also:

Constant Field Values

Constructor Detail

Facet

public Facet(String name,
     String value)

Creates a new Facet with the given name.

Parameters:

name - the name of the Facet

value - the value of the Facet

Method Detail

getName

public String getName()

Returns the name of this Facet.

Returns:

the name of this Facet

getValue

public String getValue()

Returns the character (String) representation of this facet.

Returns:

the value of this facet

isMultivalued

public boolean isMultivalued()

Returns true if this Facet can occur more than once, such as the "enumeration" facet.

Returns:

true if this Facet can occur more than once.

toInt

public int toInt()
          throws NumberFormatException

Returns an int representation of the value of this facet.

Returns:

an int representation of the value of this facet

Throws:

NumberFormatException - if the value fails to parse as a int.

toLong

public long toLong()
            throws NumberFormatException

Returns a long representation of the value of this facet.

Returns:

a long representation of the value of this facet

Throws:

NumberFormatException - if the value fails to parse as a long.

toShort

public short toShort()
              throws NumberFormatException

Returns an short representation of the value of this facet.

Returns:

an short representation of the value of this facet

Throws:

NumberFormatException - if the value fails to parse as a short.

toFloat

public float toFloat()
              throws NumberFormatException

Returns a double representation of the value of this facet.

Returns:

a double representation of the value of this facet

Throws:

NumberFormatException - if the value fails to parse as a float.

toDouble

public double toDouble()
                throws NumberFormatException

Returns a double representation of the value of this facet.

Returns:

a double representation of the value of this facet

Throws:

NumberFormatException - if the value fails to parse as a double.

toByte

public byte toByte()
            throws NumberFormatException

Returns a byte representation of the value of this facet.

Returns:

a byte representation of the value of this facet

Throws:

NumberFormatException - if the value fails to parse as a byte.

toBigDecimal

public BigDecimal toBigDecimal()
                        throws NumberFormatException

Returns a BigDecimal representation of the value of this facet.

Returns:

a BigDecimal representation of the value of this facet

Throws:

NumberFormatException - if the value cannot be parsed as number

getStructureType

public short getStructureType()

Returns the type of this Schema Structure.

Specified by:

getStructureType in class Structure

Returns:

the type of this Schema Structure

validate

public void validate()
              throws ValidationException

Checks the validity of this Schema defintion.

Specified by:

validate in class Structure

Throws:

ValidationException - when this Schema definition is invalid.

overridesBase

public boolean overridesBase(Facet baseFacet)

Checks whether the current facet overrides a facet of the base data type. This does generally happen when a data type is derived by restriction and it therefore has facet(s), which are more restrictive than the ones of the base data type.

This method is used for merging facets of the base and derived types, in order to create an effective set of facets for the derived type.

It's important to note that this method does not perform any validity checks. Validation must be generally performed before trying to merge facets of the base and derived types.

Parameters:

baseFacet - a facet of the base data type

Returns:

true, if the current facet overrides baseFacet; false, otherwise.

See Also:

checkConstraints(Enumeration,Enumeration), SimpleType.getEffectiveFacets()

checkConstraints

public void checkConstraints(Enumeration localFacets,
                    Enumeration baseFacets)
                      throws SchemaException

Checks the constraints on the current facet against the other local facets of the same derived data type and facets of the base data type. Validation is performed according to the rules defined in "XML Schema Part 2: Datatypes Second Edition" document.

Parameters:

localFacets - local facets of the data type

baseFacets - merged facets of the base data type

Throws:

SchemaException - when the current facet does not satisfy schema component validation constraints

setOwningType

public void setOwningType(SimpleType owningType)

Sets the owning SimpleType instance.

Parameters:

owningType - The owning SimpleType instance.

getOwningType

public SimpleType getOwningType()

Returns the owning SimpleType instance.

Returns:

The owning SimpleType instance.