Package org.rumbledb.types

Class ArrayItemType

java.lang.Object

org.rumbledb.types.AbstractItemType

org.rumbledb.types.ArrayItemType

All Implemented Interfaces:

Serializable, ItemType

public class ArrayItemType
extends AbstractItemType

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static ItemType	arrayOf(ItemType itemType)
void	checkSubtypeConsistency()
ItemType	findLeastCommonSuperTypeLax(ItemType other)	Finds a lax (non-strict) common supertype that can incorporate anonymous facets when possible.
Set<ConstrainingFacetTypes>	getAllowedFacets()
ItemType	getArrayContentFacet()
ItemType	getBaseType()
List<Item>	getEnumerationFacet()
String	getIdentifierString()
Integer	getMaxLengthFacet()
Integer	getMinLengthFacet()
Name	getName()
ItemType	getPrimitiveType()
String	getSparkSQLType()	Returns the SparkSQL type of the item type for use in a query.
int	getTypeTreeDepth()
boolean	hasName()	Tests for QName.
boolean	isArrayItemType()
boolean	isCompatibleWithDataFrames(RumbleConfiguration configuration)	Checks compatibility with DataFrames.
boolean	isPrimitive()
boolean	isResolved()
boolean	isSubtypeOf(ItemType superType)
boolean	isUserDefined()
void	processBaseType()
void	resolve(DynamicContext context, ExceptionMetadata metadata)
void	resolve(StaticContext context, ExceptionMetadata metadata)
String	toString()

Methods inherited from class org.rumbledb.types.AbstractItemType

equalityKey, 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, findLeastCommonSuperTypeWith, getBoundedFacet, getCardinalityFacet, getCastingPrimitiveType, getClosedFacet, getConstraintsFacet, getExplicitTimezoneFacet, getFractionDigitsFacet, getLengthFacet, getLexicalSpacePatterns, getMapKeyItemType, getMapValueSequenceType, getMaxExclusiveFacet, getMaxInclusiveFacet, getMemberSequenceType, getMinExclusiveFacet, getMinInclusiveFacet, getNumericFacet, getObjectContentFacet, getObjectContentFacet, getObjectContentFacetAsUnorderedMap, getObjectKeysFacet, getOrderedFacet, getPatternFacet, getSignature, getSingleNullableType, getTotalDigitsFacet, getTypes, getWhitespaceFacet, isAtomicItemType, isCastingPrimitive, isEqualTo, isFunctionItemType, isJsonItemType, isMapItemType, isNodeItemType, isNumeric, isObjectItemType, isStaticallyCastableAs, isTopmostItemType, isUnionType, isXQueryArrayItemType

Method Details

arrayOf

public static ItemType arrayOf(ItemType itemType)

isArrayItemType

public boolean isArrayItemType()

Returns:

true it [this] is an array item type.

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.

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)

isUserDefined

public boolean isUserDefined()

Returns:

[true] if it is a user-defined type, false otherwise

isPrimitive

public boolean isPrimitive()

Returns:

[true] if it is a primitive type

getPrimitiveType

public ItemType getPrimitiveType()

Returns:

the primitive type for a derived type, throw an error for primitive types

getBaseType

public ItemType getBaseType()

Returns:

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

getAllowedFacets

public Set<ConstrainingFacetTypes> getAllowedFacets()

Returns:

a set containing the allowed facets for restricting the type

getEnumerationFacet

public List<Item> getEnumerationFacet()

Returns:

the list of possible values for [this] item type or null if the enumeration facet is not set

getMinLengthFacet

public Integer getMinLengthFacet()

Returns:

the minimum length facet value for [this] item type or null if the restriction is not set

getMaxLengthFacet

public Integer getMaxLengthFacet()

Returns:

the maximum length facet value for [this] item type or null if the restriction is not set

getArrayContentFacet

public ItemType getArrayContentFacet()

Returns:

content facet value for array item types

findLeastCommonSuperTypeLax

public ItemType findLeastCommonSuperTypeLax(ItemType other)

Description copied from interface: ItemType

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]

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

processBaseType

public void processBaseType()

resolve

public void resolve(DynamicContext context,
 ExceptionMetadata metadata)

resolve

public void resolve(StaticContext context,
 ExceptionMetadata metadata)

isResolved

public boolean isResolved()

checkSubtypeConsistency

public void checkSubtypeConsistency()

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.