Package org.rumbledb.types

Interface ItemType

All Superinterfaces:
com.esotericsoftware.kryo.KryoSerializable, Serializable
All Known Implementing Classes:
ArrayItemType, AtomicItemType, AttributeNodeItemType, DerivedAtomicItemType, DocumentNodeItemType, ElementNodeItemType, FunctionItemType, ItemItemType, ItemTypeReference, JsonItemType, MapItemType, NeutralItemType, NodeItemType, ObjectItemType, PINodeItemType, UnionItemType, XmlNodeItemType, XQueryArrayItemType
public interface ItemType extends Serializable, com.esotericsoftware.kryo.KryoSerializable

  • Field Details

  • Method Details

    • equals

      boolean equals(Object other)
      Tests for itemType equality.
      Overrides:
      equals in class Object
      Parameters:
      other - another object.
      Returns:
      true it is equal to other, false otherwise.

    • isEqualTo

      default boolean isEqualTo(ItemType otherType)
      Tests for itemType equality.
      Parameters:
      otherType - another item type.
      Returns:
      true it is equal to other, false otherwise.

    • isTopmostItemType

      default boolean isTopmostItemType()
      Returns:
      true it [this] is the topmost item type.

    • isAtomicItemType

      default boolean isAtomicItemType()
      Returns:
      true it [this] is a subtype of an atomic item type.

    • isObjectItemType

      default boolean isObjectItemType()
      Returns:
      true it [this] is an object item type.

    • isArrayItemType

      default boolean isArrayItemType()
      Returns:
      true it [this] is an array item type.

    • isXQueryArrayItemType

      default boolean isXQueryArrayItemType()
      Returns:
      true it [this] is an XQuery array item type.

    • isMapItemType

      default boolean isMapItemType()
      Returns:
      true if [this] is an XQuery map item type (map(*) or map(K, V)).

    • isJsonItemType

      default boolean isJsonItemType()
      Returns:
      test if [this] is a subptype of a json item type

    • isNodeItemType

      default boolean isNodeItemType()
      Returns:
      true if [this] is a node item type (node() or any of its 7 concrete subtypes).

    • isUnionType

      default boolean isUnionType()

    • isFunctionItemType

      default boolean isFunctionItemType()
      Returns:
      true it [this] is a function item type.

    • isNumeric

      default boolean isNumeric()
      Returns:
      [true] if this is a numeric item type, false otherwise

    • hasName

      default boolean hasName()
      Tests for QName.
      Returns:
      true if [this] item type has a QName

    • getName

      default Name getName()
      Returns:
      the itemtype QName if available

    • getSignature

      default FunctionSignature getSignature()
      Returns:
      the signature of the function item type if available

    • isSubtypeOf

      default boolean isSubtypeOf(ItemType superType)
      Parameters:
      superType - another item type
      Returns:
      true if [this] is a subtype of [superType], any type is considered a subtype of itself. If [this] has a name, then this is determined strictly based on the hierarchy. If [this] does not have a name, then this is determined based on facets.

    • findLeastCommonSuperTypeWith

      default ItemType findLeastCommonSuperTypeWith(ItemType other)
      Parameters:
      other - another item type
      Returns:
      the common supertype between [this] and [other], that would be the LCA in the item type tree of [this] and [other] (does not take into account union types as common ancestor, but only the type tree)

    • findLeastCommonSuperTypeLax

      default ItemType findLeastCommonSuperTypeLax(ItemType other)
      Finds a lax (non-strict) common supertype that can incorporate anonymous facets when possible. The default implementation falls back to the strict least-common-supertype logic.
      Parameters:
      other - another item type
      Returns:
      a lax common supertype between [this] and [other]

    • getTypeTreeDepth

      int getTypeTreeDepth()
      Returns:
      an int representing the depth of the item type in the type tree ('item' is the root with depth 0)

    • getBaseType

      ItemType getBaseType()
      Returns:
      the base type for a type, return null for the topmost item type

    • isStaticallyCastableAs

      default boolean isStaticallyCastableAs(ItemType other)
      Check at static time if [this] could be casted to [other] item type, requires [this] to be an atomic type
      Parameters:
      other - a strict subtype of atomic item type to which we are trying to cast
      Returns:
      true if it is possible at static time to cast [this] to [other], false otherwise

    • canBePromotedTo

      default boolean canBePromotedTo(ItemType itemType)
      Parameters:
      itemType - another item type
      Returns:
      true if [this] can be promoted to [itemType]

    • isUserDefined

      default boolean isUserDefined()
      Returns:
      [true] if it is a user-defined type, false otherwise

    • isPrimitive

      default boolean isPrimitive()
      Returns:
      [true] if it is a primitive type

    • isCastingPrimitive

      default boolean isCastingPrimitive()
      Casting-specific primitive notion from XPath/XQuery Functions and Operators 3.1 §19: in addition to XML Schema primitive types, xs:integer, xs:yearMonthDuration, and xs:dayTimeDuration are treated as primitive for casting.
      Returns:
      [true] if this type is considered primitive for casting semantics.

    • getPrimitiveType

      default ItemType getPrimitiveType()
      Returns:
      the primitive type for a derived type, throw an error for primitive types

    • getCastingPrimitiveType

      default ItemType getCastingPrimitiveType()
      Casting-specific primitive normalization used by cast/castable logic.
      Returns:
      this type if it is a casting primitive; otherwise its casting primitive ancestor.

    • getAllowedFacets

      Set<ConstrainingFacetTypes> getAllowedFacets()
      Returns:
      a set containing the allowed facets for restricting the type

    • getEnumerationFacet

      default List<Item> getEnumerationFacet()
      Returns:
      the list of possible values for [this] item type or null if the enumeration facet is not set

    • getConstraintsFacet

      default List<String> getConstraintsFacet()
      Returns:
      the list of constraints in the implementation-defined language for [this] item type (note that this facet is cumulative) or an empty list if the constraints facet is not set

    • getMinLengthFacet

      default Integer getMinLengthFacet()
      Returns:
      the minimum length facet value for [this] item type or null if the restriction is not set

    • getLengthFacet

      default Integer getLengthFacet()
      Returns:
      the length facet value for [this] item type or null if the restriction is not set

    • getMaxLengthFacet

      default Integer getMaxLengthFacet()
      Returns:
      the maximum length facet value for [this] item type or null if the restriction is not set

    • getMinExclusiveFacet

      default Item getMinExclusiveFacet()
      Returns:
      an item representing the minimum possible value (excluded) for [this] item type or null if the restriction is not set

    • getMinInclusiveFacet

      default Item getMinInclusiveFacet()
      Returns:
      an item representing the minimum possible value (included) for [this] item type or null if the restriction is not set

    • getMaxExclusiveFacet

      default Item getMaxExclusiveFacet()
      Returns:
      an item representing the maximum possible value (excluded) for [this] item type or null if the restriction is not set

    • getMaxInclusiveFacet

      default Item getMaxInclusiveFacet()
      Returns:
      an item representing the maximum possible value (included) for [this] item type or null if the restriction is not set

    • getTotalDigitsFacet

      default Integer getTotalDigitsFacet()
      Returns:
      the total digits facet value for [this] item type or null if the restriction is not set

    • getFractionDigitsFacet

      default Integer getFractionDigitsFacet()
      Returns:
      the fraction digits facet value for [this] item type or null if the restriction is not set

    • getExplicitTimezoneFacet

      default TimezoneFacet getExplicitTimezoneFacet()
      Returns:
      the explicit timezone facet value for [this] item type or null if the restriction is not set

    • getWhitespaceFacet

      default WhitespaceFacet getWhitespaceFacet()
      Returns:
      the whiteSpace facet value for [this] item type or null if the restriction is not set

    • getPatternFacet

      default List<String> getPatternFacet()
      Returns the pattern facet for this item type. This reflects pattern facets applied via derivation (for example on DerivedAtomicItemType), not the full lexical space of a primitive atomic type.
      Returns:
      the list of pattern regex strings for this derivation step, or null if no pattern restriction is set

    • getLexicalSpacePatterns

      default List<String> getLexicalSpacePatterns()
      Returns the lexical-space patterns for this item type. For primitive atomic types, this describes the lexical space defined by the specification (for example, the allowed literals for xs:boolean or the lexical grammar for xs:decimal). For derived atomic types, this typically delegates to the primitive type. Implementations that do not provide additional constraints should return an empty list.
      Returns:
      a list of regular expressions describing the lexical space of this type, or an empty list if no regex-based restriction is modeled.

    • getOrderedFacet

      default OrderedFacetValue getOrderedFacet()
      Returns:
      the ordered fundamental facet value, or null if not set

    • getBoundedFacet

      default Boolean getBoundedFacet()
      Returns:
      the bounded fundamental facet value, or null if not set

    • getCardinalityFacet

      default CardinalityFacetValue getCardinalityFacet()
      Returns:
      the cardinality fundamental facet value, or null if not set

    • getNumericFacet

      default Boolean getNumericFacet()
      Returns:
      the numeric fundamental facet value, or null if not set

    • getObjectContentFacet

      default Map<String,FieldDescriptor> getObjectContentFacet()
      Returns:
      content facet value for object item types (cumulative facet)

    • getClosedFacet

      default boolean getClosedFacet()
      Returns:
      closed facet value for object item types

    • getArrayContentFacet

      default ItemType getArrayContentFacet()
      Returns:
      content facet value for array item types

    • getMapKeyItemType

      default ItemType getMapKeyItemType()
      Returns:
      atomic key type for map item types (map(K, V)).

    • getMapValueSequenceType

      default SequenceType getMapValueSequenceType()
      Returns:
      value sequence type for map item types (map(K, V)).

    • getMemberSequenceType

      default SequenceType getMemberSequenceType()
      Returns:
      the sequence type for the members of the array item type
      Throws:
      UnsupportedOperationException - if the item type is not an xquery array item type

    • getTypes

      default List<ItemType> getTypes()
      Returns:
      content facet value for union item types

    • getIdentifierString

      default String getIdentifierString()
      Returns:
      a String that uniquely identify an item type

    • isCompatibleWithDataFrames

      default boolean isCompatibleWithDataFrames(RumbleRuntimeConfiguration configuration)
      Checks compatibility with DataFrames.
      Returns:
      true if compatible with DataFrames and false otherwise.

    • getSparkSQLType

      default String getSparkSQLType()
      Returns the SparkSQL type of the item type for use in a query.
      Returns:
      String representing the SparkSQL type of the item type.

    • toString

      String toString()
      Overrides:
      toString in class Object

    • isResolved

      default boolean isResolved()

    • resolve

      default void resolve(DynamicContext context, ExceptionMetadata metadata)

    • resolve

      default void resolve(StaticContext context, ExceptionMetadata metadata)