Package org.rumbledb.types

Class FunctionItemType

java.lang.Object

org.rumbledb.types.AbstractItemType

org.rumbledb.types.FunctionItemType

All Implemented Interfaces:

Serializable, ItemType

public class FunctionItemType
extends AbstractItemType

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()
Name	getName()
FunctionSignature	getSignature()
int	getTypeTreeDepth()
boolean	isCompatibleWithDataFrames(RumbleConfiguration configuration)	Checks compatibility with DataFrames.
boolean	isFunctionItemType()
boolean	isResolved()
boolean	isSubtypeOf(ItemType superType)
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, getMemberSequenceType, getMinExclusiveFacet, getMinInclusiveFacet, getMinLengthFacet, getNumericFacet, getObjectContentFacet, getObjectContentFacet, getObjectContentFacetAsUnorderedMap, getObjectKeysFacet, getOrderedFacet, getPatternFacet, getPrimitiveType, getSingleNullableType, getSparkSQLType, getTotalDigitsFacet, getTypes, getWhitespaceFacet, hasName, isArrayItemType, isAtomicItemType, isCastingPrimitive, isEqualTo, isJsonItemType, isMapItemType, isNodeItemType, isNumeric, isObjectItemType, isPrimitive, isStaticallyCastableAs, isTopmostItemType, isUnionType, isUserDefined, isXQueryArrayItemType

Method Details

getName

public Name getName()

Returns:

the itemtype QName if available

equalityKey

protected Object equalityKey()

Overrides:

equalityKey in class AbstractItemType

isFunctionItemType

public boolean isFunctionItemType()

Returns:

true it [this] is a function item type.

getSignature

public FunctionSignature getSignature()

Returns:

the signature of the function item type if available

isResolved

public boolean isResolved()

resolve

public void resolve(StaticContext context,
 ExceptionMetadata metadata)

resolve

public void resolve(DynamicContext context,
 ExceptionMetadata metadata)

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

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.