com.saxonica.schema
Class UserListType

java.lang.Object
  com.saxonica.schema.SchemaStructure
      com.saxonica.schema.SchemaTypeImpl
          com.saxonica.schema.UserSimpleType
              com.saxonica.schema.UserListType

All Implemented Interfaces:

SerializableSchemaComponent, Serializable, SourceLocator, ListType, SchemaComponent, SchemaType, SimpleType

public class UserListType
extends UserSimpleType
implements ListType

Represents a SimpleType that is a list of a given SimpleType, known as its itemType. A ListType may be a restriction of another ListType; the itemType must either be an AtomicType or a UnionType whose members are not list types.

This class is not used to implement the built-in list types NMTOKENS, ENTITIES, IDREFS.

See Also:

Serialized Form

Field Summary

Fields inherited from interface net.sf.saxon.type.SchemaType

DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION, DERIVE_BY_SUBSTITUTION

Fields inherited from interface net.sf.saxon.type.SchemaComponent

FIXED_UP, INCOMPLETE, INVALID, UNVALIDATED, VALIDATED, VALIDATING

Fields inherited from interface com.saxonica.schema.SerializableSchemaComponent

ALL_COMPOSITOR, ATOMIC_TYPE, ATTRIBUTE_DECL, ATTRIBUTE_GROUP, ATTRIBUTE_GROUP_REF, ATTRIBUTE_USE, ATTRIBUTE_WILDCARD, CHOICE_COMPOSITOR, COMPLEX_TYPE, ELEMENT_DECL, ELEMENT_PARTICLE, ELEMENT_WILDCARD, FACET, KEY, KEYREF, LIST_TYPE, MODEL_GROUP, MODEL_GROUP_REF, NOTATION, SEQUENCE_COMPOSITOR, UNION_TYPE, UNIQUE

Constructor Summary

UserListType(SchemaAwareConfiguration config)
Create a new ListType.

Method Summary

AtomicType	getCommonAtomicType() Get the most specific possible atomic type that all items in this SimpleType belong to
int	getComponentTypeCode() Get a unique number identifying the type of component
SimpleType	getItemType() Returns the simpleType of the items in this ListType.
TypeReference	getItemTypeReference() Get the reference to the item type of the list
SequenceIterator	getTypedValue(CharSequence value, NamespaceResolver resolver, NameChecker nameChecker) Get the typed value of a given input string.
boolean	isAtomicType() Test whether this Simple Type is an atomic type
boolean	isBuiltInType() Determine whether this is a built-in type or a user-defined type
boolean	isListType() Returns true if this type is derived by list, or if it is derived by restriction from a list type, or if it is a union that contains a list as one of its members
boolean	isNamespaceSensitive() Test whether this simple type is namespace-sensitive, that is, whether the item types is derived from xs:QName or xs:NOTATION
void	serialize(SchemaSerializer serializer) Serialize the schema component
void	setItemTypeReference(TypeReference type) Sets the itemType for this ListType (the type of item that instances of this list type contain).
ValidationException	validateContent(CharSequence value, NamespaceResolver nsResolver, NameChecker nameChecker) Check whether a given input string is valid according to this SimpleType

Methods inherited from class com.saxonica.schema.UserSimpleType

analyzeContentExpression, applyWhitespaceNormalization, atomize, checkAgainstFacets, checkTypeDerivationIsOK, getBuiltInBaseType, getFacet, getFacetCollection, getFacetList, getFacets, getFacets, getTypedValue, getWhitespaceAction, isSimpleType, isTypeDerivationOK, isUnionType, setFacetCollection, validate

Methods inherited from class com.saxonica.schema.SchemaTypeImpl

allowsDerivation, containingDeclarationIsElement, getBaseType, getBaseTypeFingerprint, getBaseTypeReference, getBlock, getContainingDeclarationName, getDerivationMethod, getDescription, getDisplayName, getFingerprint, getLocalName, getNameCode, getNamePool, isAnonymousType, isComplexType, isExternalType, isSameType, setBaseTypeReference, setContainingDeclaration, setDerivationMethod, setDerivationMethodName, setFinalProhibitions, setLocalName, setNameCode, setNamePool

Methods inherited from class com.saxonica.schema.SchemaStructure

getColumnNumber, getConfiguration, getFixupStatus, getLineNumber, getPublicId, getSystemId, getValidationStatus, lookForCycles, setConfiguration, setFixupStatus, setLineNumber, setLocator, setSystemId, setValidationStatus

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.saxon.type.SimpleType

getBuiltInBaseType, getWhitespaceAction, isExternalType, isUnionType

Methods inherited from interface net.sf.saxon.type.SchemaType

allowsDerivation, analyzeContentExpression, atomize, checkTypeDerivationIsOK, getBaseType, getBlock, getDerivationMethod, getDescription, getDisplayName, getFingerprint, getNameCode, getTypedValue, isAnonymousType, isComplexType, isSameType, isSimpleType

Methods inherited from interface net.sf.saxon.type.SchemaComponent

getValidationStatus

Constructor Detail

UserListType

public UserListType(SchemaAwareConfiguration config)

Create a new ListType.

Method Detail

isAtomicType

public boolean isAtomicType()

Test whether this Simple Type is an atomic type

Specified by:

isAtomicType in interface SchemaType

Specified by:

isAtomicType in interface SimpleType

Overrides:

isAtomicType in class UserSimpleType

Returns:

false, this is not an atomic type

isBuiltInType

public boolean isBuiltInType()

Determine whether this is a built-in type or a user-defined type

Specified by:

isBuiltInType in interface SimpleType

isListType

public boolean isListType()

Returns true if this type is derived by list, or if it is derived by restriction from a list type, or if it is a union that contains a list as one of its members

Specified by:

isListType in interface SimpleType

Overrides:

isListType in class UserSimpleType

Returns:

true if this is a list type

getItemTypeReference

public TypeReference getItemTypeReference()

Get the reference to the item type of the list

getItemType

public SimpleType getItemType()
                       throws UnresolvedReferenceException

Returns the simpleType of the items in this ListType. This method assumes that the item type has been fully resolved

Specified by:

getItemType in interface ListType

Returns:

the simpleType of the items in this ListType.

Throws:

UnresolvedReferenceException - if the item type has not been fully resolved

getCommonAtomicType

public AtomicType getCommonAtomicType()

Get the most specific possible atomic type that all items in this SimpleType belong to

Specified by:

getCommonAtomicType in interface SimpleType

Returns:

the lowest common supertype of all member types

setItemTypeReference

public void setItemTypeReference(TypeReference type)
                          throws SchemaException

Sets the itemType for this ListType (the type of item that instances of this list type contain). For internal use only.

Parameters:

type - the SimpleType for this ListType.

Throws:

SchemaException

validateContent

public ValidationException validateContent(CharSequence value,
                                           NamespaceResolver nsResolver,
                                           NameChecker nameChecker)

Check whether a given input string is valid according to this SimpleType

Specified by:

validateContent in interface SimpleType

Parameters:

value - the input string to be checked

nsResolver - a namespace resolver used to resolve namespace prefixes if the type is namespace sensitive. The value supplied may be null; in this case any namespace-sensitive content will throw an UnsupportedOperationException.

nameChecker -

Returns:

null if validation succeeds; return a ValidationException describing the validation failure if validation fails, unless throwException is true, in which case the exception is thrown rather than being returned.

Throws:

UnsupportedOperationException - if the type is namespace-sensitive and no namespace resolver is supplied

getTypedValue

public SequenceIterator getTypedValue(CharSequence value,
                                      NamespaceResolver resolver,
                                      NameChecker nameChecker)
                               throws ValidationException

Get the typed value of a given input string. This method assumes that the input value is valid according to this SimpleType

Specified by:

getTypedValue in interface SimpleType

Parameters:

value - the string whose typed value is required

resolver -

nameChecker -

Returns:

an iterator over the atomic sequence comprising the typed value. The objects returned by this SequenceIterator will all be of type AtomicValue

Throws:

ValidationException - if the supplied value is not in the lexical space of the data type

isNamespaceSensitive

public boolean isNamespaceSensitive()

Test whether this simple type is namespace-sensitive, that is, whether the item types is derived from xs:QName or xs:NOTATION

Specified by:

isNamespaceSensitive in interface SimpleType

Returns:

true if the item type is derived from xs:QName or xs:NOTATION

serialize

public void serialize(SchemaSerializer serializer)
               throws IOException

Serialize the schema component

Specified by:

serialize in interface SerializableSchemaComponent

Throws:

IOException

getComponentTypeCode

public int getComponentTypeCode()

Get a unique number identifying the type of component

Specified by:

getComponentTypeCode in interface SerializableSchemaComponent