Class UserUnionType

All Implemented Interfaces:
SerializableSchemaComponent, UserSchemaComponent, SourceLocator, Location, CastingTarget, HyperType, ItemType, PlainType, SchemaComponent, SchemaType, SimpleType, UnionType, 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.

  • Constructor Details

    • UserUnionType

      public UserUnionType(EnterpriseConfiguration config)
      Creates a new Union type.
      Parameters:
      config - the Configuration for this Union (Cannot be null)
  • Method Details

    • getGenre

      public Genre getGenre()
      Get the genre of this item
      Specified by:
      getGenre in interface ItemType
      Returns:
      the genre
    • getStructuredQName

      public StructuredQName getStructuredQName()
      Get the name of the type as a StructuredQName
      Specified by:
      getStructuredQName in interface SchemaType
      Specified by:
      getStructuredQName in interface UnionType
      Overrides:
      getStructuredQName in class UserDefinedType
      Returns:
      a StructuredQName identifying the type. In the case of an anonymous type, an internally-generated name is returned
    • setMemberTypeReferences

      public void setMemberTypeReferences(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 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
    • getBasicAlphaCode

      public String getBasicAlphaCode()
      Get an alphabetic code representing the type, or at any rate, the nearest built-in type from which this type is derived. The codes are designed so that for any two built-in types A and B, alphaCode(A) is a prefix of alphaCode(B) if and only if A is a supertype of B.
      Specified by:
      getBasicAlphaCode in interface ItemType
      Returns:
      the alphacode for the nearest containing built-in 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 HyperType
      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 - if the definition is invalid
    • 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(Stack<SchemaComponent> references, SchemaCompiler compiler) throws SchemaException
      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 - if cycles are found
    • validateContent

      public ValidationFailure validateContent(UnicodeString 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:
      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(UnicodeString value, NamespaceResolver resolver, ConversionRules rules) throws ValidationException
      Description copied from interface: UnionType
      Get the typed value corresponding to a given string value, assuming it is valid against this type
      Specified by:
      getTypedValue in interface SimpleType
      Specified by:
      getTypedValue in interface UnionType
      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:
      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
    • serializeVariety

      protected 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 - The type hierarchy
      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(TypeHierarchy th)
      Description copied from interface: ItemType
      Ask whether values of this type are atomizable
      Specified by:
      isAtomizable in interface ItemType
      Parameters:
      th - the type hierarchy cache
      Returns:
      true if some or all instances of this type can be successfully atomized; false if no instances of this type can be atomized
    • getPlainMemberTypes

      public List<? extends 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
    • getDefaultPriority

      public double getDefaultPriority()
      Get the default priority when this ItemType is used as an XSLT pattern
      Specified by:
      getDefaultPriority in interface ItemType
      Returns:
      the default priority. For a union type this is defined as the product of the default priorities of the member types. Because the priorities of member types are in the range 0 to 1, their product is also in the range 0 to 1.
    • toString

      public String toString()
      Produce a string representation of the type name. If the type is anonymous, an internally-allocated type name will be returned.
      Overrides:
      toString in class UserDefinedType
      Returns:
      the name of the atomic type in the form Q{uri}local
    • toExportString

      public String toExportString()
      Description copied from interface: ItemType
      Return a string representation of this ItemType suitable for use in stylesheet export files. This differs from the result of toString() in that it will not contain any references to anonymous types. Note that it may also use the Saxon extended syntax for union types and tuple types. The default implementation returns the result of calling toString().
      Specified by:
      toExportString in interface ItemType
      Returns:
      the string representation as an instance of the XPath SequenceType construct
    • getDescription

      public 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
      Specified by:
      getDescription in interface UnionType
      Overrides:
      getDescription in class UserDefinedType
      Returns:
      text identifing the type, for use in a phrase such as "the type XXXX".