Package org.rumbledb.types

Class ItemItemType

java.lang.Object

org.rumbledb.types.AbstractItemType

org.rumbledb.types.ItemItemType

All Implemented Interfaces:

Serializable, ItemType

public class ItemItemType
extends AbstractItemType

Class representing the generic 'item' item type

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ItemItemType()
ItemItemType(Name name)

Method Summary

Modifier and Type	Method	Description
boolean	canBeNull()
ItemType	findLeastCommonSuperTypeWith(ItemType other)
Set<ConstrainingFacetTypes>	getAllowedFacets()
ItemType	getBaseType()
Name	getName()
int	getTypeTreeDepth()
boolean	hasName()	Tests for QName.
boolean	isCompatibleWithDataFrames(RumbleConfiguration configuration)	Checks compatibility with DataFrames.
boolean	isResolved()
boolean	isSubtypeOf(ItemType superType)
boolean	isTopmostItemType()
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

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

Constructor Details

ItemItemType

public ItemItemType()

ItemItemType

public ItemItemType(Name name)

Method Details

isTopmostItemType

public boolean isTopmostItemType()

Returns:

true it [this] is the topmost item type.

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

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)

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

getAllowedFacets

public Set<ConstrainingFacetTypes> getAllowedFacets()

Returns:

a set containing the allowed facets for restricting the type

toString

public String toString()

Specified by:

toString in interface ItemType

Overrides:

toString in class Object

isResolved

public boolean isResolved()

isCompatibleWithDataFrames

public boolean isCompatibleWithDataFrames(RumbleConfiguration configuration)

Description copied from interface: ItemType

Checks compatibility with DataFrames.

Returns:

true if compatible with DataFrames and false otherwise.

canBeNull

public boolean canBeNull()

Returns:

[true] if the null value is in the value space.