org.apache.xerces.impl.xs.psvi
Interface XSSimpleTypeDefinition

All Superinterfaces:
XSObject, XSTypeDefinition
All Known Subinterfaces:
XSSimpleType
All Known Implementing Classes:
XSSimpleTypeDecl

public interface XSSimpleTypeDefinition
extends XSTypeDefinition

4.1.1 The Simple Type Definition Schema Component (XML Schema Part 2).

Version:
$Id: XSSimpleTypeDefinition.java,v 1.2 2002/06/17 18:41:46 elena Exp $
Author:
Elena Litani, IBM

Field Summary
static short FACET_ENUMERATION
          4.3.5 enumeration.
static short FACET_FRACTIONDIGITS
          4.3.12 fractionDigits.
static short FACET_LENGTH
          4.3.1 Length
static short FACET_MAXEXCLUSIVE
          4.3.9 maxExclusive.
static short FACET_MAXINCLUSIVE
          4.3.7 maxInclusive.
static short FACET_MAXLENGTH
          4.3.3 maxLength.
static short FACET_MINEXCLUSIVE
          4.3.9 minExclusive.
static short FACET_MININCLUSIVE
          4.3.10 minInclusive.
static short FACET_MINLENGTH
          4.3.2 minLength.
static short FACET_NONE
          none
static short FACET_PATTERN
          4.3.4 pattern.
static short FACET_TOTALDIGITS
          4.3.11 totalDigits .
static short FACET_WHITESPACE
          4.3.6 whitespace.
static short ORDERED_FALSE
          not ordered
static short ORDERED_PARTIAL
          partically ordered
static short ORDERED_TOTAL
          totally ordered
static short VARIETY_ABSENT
          XSSimpleType variety
static short VARIETY_ATOMIC
          XSSimpleType variety
static short VARIETY_LIST
          XSSimpleType variety
static short VARIETY_UNION
          XSSimpleType variety
 
Fields inherited from interface org.apache.xerces.impl.xs.psvi.XSTypeDefinition
COMPLEX_TYPE, SIMPLE_TYPE
 
Method Summary
 XSAnnotation getAnnotation()
          Optional.
 short getDefinedFacets()
          {Facets} Get all facets defined on this type.
 short getFixedFacets()
          {Facets} Get all facets defined and fixed on this type.
 boolean getIsBounded()
          Fundamental Facet: [Definition:] A datatype is bounded if its value space has either an inclusive upper bound or an exclusive upper bound and either an inclusive lower bound and an exclusive lower bound.
 boolean getIsDefinedFacet(short facetName)
          {Facets} Check whether a facet is defined on this type.
 boolean getIsFinite()
          Fundamental Facet: [Definition:] Every value space has associated with it the concept of cardinality.
 boolean getIsFixedFacet(short facetName)
          {Facets} Check whether a facet is defined and fixed on this type.
 boolean getIsNumeric()
          Fundamental Facet: [Definition:] A datatype is said to be numeric if its values are conceptually quantities (in some mathematical number system).
 XSSimpleTypeDefinition getItemType()
          If variety is list the item type definition (an atomic or union simple type definition) is available, otherwise null.
 StringList getLexicalEnumerations()
          Returns a list of enumeration values, as String's.
 java.lang.String getLexicalFacetValue(short facetName)
          Convenience method.
 StringList getLexicalPatterns()
          Returns a list of pattern values, as String's.
 XSObjectList getMemberTypes()
          If variety is union the list of member type definitions (a non-empty sequence of simple type definitions) is available, otherwise null.
 short getOrdered()
          Fundamental Facet: [Definition:] An order relation on a value space is a mathematical relation that imposes a total order or a partial order on the members of the value space.
 XSSimpleTypeDefinition getPrimitiveType()
          If variety is atomic the primitive type definition (a built-in primitive datatype definition or the simple ur-type definition) is available, otherwise null.
 short getVariety()
          {variety} One of {atomic, list, union}.
 
Methods inherited from interface org.apache.xerces.impl.xs.psvi.XSTypeDefinition
getBaseType, getFinal, getIsAnonymous, getIsFinal, getTypeCategory
 
Methods inherited from interface org.apache.xerces.impl.xs.psvi.XSObject
getName, getNamespace, getType
 

Field Detail

VARIETY_ABSENT

public static final short VARIETY_ABSENT
XSSimpleType variety

See Also:
Constant Field Values

VARIETY_ATOMIC

public static final short VARIETY_ATOMIC
XSSimpleType variety

See Also:
Constant Field Values

VARIETY_LIST

public static final short VARIETY_LIST
XSSimpleType variety

See Also:
Constant Field Values

VARIETY_UNION

public static final short VARIETY_UNION
XSSimpleType variety

See Also:
Constant Field Values

ORDERED_FALSE

public static final short ORDERED_FALSE
not ordered

See Also:
Constant Field Values

ORDERED_PARTIAL

public static final short ORDERED_PARTIAL
partically ordered

See Also:
Constant Field Values

ORDERED_TOTAL

public static final short ORDERED_TOTAL
totally ordered

See Also:
Constant Field Values

FACET_NONE

public static final short FACET_NONE
none

See Also:
Constant Field Values

FACET_LENGTH

public static final short FACET_LENGTH
4.3.1 Length

See Also:
Constant Field Values

FACET_MINLENGTH

public static final short FACET_MINLENGTH
4.3.2 minLength.

See Also:
Constant Field Values

FACET_MAXLENGTH

public static final short FACET_MAXLENGTH
4.3.3 maxLength.

See Also:
Constant Field Values

FACET_PATTERN

public static final short FACET_PATTERN
4.3.4 pattern.

See Also:
Constant Field Values

FACET_ENUMERATION

public static final short FACET_ENUMERATION
4.3.5 enumeration.

See Also:
Constant Field Values

FACET_WHITESPACE

public static final short FACET_WHITESPACE
4.3.6 whitespace.

See Also:
Constant Field Values

FACET_MAXINCLUSIVE

public static final short FACET_MAXINCLUSIVE
4.3.7 maxInclusive.

See Also:
Constant Field Values

FACET_MAXEXCLUSIVE

public static final short FACET_MAXEXCLUSIVE
4.3.9 maxExclusive.

See Also:
Constant Field Values

FACET_MINEXCLUSIVE

public static final short FACET_MINEXCLUSIVE
4.3.9 minExclusive.

See Also:
Constant Field Values

FACET_MININCLUSIVE

public static final short FACET_MININCLUSIVE
4.3.10 minInclusive.

See Also:
Constant Field Values

FACET_TOTALDIGITS

public static final short FACET_TOTALDIGITS
4.3.11 totalDigits .

See Also:
Constant Field Values

FACET_FRACTIONDIGITS

public static final short FACET_FRACTIONDIGITS
4.3.12 fractionDigits.

See Also:
Constant Field Values
Method Detail

getIsDefinedFacet

public boolean getIsDefinedFacet(short facetName)
{Facets} Check whether a facet is defined on this type.

Parameters:
facetName - The name of the facet.
Returns:
true if the facet is defined; false othereise.

getDefinedFacets

public short getDefinedFacets()
{Facets} Get all facets defined on this type.

Returns:
bit combination of FACET_XXX constants of all defined facets.

getIsFixedFacet

public boolean getIsFixedFacet(short facetName)
{Facets} Check whether a facet is defined and fixed on this type.

Parameters:
facetName - The name of the facet.
Returns:
true if the facet is defined and fixed; false othereise.

getFixedFacets

public short getFixedFacets()
{Facets} Get all facets defined and fixed on this type.

Returns:
bit combination of FACET_XXX constants of all fixed facets.

getLexicalFacetValue

public java.lang.String getLexicalFacetValue(short facetName)
Convenience method. Returns a value of a single constraining facet for this simple type definition. This method must not be used to retrieve values for enumeration and pattern facets.

Parameters:
facetName - The name of the facet, i.e. FACET_LENGTH, FACET_TOTALDIGITS (see XSConstants).To retrieve value for pattern or enumeration, see enumeration and pattern.
Returns:
A value of the facet specified in facetName for this simple type definition or null.

getLexicalEnumerations

public StringList getLexicalEnumerations()
Returns a list of enumeration values, as String's.


getLexicalPatterns

public StringList getLexicalPatterns()
Returns a list of pattern values, as String's.


getOrdered

public short getOrdered()
Fundamental Facet: [Definition:] An order relation on a value space is a mathematical relation that imposes a total order or a partial order on the members of the value space.


getIsFinite

public boolean getIsFinite()
Fundamental Facet: [Definition:] Every value space has associated with it the concept of cardinality. Some value spaces are finite, some are countably infinite while still others could conceivably be uncountably infinite (although no value space defined by this specification is uncountable infinite). A datatype is said to have the cardinality of its value space.


getIsBounded

public boolean getIsBounded()
Fundamental Facet: [Definition:] A datatype is bounded if its value space has either an inclusive upper bound or an exclusive upper bound and either an inclusive lower bound and an exclusive lower bound. Should bounded be of type boolean? Should this facet provide more information (discontinuous)?


getIsNumeric

public boolean getIsNumeric()
Fundamental Facet: [Definition:] A datatype is said to be numeric if its values are conceptually quantities (in some mathematical number system). [Definition:] A datatype whose values are not numeric is said to be non-numeric.


getVariety

public short getVariety()
{variety} One of {atomic, list, union}. The valid constant values defined in XSConstants are UNION, LIST, ATOMIC.


getPrimitiveType

public XSSimpleTypeDefinition getPrimitiveType()
If variety is atomic the primitive type definition (a built-in primitive datatype definition or the simple ur-type definition) is available, otherwise null.


getItemType

public XSSimpleTypeDefinition getItemType()
If variety is list the item type definition (an atomic or union simple type definition) is available, otherwise null.


getMemberTypes

public XSObjectList getMemberTypes()
If variety is union the list of member type definitions (a non-empty sequence of simple type definitions) is available, otherwise null.


getAnnotation

public XSAnnotation getAnnotation()
Optional. Annotation.



Copyright © 1999-2002 Apache XML Project. All Rights Reserved.