|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exolab.castor.xml.schema.Structure
org.exolab.castor.xml.schema.Annotated
org.exolab.castor.xml.schema.Facet
public class Facet
Represents the base type for XML Schema Facets
Field Summary | |
---|---|
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 | |
---|---|
Facet(java.lang.String name,
java.lang.String value)
Creates a new Facet with the given name. |
Method Summary | |
---|---|
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 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 |
---|
public static final java.lang.String ENUMERATION
public static final java.lang.String LENGTH
public static final java.lang.String PATTERN
public static final java.lang.String PRECISION
public static final java.lang.String MAX_EXCLUSIVE
public static final java.lang.String MAX_INCLUSIVE
public static final java.lang.String MIN_EXCLUSIVE
public static final java.lang.String MIN_INCLUSIVE
public static final java.lang.String MAX_LENGTH
public static final java.lang.String MIN_LENGTH
public static final java.lang.String WHITESPACE
public static final java.lang.String TOTALDIGITS
public static final java.lang.String FRACTIONDIGITS
public static final java.lang.String WHITESPACE_PRESERVE
public static final java.lang.String WHITESPACE_REPLACE
public static final java.lang.String WHITESPACE_COLLAPSE
Constructor Detail |
---|
public Facet(java.lang.String name, java.lang.String value)
name
- the name of the Facetvalue
- the value of the FacetMethod Detail |
---|
public java.lang.String getName()
public java.lang.String getValue()
public boolean isMultivalued()
public int toInt() throws java.lang.NumberFormatException
java.lang.NumberFormatException
- if the value fails to parse as a int.public long toLong() throws java.lang.NumberFormatException
java.lang.NumberFormatException
- if the value fails to parse as a long.public short toShort() throws java.lang.NumberFormatException
java.lang.NumberFormatException
- if the value fails to parse as a short.public float toFloat() throws java.lang.NumberFormatException
java.lang.NumberFormatException
- if the value fails to parse as a float.public double toDouble() throws java.lang.NumberFormatException
java.lang.NumberFormatException
- if the value fails to parse as a double.public byte toByte() throws java.lang.NumberFormatException
java.lang.NumberFormatException
- if the value fails to parse as a byte.public java.math.BigDecimal toBigDecimal() throws java.lang.NumberFormatException
BigDecimal
representation of the value of this facet.
BigDecimal
representation of the value of this facet
java.lang.NumberFormatException
- if the value cannot be parsed as numberpublic short getStructureType()
getStructureType
in class Structure
public void validate() throws ValidationException
validate
in class Structure
ValidationException
- when this Schema definition
is invalid.public boolean overridesBase(Facet baseFacet)
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.
baseFacet
- a facet of the base data type
true
,
if the current facet overrides baseFacet
;
false
, otherwise.checkConstraints(Enumeration,Enumeration)
,
SimpleType.getEffectiveFacets()
public void checkConstraints(java.util.Enumeration localFacets, java.util.Enumeration baseFacets) throws SchemaException
localFacets
- local facets of the data typebaseFacets
- merged facets of the base data type
SchemaException
- when the current facet does not satisfy
schema component validation constraintspublic void setOwningType(SimpleType owningType)
SimpleType
instance.
owningType
- The owning SimpleType
instance.public SimpleType getOwningType()
SimpleType
instance.
SimpleType
instance.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |