com.saxonica.ee.schema

Class UserUnionType

java.lang.Object

com.saxonica.ee.schema.SchemaStructure

com.saxonica.ee.schema.UserDefinedType

com.saxonica.ee.schema.UserSimpleType

com.saxonica.ee.schema.UserUnionType

All Implemented Interfaces:

SerializableSchemaComponent, UserSchemaComponent, javax.xml.transform.SourceLocator, Location, ItemType, PlainType, SchemaComponent, SchemaType, SimpleType, UnionType, org.xml.sax.Locator

public class UserUnionType
extends UserSimpleType
implements PlainType, UnionType

A class that represents the XML Schema simple-type with variety union.

A "plain" union is a union that is not derived by restriction and whose member types are all either atomic types or plain union types. Only plain union types can be named in the XPath SequenceType production. (All union types, however, can act as the target of a cast expression). This class implements the interface PlainType despite the fact that not all its instances represent plain unions; to test whether a union is a plain union, use the isPlainType() method.

Nested Class Summary

Nested classes/interfaces inherited from interface net.sf.saxon.type.ItemType

ItemType.WithSequenceTypeCache

Field Summary

Fields inherited from class com.saxonica.ee.schema.UserDefinedType

extendedTypes, finalProhibitions

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

COMPONENT_FUNCTION_TYPE, FIXED_UP, INCOMPLETE, INVALID, UNVALIDATED, VALIDATED, VALIDATING

Constructor Summary

Constructors

Constructor and Description
UserUnionType(EnterpriseConfiguration config) Creates a new Union type.

Method Summary

Modifier and Type	Method and Description
void	addMemberTypeReference(TypeReference member) Add a member type to the list of member types
ValidationFailure	checkAgainstFacets(AtomicValue value, ConversionRules rules) Validate an atomic value, which is known to be an instance of one of the member types of the union, against any facets (pattern facets or enumeration facets) defined at the level of the union itself.
boolean	containsListType() Ask whether this union type includes any list types among its members
void	elaborate(SchemaCompiler compiler) Elaborate the schema component: after reloading a serialized schema component model, this expands the component with derived information needed during validation episodes.
java.lang.String	generateJavaScriptItemTypeAcceptor(java.lang.String errorCode, int targetVersion) Generate Javascript code to convert a supplied Javascript value to this item type, if conversion is possible, or throw an error otherwise.
java.lang.String	generateJavaScriptItemTypeTest(ItemType knownToBe, int targetVersion) Generate Javascript code to test whether an item conforms to this item type
PlainType	getAtomizedItemType() Get the item type of the atomic values that will be produced when an item of this type is atomized
java.lang.String	getDescription() Get a description of this type for use in diagnostics.
java.util.List<TypeReference>	getMemberTypeReferences() Get the list of member types
java.lang.Iterable<PlainType>	getPlainMemberTypes() Get the list of plain types that are subsumed by this type
AtomicType	getPrimitiveItemType() Method defined in ItemType: get a primitive supertype in the ItemType type hierarchy
int	getPrimitiveType() Method defined in ItemType: get a primitive supertype in the ItemType type hierarchy
SequenceType	getResultTypeOfCast() Get the SequenceType that most accurately describes the result of casting a value to this union type
AtomicSequence	getTypedValue(java.lang.CharSequence value, NamespaceResolver resolver, ConversionRules rules) Get the typed value corresponding to a given string value, assuming it is valid against this type
StructuredQName	getTypeName() Get the name of this type as a structured QName
UType	getUType() Get the corresponding UType.
boolean	isAtomicType() Ask whether this Simple Type is an atomic type
boolean	isAtomizable() Ask whether values of this type are atomizable
boolean	isBuiltInType() Determine whether this is a built-in type or a user-defined type
boolean	isIdRefType() Ask whether this type is an IDREF or IDREFS type.
boolean	isIdType() Ask whether this type is an ID type.
boolean	isListType() Determine whether this is a list type
boolean	isNamespaceSensitive() Test whether this type is namespace sensitive, that is, if a namespace context is needed to translate between the lexical space and the value space.
boolean	isPlainType() Ask whether this Union type is a "plain type", defined as a union type whose member types are all atomic types or plain unions.
boolean	isUnionType() Return true if this type is a union type (that is, if its variety is union)
void	lookForCycles(java.util.Stack references, SchemaCompiler compiler) This method is called to look for cycles.
boolean	matches(Item item, TypeHierarchy th) Test whether a given item conforms to this type
void	serializeVariety(SchemaModelSerializer serializer) Serialize the schema component
void	setMemberTypeReferences(java.util.List<TypeReference> members) Set the member types of this union type.
java.lang.String	toExportString() Return a string representation of this SequenceType suitable for use in export (SEF) files.
java.lang.String	toString() Produce a string representation of the type name.
boolean	validate(SchemaCompiler compiler) Validate this Union, replacing all unresolved forwards references at the same time
ValidationFailure	validateContent(java.lang.CharSequence value, NamespaceResolver nsResolver, ConversionRules rules) Check whether a given input string is valid according to this SimpleType
void	visitNamedSchemaComponents(SchemaComponentVisitor visitor) Visit all the schema components used in this ItemType definition

Methods inherited from class com.saxonica.ee.schema.UserSimpleType

addFacet, addInheritedFacets, analyzeContentExpression, applyWhitespaceNormalization, atomize, checkAgainstFacets, checkTypeDerivationIsOK, convertFacetValues, getBuiltInBaseType, getComponentAsFunction, getComponentAsFunction, getContextComponent, getEQName, getExtendedFacetList, getFacet, getLocalFacetList, getWhitespaceAction, isSimpleType, isTypeDerivationOK, makeValidationFailure, mergeEnumerationFacets, postprocess, preprocess, serialize, setContextComponent, setFacetList

Methods inherited from class com.saxonica.ee.schema.UserDefinedType

allowsDerivation, containingDeclarationIsElement, getBaseType, getBaseTypeFingerprint, getBaseTypeReference, getBlock, getContainingDeclarationName, getDerivationMethod, getDisplayName, getExtensionTypes, getFinalProhibitions, getFingerprint, getName, getNamePool, getStructuredQName, getTargetNamespace, isAnonymousType, isComplexType, isExternalType, isSameType, isSameURI, registerExtensionType, setBaseTypeReference, setContainingDeclaration, setDerivationMethod, setDerivationMethodName, setExtendedTypes, setFinalProhibitions, setTypeName

Methods inherited from class com.saxonica.ee.schema.SchemaStructure

fixup, getColumnNumber, getConfiguration, getFixupStatus, getGeneratedId, getLineNumber, getPublicId, getRedefinitionLevel, getSchemaDocumentURI, getSystemId, getValidationStatus, hasSameLocation, makeXPathExpressionPropertyRecord, saveLocation, setConfiguration, setFixupStatus, setGeneratedId, setLineNumber, setLocator, setRedefinitionLevel, setSchemaDocumentURI, setSystemId, setValidationStatus

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

isExternalType

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

getBuiltInBaseType, getWhitespaceAction, isExternalType, postprocess, preprocess

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

allowsDerivation, analyzeContentExpression, atomize, checkTypeDerivationIsOK, getBaseType, getBlock, getDerivationMethod, getDisplayName, getEQName, getFinalProhibitions, getFingerprint, getName, getStructuredQName, getSystemId, getTargetNamespace, isAnonymousType, isComplexType, isSameType, isSimpleType

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

getComponentAsFunction, getRedefinitionLevel, getValidationStatus

Methods inherited from interface com.saxonica.ee.schema.UserSchemaComponent

fixup

Constructor Detail

UserUnionType

public UserUnionType(EnterpriseConfiguration config)

Creates a new Union type.

Parameters:

config - the Configuration for this Union (Cannot be null)

Method Detail

getTypeName

public StructuredQName getTypeName()

Description copied from interface: PlainType

Get the name of this type as a structured QName

Specified by:

getTypeName in interface PlainType

Returns:

the name of this type. If the type is anonymous, an internally-generated type name is returned

setMemberTypeReferences

public void setMemberTypeReferences(java.util.List<TypeReference> members)

Set the member types of this union type.

Parameters:

members - a list of TypeReference objects

addMemberTypeReference

public void addMemberTypeReference(TypeReference member)

Add a member type to the list of member types

Parameters:

member - a reference to a new member type

getMemberTypeReferences

public java.util.List<TypeReference> getMemberTypeReferences()

Get the list of member types

Returns:

a List containing TypeReference objects

isAtomicType

public boolean isAtomicType()

Ask whether this Simple Type is an atomic type

Specified by:

isAtomicType in interface ItemType

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

containsListType

public boolean containsListType()
                         throws MissingComponentException

Ask whether this union type includes any list types among its members

Specified by:

containsListType in interface UnionType

Returns:

true of one of the member types is a list type

Throws:

MissingComponentException

isPlainType

public boolean isPlainType()

Ask whether this Union type is a "plain type", defined as a union type whose member types are all atomic types or plain unions. That is, it disallows unions that are derived by restriction from another union. The significance of this is that an atomic value will never match a non-plain union type

Specified by:

isPlainType in interface ItemType

Returns:

true if this is ANY_ATOMIC_TYPE or a subtype thereof, or a "plain" union type (that is, unions of atomic types that impose no further restrictions). Return false if this is a union type whose member types are not all known.

getResultTypeOfCast

public SequenceType getResultTypeOfCast()

Get the SequenceType that most accurately describes the result of casting a value to this union type

Specified by:

getResultTypeOfCast in interface UnionType

Returns:

the most precise SequenceType for the result of casting

isIdType

public boolean isIdType()
                 throws MissingComponentException

Ask whether this type is an ID type. This is defined to be any simple type who typed value may contain atomic values of type xs:ID: that is, it includes types derived from ID by restriction, list, or union. Note that for a node to be treated as an ID in XSD 1.0, its typed value must be a *single* atomic value of type ID; the type of the node, however, can still allow a list or union. This changes in XSD 1.1, where a list of IDs is allowed.

Specified by:

isIdType in interface SchemaType

Overrides:

isIdType in class UserSimpleType

Returns:

true if this type is an ID type

Throws:

MissingComponentException

isIdRefType

public boolean isIdRefType()
                    throws MissingComponentException

Ask whether this type is an IDREF or IDREFS type. This is defined to be any simple type who typed value may contain atomic values of type xs:IDREF: that is, it includes types derived from IDREF or IDREFS by restriction, list, or union

Specified by:

isIdRefType in interface SchemaType

Overrides:

isIdRefType in class UserSimpleType

Returns:

true if this type is an IDREF type

Throws:

MissingComponentException

isBuiltInType

public boolean isBuiltInType()

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

Specified by:

isBuiltInType in interface SimpleType

Returns:

true if this is a built-in type

isListType

public boolean isListType()

Determine whether this is a list type

Specified by:

isListType in interface SimpleType

Overrides:

isListType in class UserSimpleType

Returns:

true if this is a list type

isUnionType

public boolean isUnionType()

Return true if this type is a union type (that is, if its variety is union)

Specified by:

isUnionType in interface SimpleType

Overrides:

isUnionType in class UserSimpleType

Returns:

true for a union type

getUType

public UType getUType()

Get the corresponding UType. A UType is a union of primitive item types.

Specified by:

getUType in interface ItemType

Returns:

the smallest UType that subsumes this item type

isNamespaceSensitive

public boolean isNamespaceSensitive()

Test whether this type is namespace sensitive, that is, if a namespace context is needed to translate between the lexical space and the value space. This is true for types derived from, or containing, QNames and NOTATIONs

Specified by:

isNamespaceSensitive in interface SimpleType

Returns:

true if any of the member types is namespace-sensitive, or if namespace sensitivity cannot be determined because there are components missing from the schema.

validate

public boolean validate(SchemaCompiler compiler)
                 throws SchemaException

Validate this Union, replacing all unresolved forwards references at the same time

Specified by:

validate in interface UserSchemaComponent

Overrides:

validate in class UserSimpleType

Parameters:

compiler - used for error reporting

Returns:

true when this Schema definition is valid, otherwise false.

Throws:

SchemaException

elaborate

public void elaborate(SchemaCompiler compiler)
               throws SchemaException

Description copied from class: UserSimpleType

Elaborate the schema component: after reloading a serialized schema component model, this expands the component with derived information needed during validation episodes. The model is assumed to be valid.

Specified by:

elaborate in interface UserSchemaComponent

Overrides:

elaborate in class UserSimpleType

Parameters:

compiler - the schema compiler

Throws:

SchemaException - if a fatal error occurs

lookForCycles

public void lookForCycles(java.util.Stack references,
                          SchemaCompiler compiler)
                   throws SchemaException,
                          MissingComponentException

This method is called to look for cycles. The object implementing this method is required (a) to raise an exception if the object itself appears in the list of references, (b) to add itself to the list of references, and (c) to call the lookForCycles method on all the objects that it references.

Specified by:

lookForCycles in interface UserSchemaComponent

Overrides:

lookForCycles in class SchemaStructure

Parameters:

references - A list of objects that contain direct or indirect references to this object, and that must therefore not be referred to from this object.

compiler - used for error reporting

Throws:

SchemaException

MissingComponentException

validateContent

public ValidationFailure validateContent(java.lang.CharSequence value,
                                         NamespaceResolver nsResolver,
                                         ConversionRules rules)

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.

rules - the configuration-wide conversion rules

Returns:

null if validation succeeds; return a ValidationFailure describing the validation failure if validation fails

Throws:

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

checkAgainstFacets

public ValidationFailure checkAgainstFacets(AtomicValue value,
                                            ConversionRules rules)

Validate an atomic value, which is known to be an instance of one of the member types of the union, against any facets (pattern facets or enumeration facets) defined at the level of the union itself.

Specified by:

checkAgainstFacets in interface UnionType

Parameters:

value - the Atomic Value to be checked. This must be an instance of a member type of the union

rules - the ConversionRules for the Configuration

Returns:

a ValidationFailure if the value is not valid; null if it is valid.

getTypedValue

public AtomicSequence getTypedValue(java.lang.CharSequence value,
                                    NamespaceResolver resolver,
                                    ConversionRules rules)
                             throws ValidationException

Description copied from interface: SimpleType

Get the typed value corresponding to a given string value, assuming it is valid against this type

Specified by:

getTypedValue in interface SimpleType

Parameters:

value - the string value

resolver - a namespace resolver used to resolve any namespace prefixes appearing in the content of values. Can supply null, in which case any namespace-sensitive content will be rejected.

rules - the conversion rules from the configuration

Returns:

an iterator over the atomic sequence comprising the typed value. The objects returned by this SequenceIterator will all be of type AtomicValue, The next() method on the iterator throws no checked exceptions, although it is not actually declared as an UnfailingIterator.

Throws:

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

serializeVariety

public void serializeVariety(SchemaModelSerializer serializer)
                      throws XPathException

Serialize the schema component

Specified by:

serializeVariety in class UserSimpleType

Throws:

XPathException

matches

public boolean matches(Item item,
                       TypeHierarchy th)

Test whether a given item conforms to this type

Specified by:

matches in interface ItemType

Specified by:

matches in interface PlainType

Parameters:

item - The item to be tested

th -

Returns:

true if the item is an instance of this type; false otherwise

getPrimitiveItemType

public AtomicType getPrimitiveItemType()

Method defined in ItemType: get a primitive supertype in the ItemType type hierarchy

Specified by:

getPrimitiveItemType in interface ItemType

Specified by:

getPrimitiveItemType in interface PlainType

Returns:

BuiltInAtomicType.ANY_ATOMIC

getPrimitiveType

public int getPrimitiveType()

Method defined in ItemType: get a primitive supertype in the ItemType type hierarchy

Specified by:

getPrimitiveType in interface ItemType

Returns:

StandardNames.XS_ANY_ATOMIC_TYPE

getAtomizedItemType

public PlainType getAtomizedItemType()

Description copied from interface: ItemType

Get the item type of the atomic values that will be produced when an item of this type is atomized

Specified by:

getAtomizedItemType in interface ItemType

Returns:

the best available item type of the atomic values that will be produced when an item of this type is atomized, or null if it is known that atomization will throw an error.

isAtomizable

public boolean isAtomizable()

Description copied from interface: ItemType

Ask whether values of this type are atomizable

Specified by:

isAtomizable in interface ItemType

Returns:

true unless it is known that these items will be elements with element-only content, or function items, in which case return false

visitNamedSchemaComponents

public void visitNamedSchemaComponents(SchemaComponentVisitor visitor)
                                throws XPathException

Description copied from interface: ItemType

Visit all the schema components used in this ItemType definition

Specified by:

visitNamedSchemaComponents in interface ItemType

Parameters:

visitor - the visitor class to be called when each component is visited

Throws:

XPathException - if an error occurs

getPlainMemberTypes

public java.lang.Iterable<PlainType> getPlainMemberTypes()
                                                  throws MissingComponentException

Get the list of plain types that are subsumed by this type

Specified by:

getPlainMemberTypes in interface PlainType

Specified by:

getPlainMemberTypes in interface UnionType

Returns:

for an atomic type, the type itself; for a plain union type, the list of plain types in its transitive membership, in declaration order

Throws:

MissingComponentException

toString

public java.lang.String toString()

Produce a string representation of the type name. If the type is anonymous, an internally-allocated type name will be returned.

Specified by:

toString in interface ItemType

Overrides:

toString in class UserDefinedType

Returns:

the name of the atomic type in the form Q{uri}local

toExportString

public java.lang.String toExportString()

Return a string representation of this SequenceType suitable for use in export (SEF) files. The difference from the toString() method is that the representation will not contain references to anonymous types.

Specified by:

toExportString in interface ItemType

Returns:

the string representation as an instance of the XPath SequenceType construct, using only names that will be in-scope if the target environment imports the same schema as the source environment

getDescription

public java.lang.String getDescription()

Get a description of this type for use in diagnostics. In the case of a named type, this is the same as the display name. In the case of a type known to be defined immediately within an element or attribute declaration, it is a phrase that identifies the containing declaration. In other cases, it is a phrase of the form "defined at line L of URI". The description is designed to be inserted in a context such as "the type X is ..."

Specified by:

getDescription in interface SchemaType

Overrides:

getDescription in class UserDefinedType

Returns:

text identifing the type, for use in a phrase such as "the type XXXX".

generateJavaScriptItemTypeTest

public java.lang.String generateJavaScriptItemTypeTest(ItemType knownToBe,
                                                       int targetVersion)
                                                throws XPathException

Generate Javascript code to test whether an item conforms to this item type

Specified by:

generateJavaScriptItemTypeTest in interface ItemType

Overrides:

generateJavaScriptItemTypeTest in class UserSimpleType

Parameters:

knownToBe -

targetVersion -

Returns:

a Javascript instruction or sequence of instructions, which can be used as the body of a Javascript function, and which returns a boolean indication whether the value of the variable "item" is an instance of this item type.

Throws:

XPathException - if JS code cannot be generated for this item type, for example because the test is schema-aware.

generateJavaScriptItemTypeAcceptor

public java.lang.String generateJavaScriptItemTypeAcceptor(java.lang.String errorCode,
                                                           int targetVersion)
                                                    throws XPathException

Generate Javascript code to convert a supplied Javascript value to this item type, if conversion is possible, or throw an error otherwise.

Specified by:

generateJavaScriptItemTypeAcceptor in interface ItemType

Overrides:

generateJavaScriptItemTypeAcceptor in class UserSimpleType

Parameters:

errorCode - the error to be thrown if conversion is not possible

targetVersion - the version of Saxon-JS for which code is to be generated

Returns:

a Javascript instruction or sequence of instructions, which can be used as the body of a Javascript function, and which returns the result of conversion to this type, or throws an error if conversion is not possible. The variable "val" will hold the supplied Javascript value.

Throws:

XPathException