Facet (Castor JavaDoc)

java.lang.Object
- org.exolab.castor.xml.schema.Structure
- - org.exolab.castor.xml.schema.Annotated
  - - org.exolab.castor.xml.schema.Facet

All Implemented Interfaces:

java.io.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	Description
`static java.lang.String`	`ENUMERATION`
`static java.lang.String`	`FRACTIONDIGITS`
`static java.lang.String`	`LENGTH`
`static java.lang.String`	`MAX_EXCLUSIVE`
`static java.lang.String`	`MAX_INCLUSIVE`
`static java.lang.String`	`MAX_LENGTH`
`static java.lang.String`	`MIN_EXCLUSIVE`
`static java.lang.String`	`MIN_INCLUSIVE`
`static java.lang.String`	`MIN_LENGTH`
`static java.lang.String`	`PATTERN`
`static java.lang.String`	`PRECISION`
`static java.lang.String`	`TOTALDIGITS`
`static java.lang.String`	`WHITESPACE`
`static java.lang.String`	`WHITESPACE_COLLAPSE`
`static java.lang.String`	`WHITESPACE_PRESERVE`
`static java.lang.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 Description

Facet(java.lang.String name, java.lang.String value)
Creates a new Facet with the given name.

Constructors
Constructor	Description
`Facet(java.lang.String name, java.lang.String value)`	Creates a new Facet with the given name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`checkConstraints(java.util.Enumeration localFacets, java.util.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.
`java.lang.String`	`getName()`	Returns the name of this Facet.
`SimpleType`	`getOwningType()`	Returns the owning `SimpleType` instance.
`short`	`getStructureType()`	Returns the type of this Schema Structure.
`java.lang.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.
`java.math.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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

- Field Detail
  - ENUMERATION
```
public static final java.lang.String ENUMERATION
```
    See Also:
    
    Constant Field Values
  - LENGTH
```
public static final java.lang.String LENGTH
```
    See Also:
    
    Constant Field Values
  - PATTERN
```
public static final java.lang.String PATTERN
```
    See Also:
    
    Constant Field Values
  - PRECISION
```
public static final java.lang.String PRECISION
```
    See Also:
    
    Constant Field Values
  - MAX_EXCLUSIVE
```
public static final java.lang.String MAX_EXCLUSIVE
```
    See Also:
    
    Constant Field Values
  - MAX_INCLUSIVE
```
public static final java.lang.String MAX_INCLUSIVE
```
    See Also:
    
    Constant Field Values
  - MIN_EXCLUSIVE
```
public static final java.lang.String MIN_EXCLUSIVE
```
    See Also:
    
    Constant Field Values
  - MIN_INCLUSIVE
```
public static final java.lang.String MIN_INCLUSIVE
```
    See Also:
    
    Constant Field Values
  - MAX_LENGTH
```
public static final java.lang.String MAX_LENGTH
```
    See Also:
    
    Constant Field Values
  - MIN_LENGTH
```
public static final java.lang.String MIN_LENGTH
```
    See Also:
    
    Constant Field Values
  - WHITESPACE
```
public static final java.lang.String WHITESPACE
```
    See Also:
    
    Constant Field Values
  - TOTALDIGITS
```
public static final java.lang.String TOTALDIGITS
```
    See Also:
    
    Constant Field Values
  - FRACTIONDIGITS
```
public static final java.lang.String FRACTIONDIGITS
```
    See Also:
    
    Constant Field Values
  - WHITESPACE_PRESERVE
```
public static final java.lang.String WHITESPACE_PRESERVE
```
    See Also:
    
    Constant Field Values
  - WHITESPACE_REPLACE
```
public static final java.lang.String WHITESPACE_REPLACE
```
    See Also:
    
    Constant Field Values
  - WHITESPACE_COLLAPSE
```
public static final java.lang.String WHITESPACE_COLLAPSE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Facet
```
public Facet(java.lang.String name,
             java.lang.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 java.lang.String getName()
```
    Returns the name of this Facet.
    
    Returns:
    
    the name of this Facet
  - getValue
```
public java.lang.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 java.lang.NumberFormatException
```
    Returns an int representation of the value of this facet.
    
    Returns:
    
    an int representation of the value of this facet
    
    Throws:
    
    java.lang.NumberFormatException - if the value fails to parse as a int.
  - toLong
```
public long toLong()
            throws java.lang.NumberFormatException
```
    Returns a long representation of the value of this facet.
    
    Returns:
    
    a long representation of the value of this facet
    
    Throws:
    
    java.lang.NumberFormatException - if the value fails to parse as a long.
  - toShort
```
public short toShort()
              throws java.lang.NumberFormatException
```
    Returns an short representation of the value of this facet.
    
    Returns:
    
    an short representation of the value of this facet
    
    Throws:
    
    java.lang.NumberFormatException - if the value fails to parse as a short.
  - toFloat
```
public float toFloat()
              throws java.lang.NumberFormatException
```
    Returns a double representation of the value of this facet.
    
    Returns:
    
    a double representation of the value of this facet
    
    Throws:
    
    java.lang.NumberFormatException - if the value fails to parse as a float.
  - toDouble
```
public double toDouble()
                throws java.lang.NumberFormatException
```
    Returns a double representation of the value of this facet.
    
    Returns:
    
    a double representation of the value of this facet
    
    Throws:
    
    java.lang.NumberFormatException - if the value fails to parse as a double.
  - toByte
```
public byte toByte()
            throws java.lang.NumberFormatException
```
    Returns a byte representation of the value of this facet.
    
    Returns:
    
    a byte representation of the value of this facet
    
    Throws:
    
    java.lang.NumberFormatException - if the value fails to parse as a byte.
  - toBigDecimal
```
public java.math.BigDecimal toBigDecimal()
                                  throws java.lang.NumberFormatException
```
    Returns a BigDecimal representation of the value of this facet.
    
    Returns:
    
    a BigDecimal representation of the value of this facet
    
    Throws:
    
    java.lang.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(java.util.Enumeration localFacets,
                             java.util.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.

Class Facet

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

ENUMERATION

LENGTH

PATTERN

PRECISION

MAX_EXCLUSIVE

MAX_INCLUSIVE

MIN_EXCLUSIVE

MIN_INCLUSIVE

MAX_LENGTH

MIN_LENGTH

WHITESPACE

TOTALDIGITS

FRACTIONDIGITS

WHITESPACE_PRESERVE

WHITESPACE_REPLACE

WHITESPACE_COLLAPSE

Constructor Detail

Facet

Method Detail

getName

getValue

isMultivalued

toInt

toLong

toShort

toFloat

toDouble

toByte

toBigDecimal

getStructureType

validate

overridesBase

checkConstraints

setOwningType

getOwningType