Class MapTypeDescriptor

java.lang.Object
de.hybris.platform.integrationservices.model.impl.MapTypeDescriptor
All Implemented Interfaces:
TypeDescriptor

public class MapTypeDescriptor extends Object implements TypeDescriptor
  • Method Details

    • getIntegrationObjectCode

      @NotNull public @NotNull String getIntegrationObjectCode()
      Description copied from interface: TypeDescriptor
      Reads value of the integration object code.
      Specified by:
      getIntegrationObjectCode in interface TypeDescriptor
      Returns:
      integration object code this item belongs to.
    • getItemCode

      @NotNull public @NotNull String getItemCode()
      Description copied from interface: TypeDescriptor
      Reads value of the integration object item code.
      Specified by:
      getItemCode in interface TypeDescriptor
      Returns:
      integration object item type code. Keep in mind this value may be different from the type code of the item the integration object item represents. For example, type code of the item in the platform may be "Product" but integration object item type could be called "IntegrationProduct".
      See Also:
    • getTypeCode

      @NotNull public @NotNull String getTypeCode()
      Description copied from interface: TypeDescriptor
      Reads code (name) of the integration object item type in the type system.
      Specified by:
      getTypeCode in interface TypeDescriptor
      Returns:
      type code of the item in the type system. Keep in mind this value may be different from the integration objec item code. For example, type code of the item in the type system may be "Product" but integration object item code may be different, e.g "IntegrationProduct".
      See Also:
    • getAttribute

      @NotNull public @NotNull Optional<TypeAttributeDescriptor> getAttribute(String attrName)
      Description copied from interface: TypeDescriptor
      Retrieves descriptor of the specified attribute.
      Specified by:
      getAttribute in interface TypeDescriptor
      Parameters:
      attrName - name of the integration object item attribute to be retrieved. Keep in mind that name of the attribute in an integration object item may be different from the name of the corresponding attribute in the type system.
      Returns:
      attribute descriptor for the given name or Optional.empty(), if the item type does not have an attribute with such name.
    • getAttributes

      @NotNull public @NotNull Collection<TypeAttributeDescriptor> getAttributes()
      Description copied from interface: TypeDescriptor
      Retrieves all attributes defined in an integration object item.
      Specified by:
      getAttributes in interface TypeDescriptor
      Returns:
      a collection of all attributes in the integration object item or an empty collection, if this description is for a primitive type or the item does not have attributes.
    • isPrimitive

      public boolean isPrimitive()
      Description copied from interface: TypeDescriptor
      Determines whether this descriptor is for type representing integration object item or for a primitive type.
      Specified by:
      isPrimitive in interface TypeDescriptor
      Returns:
      true, if this descriptor is for a primitive type, e.g. Integer, String, etc; false, otherwise.
    • isMap

      public boolean isMap()
      Description copied from interface: TypeDescriptor
      Determines whether this descriptor is for a type representing integration object item or for a map type.
      Specified by:
      isMap in interface TypeDescriptor
      Returns:
      true, if this descriptor is for a map type; false, otherwise.
    • isEnumeration

      public boolean isEnumeration()
      Description copied from interface: TypeDescriptor
      Determines whether this descriptor is for a type representing type system enumeration.
      Specified by:
      isEnumeration in interface TypeDescriptor
      Returns:
      true, if this descriptor is for an enumeration type; false otherwise.
    • isAbstract

      public boolean isAbstract()
      Description copied from interface: TypeDescriptor
      Determines whether this descriptor is an abstract item type
      Specified by:
      isAbstract in interface TypeDescriptor
      Returns:
      true, if the item type of this descriptor has abstract == true
    • isInstance

      public boolean isInstance(Object obj)
      Description copied from interface: TypeDescriptor
      Determines whether the specified object is an instance of the type presented by this type descriptor.
      Specified by:
      isInstance in interface TypeDescriptor
      Parameters:
      obj - an object to evaluate.
      Returns:
      true, if the specified object is an instance of the type presented by this type descriptor; false, if the object is null or cannot be described by this type descriptor.
    • isRoot

      public boolean isRoot()
      Description copied from interface: TypeDescriptor
      Determines whether this descriptor is for the root item in the Integration Object
      Specified by:
      isRoot in interface TypeDescriptor
      Returns:
      true, if this descriptor is the root; false otherwise.
    • getKeyDescriptor

      public KeyDescriptor getKeyDescriptor()
      Description copied from interface: TypeDescriptor
      Retrieves key descriptor of this item type.
      Specified by:
      getKeyDescriptor in interface TypeDescriptor
      Returns:
      descriptor of the key identifying instances of this item type.
    • getPathsToRoot

      public List<ReferencePath> getPathsToRoot()
      Description copied from interface: TypeDescriptor
      Retrieves attribute path from this item type to the root item type in the same integration object.
      Specified by:
      getPathsToRoot in interface TypeDescriptor
      Returns:
      a list of all possible paths in order from the shorter ones to the longer paths. If this type descriptor does not contain attribute(s) that eventually lead to the root item type, then an empty list is returned.
      See Also:
    • hasPathToRoot

      public boolean hasPathToRoot()
      Description copied from interface: TypeDescriptor
      Determines whether it's possible to navigate from an integration item described by this type descriptor to the root item of the integration object.
      Specified by:
      hasPathToRoot in interface TypeDescriptor
      Returns:
      true, if this type descriptor describes a root item type in the integration object or it has a ReferencePath to the root item type.
      See Also: