Package org.rumbledb.types

Class XQueryArrayItemType

java.lang.Object

org.rumbledb.types.AbstractItemType

org.rumbledb.types.XQueryArrayItemType

All Implemented Interfaces:

Serializable, ItemType

public class XQueryArrayItemType
extends AbstractItemType

XQuery/XPath array item type: array(*) and array(T) per XDM 3.1 / XPath 3.1. The primitive array(*) type is modeled as a subtype of function(*) by using BuiltinTypesCatalogue.anyFunctionItem as its base type.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
protected Object	equalityKey()
ItemType	findLeastCommonSuperTypeWith(ItemType other)
Set<ConstrainingFacetTypes>	getAllowedFacets()
ItemType	getBaseType()
String	getIdentifierString()
SequenceType	getMemberSequenceType()
Name	getName()
String	getSparkSQLType()	Returns the SparkSQL type of the item type for use in a query.
int	getTypeTreeDepth()
boolean	hasName()	Tests for QName.
boolean	isCompatibleWithDataFrames(RumbleConfiguration configuration)	Checks compatibility with DataFrames.
boolean	isResolved()
boolean	isSubtypeOf(ItemType superType)
boolean	isXQueryArrayItemType()
void	resolve(DynamicContext context, ExceptionMetadata metadata)
void	resolve(StaticContext context, ExceptionMetadata metadata)
String	toString()

Methods inherited from class org.rumbledb.types.AbstractItemType

equalityKeyOf, equals, hashCode, namedTypeKey, structuralTypeKey

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.rumbledb.types.ItemType

canBeNull, canBePromotedTo, findLeastCommonSuperTypeLax, getArrayContentFacet, getBoundedFacet, getCardinalityFacet, getCastingPrimitiveType, getClosedFacet, getConstraintsFacet, getEnumerationFacet, getExplicitTimezoneFacet, getFractionDigitsFacet, getLengthFacet, getLexicalSpacePatterns, getMapKeyItemType, getMapValueSequenceType, getMaxExclusiveFacet, getMaxInclusiveFacet, getMaxLengthFacet, getMinExclusiveFacet, getMinInclusiveFacet, getMinLengthFacet, getNumericFacet, getObjectContentFacet, getObjectContentFacet, getObjectContentFacetAsUnorderedMap, getObjectKeysFacet, getOrderedFacet, getPatternFacet, getPrimitiveType, getSignature, getSingleNullableType, getTotalDigitsFacet, getTypes, getWhitespaceFacet, isArrayItemType, isAtomicItemType, isCastingPrimitive, isEqualTo, isFunctionItemType, isJsonItemType, isMapItemType, isNodeItemType, isNumeric, isObjectItemType, isPrimitive, isStaticallyCastableAs, isTopmostItemType, isUnionType, isUserDefined

Method Details

isXQueryArrayItemType

public boolean isXQueryArrayItemType()

Returns:

true it [this] is an XQuery array item type.

equalityKey

protected Object equalityKey()

Overrides:

equalityKey in class AbstractItemType

isSubtypeOf

public 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

public 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)

hasName

public boolean hasName()

Description copied from interface: ItemType

Tests for QName.

Returns:

true if [this] item type has a QName

getName

public Name getName()

Returns:

the itemtype QName if available

getTypeTreeDepth

public int getTypeTreeDepth()

Returns:

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

getBaseType

public ItemType getBaseType()

Returns:

the base type for a type, return null for the topmost item type

getMemberSequenceType

public SequenceType getMemberSequenceType()

Returns:

the sequence type for the members of the array item type

resolve

public void resolve(DynamicContext context,
 ExceptionMetadata metadata)

resolve

public void resolve(StaticContext context,
 ExceptionMetadata metadata)

isResolved

public boolean isResolved()

getAllowedFacets

public Set<ConstrainingFacetTypes> getAllowedFacets()

Returns:

a set containing the allowed facets for restricting the type

getIdentifierString

public String getIdentifierString()

Returns:

a String that uniquely identify an item type

toString

public String toString()

Specified by:

toString in interface ItemType

Overrides:

toString in class Object

isCompatibleWithDataFrames

public boolean isCompatibleWithDataFrames(RumbleConfiguration configuration)

Description copied from interface: ItemType

Checks compatibility with DataFrames.

Returns:

true if compatible with DataFrames and false otherwise.

getSparkSQLType

public String getSparkSQLType()

Description copied from interface: ItemType

Returns the SparkSQL type of the item type for use in a query.

Returns:

String representing the SparkSQL type of the item type.