com.sun.msv.datatype.xsd

Interface XSDatatype

public interface XSDatatype extends Serializable, DatabindableDatatype

Publicly accesible interface of W3C XML Schema datatype (simple type).

The most important methods are defined in the org.relaxng.datatype.Datatype interface. This interface provides additional information which is not covered by org.relaxng.datatype.Datatype interface. Also, this interface provides various simple type component properties which are defined in the spec.

Application can use this interface to interact with datatype objects.

Author: Kohsuke KAWAGUCHI

Field Summary
static intAPPLICABLE
indicates the specified facet is applicable to this type.
static intDERIVATION_BY_LIST
static intDERIVATION_BY_RESTRICTION
static intDERIVATION_BY_UNION
static StringFACET_ENUMERATION
static StringFACET_FRACTIONDIGITS
static StringFACET_LENGTH
static StringFACET_MAXEXCLUSIVE
static StringFACET_MAXINCLUSIVE
static StringFACET_MAXLENGTH
static StringFACET_MINEXCLUSIVE
static StringFACET_MININCLUSIVE
static StringFACET_MINLENGTH
static StringFACET_PATTERN
static StringFACET_TOTALDIGITS
static StringFACET_WHITESPACE
static intFIXED
indicates the specified facet is fixed in this type and therefore not appliable.
static intNOT_ALLOWED
indicates the specified facet is not appliable to this type by definition.
static intVARIETY_ATOMIC
static intVARIETY_LIST
static intVARIETY_UNION
static StringXMLSCHEMA_NSURI
Method Summary
StringconvertToLexicalValue(Object valueObject, SerializationContext context)
converts value object back to the corresponding value in the lexical space.
StringdisplayName()
gets the displayable name of this type.
XSDatatypegetAncestorBuiltinType()
Gets the nearest ancestor built-in type.
String[]getApplicableFacetNames()
Gets the names of all applicable facets.
XSDatatypegetBaseType()
gets the base type of this type.
DataTypeWithFacetgetFacetObject(String facetName)
gets the facet object that restricts the specified facet.
StringgetName()
gets the local name of the type.
StringgetNamespaceUri()
Gets the namespace URI of this simple type definition.
intgetVariety()
gets the variety of this simple type.
booleanisAlwaysValid()
Returns true if this datatype is known to accept any string.
booleanisDerivedTypeOf(XSDatatype baseType, boolean restrictionAllowed)
tests if this type is a derived type of the specified type.
intisFacetApplicable(String facetName)
returns if the specified facet is applicable to this datatype.
booleanisFinal(int derivationType)
checks if this type is declared as final for the specified kind of derivation.

Field Detail

APPLICABLE

public static final int APPLICABLE
indicates the specified facet is applicable to this type. One of the possible return value from the isFacetApplicable method.

DERIVATION_BY_LIST

public static final int DERIVATION_BY_LIST

DERIVATION_BY_RESTRICTION

public static final int DERIVATION_BY_RESTRICTION

DERIVATION_BY_UNION

public static final int DERIVATION_BY_UNION

FACET_ENUMERATION

public static final String FACET_ENUMERATION

FACET_FRACTIONDIGITS

public static final String FACET_FRACTIONDIGITS

FACET_LENGTH

public static final String FACET_LENGTH

FACET_MAXEXCLUSIVE

public static final String FACET_MAXEXCLUSIVE

FACET_MAXINCLUSIVE

public static final String FACET_MAXINCLUSIVE

FACET_MAXLENGTH

public static final String FACET_MAXLENGTH

FACET_MINEXCLUSIVE

public static final String FACET_MINEXCLUSIVE

FACET_MININCLUSIVE

public static final String FACET_MININCLUSIVE

FACET_MINLENGTH

public static final String FACET_MINLENGTH

FACET_PATTERN

public static final String FACET_PATTERN

FACET_TOTALDIGITS

public static final String FACET_TOTALDIGITS

FACET_WHITESPACE

public static final String FACET_WHITESPACE

FIXED

public static final int FIXED
indicates the specified facet is fixed in this type and therefore not appliable. One of the possible return value from the isFacetApplicable method.

NOT_ALLOWED

public static final int NOT_ALLOWED
indicates the specified facet is not appliable to this type by definition. One of the possible return value from the isFacetApplicable method.

VARIETY_ATOMIC

public static final int VARIETY_ATOMIC

VARIETY_LIST

public static final int VARIETY_LIST

VARIETY_UNION

public static final int VARIETY_UNION

XMLSCHEMA_NSURI

public static final String XMLSCHEMA_NSURI

Method Detail

convertToLexicalValue

public String convertToLexicalValue(Object valueObject, SerializationContext context)
converts value object back to the corresponding value in the lexical space.

This method does the reverse operation of the createValue method. The returned string is not necessarily the canonical representation. Also note that the implementation may accept invalid values without throwing IllegalArgumentException. To make sure that the result is actually a valid representation, call the isValid method.

Be careful not to confuse this method with The serializeJavaObject method, which is defined in the DatabindableDatatype method.

Parameters: context Context information that will be possibly used for the conversion. Currently, this object is used only by QName, but may be extended in the future.

Throws: IllegalArgumentException if the type of the given object is not the expected one. For example, this exception is thrown if you pass a BigInteger object to the "gYear" type.

displayName

public String displayName()
gets the displayable name of this type. This method always return something. It is useful to provide a message to the user.

This method is an ad-hoc method and there is no corresponding property in the spec.

getAncestorBuiltinType

public XSDatatype getAncestorBuiltinType()
Gets the nearest ancestor built-in type.

This method traverses the inheritance chain from this datatype to the root type (anySimpleType) and return the first built-in type it finds.

For example, if you derive a type Foo from NCName and Bar from Foo, then this method returns NCName.

Returns: Always return non-null valid object.

getApplicableFacetNames

public String[] getApplicableFacetNames()
Gets the names of all applicable facets.

getBaseType

public XSDatatype getBaseType()
gets the base type of this type. This method returns null if this object represents the simple ur-type.

This method is intended to capture the semantics of the base type definition property of the simple type component, but there is an important difference.

Specifically, if you derive a type D from another type B, then calling D.getBaseType() does not necessarily return B. Instead, it may return an intermediate object (that represents a facet). Calling the getBaseType method recursively will eventually return B.

getFacetObject

public DataTypeWithFacet getFacetObject(String facetName)
gets the facet object that restricts the specified facet. This method can be used to access various details of how facets are applied to this datatype.

Returns: null if no such facet object exists.

getName

public String getName()
gets the local name of the type. If this type is an anonymous type, then this method returns null.

In the terminology of the spec, this method returns the name property of this simple type component. If the name property is absent, this method returns null.

getNamespaceUri

public String getNamespaceUri()
Gets the namespace URI of this simple type definition.

getVariety

public int getVariety()
gets the variety of this simple type.

Returns: VARIETY_ATOMIC, VARIETY_LIST, or VARIETY_UNION.

isAlwaysValid

public boolean isAlwaysValid()
Returns true if this datatype is known to accept any string. This is just a hint that allows the client code to do certain optimization.

This method can return false even if the datatype actually accepts any string. That is, it's perfectly OK for any datatype to return false from this method.

isDerivedTypeOf

public boolean isDerivedTypeOf(XSDatatype baseType, boolean restrictionAllowed)
tests if this type is a derived type of the specified type.

This method is an implementation of "Type Derivation OK (Simple)" of the spec. Therefore use caution if what you want is a casual method because this method may cause a lot of unintuitive result.

Note to implementors Use the static version of this method defined in the XSDatatypeImpl class. You don't need to implement this method from scratch.

Parameters: restrictionAllowed This test needs "a subset of {extension,restriction,list,union} (of which only restriction is actually relevant). If this flag is set to true, this method behaves as if the empty set is passed as the set. This is usually what you want if you're simply trying to check the derivation relationship.

If this flag is set to false, this method behaves as if {restriction} is passed as the set.

isFacetApplicable

public int isFacetApplicable(String facetName)
returns if the specified facet is applicable to this datatype.

Returns:

APPLICABLE
if the facet is applicable
FIXED
if the facet is already fixed (that is,not applicable)
NOT_ALLOWED
if the facet is not applicable to this datatype at all. this value is also returned for unknown facets.

isFinal

public boolean isFinal(int derivationType)
checks if this type is declared as final for the specified kind of derivation.

In the terminology of the spec, this method can be used to examine the final property of this component.

Parameters: derivationType one of pre-defined values (DERIVATION_BY_XXX).