Package org.rumbledb.types

Class ObjectItemType

java.lang.Object
org.rumbledb.types.ObjectItemType
All Implemented Interfaces:
com.esotericsoftware.kryo.KryoSerializable, Serializable, ItemType
public class ObjectItemType extends Object implements ItemType
See Also:

  • Method Details

    • write

      public void write(com.esotericsoftware.kryo.Kryo kryo, com.esotericsoftware.kryo.io.Output output)
      Specified by:
      write in interface com.esotericsoftware.kryo.KryoSerializable

    • read

      public void read(com.esotericsoftware.kryo.Kryo kryo, com.esotericsoftware.kryo.io.Input input)
      Specified by:
      read in interface com.esotericsoftware.kryo.KryoSerializable

    • equals

      public boolean equals(Object other)
      Description copied from interface: ItemType
      Tests for itemType equality.
      Specified by:
      equals in interface ItemType
      Overrides:
      equals in class Object
      Parameters:
      other - another object.
      Returns:
      true it is equal to other, false otherwise.

    • isObjectItemType

      public boolean isObjectItemType()
      Specified by:
      isObjectItemType in interface ItemType
      Returns:
      true it [this] is an object item type.

    • hasName

      public boolean hasName()
      Description copied from interface: ItemType
      Tests for QName.
      Specified by:
      hasName in interface ItemType
      Returns:
      true if [this] item type has a QName

    • getName

      public Name getName()
      Specified by:
      getName in interface ItemType
      Returns:
      the itemtype QName if available

    • getTypeTreeDepth

      public int getTypeTreeDepth()
      Specified by:
      getTypeTreeDepth in interface ItemType
      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()
      Specified by:
      isUserDefined in interface ItemType
      Returns:
      [true] if it is a user-defined type, false otherwise

    • isPrimitive

      public boolean isPrimitive()
      Specified by:
      isPrimitive in interface ItemType
      Returns:
      [true] if it is a primitive type

    • getPrimitiveType

      public ItemType getPrimitiveType()
      Specified by:
      getPrimitiveType in interface ItemType
      Returns:
      the primitive type for a derived type, throw an error for primitive types

    • getBaseType

      public ItemType getBaseType()
      Specified by:
      getBaseType in interface ItemType
      Returns:
      the base type for a type, return null for the topmost item type

    • getAllowedFacets

      public Set<ConstrainingFacetTypes> getAllowedFacets()
      Specified by:
      getAllowedFacets in interface ItemType
      Returns:
      a set containing the allowed facets for restricting the type

    • isSubtypeOf

      public boolean isSubtypeOf(ItemType superType)
      Specified by:
      isSubtypeOf in interface ItemType
      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)
      Specified by:
      findLeastCommonSuperTypeWith in interface ItemType
      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)

    • getEnumerationFacet

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

    • getConstraintsFacet

      public List<String> getConstraintsFacet()
      Specified by:
      getConstraintsFacet in interface ItemType
      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

    • getObjectContentFacet

      public Map<String,FieldDescriptor> getObjectContentFacet()
      Specified by:
      getObjectContentFacet in interface ItemType
      Returns:
      content facet value for object item types (cumulative facet)

    • getClosedFacet

      public boolean getClosedFacet()
      Specified by:
      getClosedFacet in interface ItemType
      Returns:
      closed facet value for object 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.
      Specified by:
      findLeastCommonSuperTypeLax in interface ItemType
      Parameters:
      other - another item type
      Returns:
      a lax common supertype between [this] and [other]

    • getIdentifierString

      public String getIdentifierString()
      Specified by:
      getIdentifierString in interface ItemType
      Returns:
      a String that uniquely identify an item type

    • toString

      public String toString()
      Specified by:
      toString in interface ItemType
      Overrides:
      toString in class Object

    • isResolved

      public boolean isResolved()
      Specified by:
      isResolved in interface ItemType

    • resolve

      public void resolve(DynamicContext context, ExceptionMetadata metadata)
      Specified by:
      resolve in interface ItemType

    • resolve

      public void resolve(StaticContext context, ExceptionMetadata metadata)
      Specified by:
      resolve in interface ItemType

    • isCompatibleWithDataFrames

      public boolean isCompatibleWithDataFrames(RumbleRuntimeConfiguration configuration)
      Description copied from interface: ItemType
      Checks compatibility with DataFrames.
      Specified by:
      isCompatibleWithDataFrames in interface ItemType
      Returns:
      true if compatible with DataFrames and false otherwise.

    • processBaseType

      public void processBaseType()

    • checkSubtypeConsistency

      public void checkSubtypeConsistency()

    • getSparkSQLType

      public String getSparkSQLType()
      Description copied from interface: ItemType
      Returns the SparkSQL type of the item type for use in a query.
      Specified by:
      getSparkSQLType in interface ItemType
      Returns:
      String representing the SparkSQL type of the item type.