Class ItemTypeDescriptor
java.lang.Object
de.hybris.platform.integrationservices.model.impl.AbstractDescriptor
de.hybris.platform.integrationservices.model.impl.ItemTypeDescriptor
- All Implemented Interfaces:
TypeDescriptor
Common superclass for all descriptors produced by
DefaultDescriptorFactory
This implementation is effectively immutable and therefore is thread safe
Reuse this implementation through composition not inheritance
-
Method Summary
Modifier and TypeMethodDescriptionbooleangetAttribute(String attrName) Retrieves descriptor of the specified attribute.Retrieves all attributes defined in an integration object item.Reads value of the integration object code.Reads value of the integration object item code.Retrieves key descriptor of this item type.Retrieves attribute path from this item type to the root item type in the same integration object.Reads code (name) of the integration object item type in the type system.inthashCode()booleanDetermines whether it's possible to navigate from an integration item described by this type descriptor to the root item of the integration object.booleanDetermines whether this descriptor is an abstract item typebooleanDetermines whether this descriptor is for a type representing type system enumeration.booleanisInstance(Object obj) Determines whether the specified object is an instance of the type presented by this type descriptor.booleanDetermines whether this descriptor is for type representing integration object item or for a primitive type.booleanisRoot()Determines whether this descriptor is for the root item in the Integration ObjectpathFrom(TypeDescriptor itemType) Retrieves attribute path from the specified item type to this item type.voidInjectsReferencePathFinderimplementation to use.toString()Methods inherited from class de.hybris.platform.integrationservices.model.impl.AbstractDescriptor
getFactoryMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface de.hybris.platform.integrationservices.model.TypeDescriptor
isMap
-
Method Details
-
getIntegrationObjectCode
Description copied from interface:TypeDescriptorReads value of the integration object code.- Specified by:
getIntegrationObjectCodein interfaceTypeDescriptor- Returns:
- integration object code this item belongs to.
-
getItemCode
Description copied from interface:TypeDescriptorReads value of the integration object item code.- Specified by:
getItemCodein interfaceTypeDescriptor- 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
Description copied from interface:TypeDescriptorReads code (name) of the integration object item type in the type system.- Specified by:
getTypeCodein interfaceTypeDescriptor- 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
Description copied from interface:TypeDescriptorRetrieves descriptor of the specified attribute.- Specified by:
getAttributein interfaceTypeDescriptor- 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
Description copied from interface:TypeDescriptorRetrieves all attributes defined in an integration object item.- Specified by:
getAttributesin interfaceTypeDescriptor- 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:TypeDescriptorDetermines whether this descriptor is for type representing integration object item or for a primitive type.- Specified by:
isPrimitivein interfaceTypeDescriptor- Returns:
true, if this descriptor is for a primitive type, e.g. Integer, String, etc;false, otherwise.
-
isEnumeration
public boolean isEnumeration()Description copied from interface:TypeDescriptorDetermines whether this descriptor is for a type representing type system enumeration.- Specified by:
isEnumerationin interfaceTypeDescriptor- Returns:
true, if this descriptor is for an enumeration type;falseotherwise.
-
isAbstract
public boolean isAbstract()Description copied from interface:TypeDescriptorDetermines whether this descriptor is an abstract item type- Specified by:
isAbstractin interfaceTypeDescriptor- Returns:
true, if the item type of this descriptor hasabstract == true
-
isInstance
Description copied from interface:TypeDescriptorDetermines whether the specified object is an instance of the type presented by this type descriptor.- Specified by:
isInstancein interfaceTypeDescriptor- 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 isnullor cannot be described by this type descriptor.
-
isRoot
public boolean isRoot()Description copied from interface:TypeDescriptorDetermines whether this descriptor is for the root item in the Integration Object- Specified by:
isRootin interfaceTypeDescriptor- Returns:
true, if this descriptor is the root;falseotherwise.
-
getKeyDescriptor
Description copied from interface:TypeDescriptorRetrieves key descriptor of this item type.- Specified by:
getKeyDescriptorin interfaceTypeDescriptor- Returns:
- descriptor of the key identifying instances of this item type.
-
getPathsToRoot
Description copied from interface:TypeDescriptorRetrieves attribute path from this item type to the root item type in the same integration object.- Specified by:
getPathsToRootin interfaceTypeDescriptor- 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:TypeDescriptorDetermines 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:
hasPathToRootin interfaceTypeDescriptor- Returns:
true, if this type descriptor describes a root item type in the integration object or it has aReferencePathto the root item type.- See Also:
-
pathFrom
Description copied from interface:TypeDescriptorRetrieves attribute path from the specified item type to this item type. For example, if there is an integration object:Product - catalogVersion -> CatalogVersion - catalog -> Catalog - id - categories -> Category - catalogVersion -> CatalogVersion - catalog -> Catalog - idwhere Product, Category, CatalogVersion and Catalog are integration object items and catalogVersion, categories, catalog and id are the attributes in the corresponding items. If current type descriptor is for Catalog type and the Product type descriptor is passed, then the paths are:Product.catalogVersion.catalogandProduct.categories.catalogVersion.catalog.- Specified by:
pathFromin interfaceTypeDescriptor- Parameters:
itemType- descriptor of the item type, from which the path has to be calculated.- Returns:
- all paths from the specified type to the type described this descriptor in order from the shortest to the longest path or an empty list, if this type descriptor and the specified item type are not related, ie. there is no a single path.
-
setReferencePathFinder
InjectsReferencePathFinderimplementation to use.- Parameters:
finder- a finder implementation to use for methods returningReferencePaths.nullvalue resets the finder implementation to default, which isAttributePathFinder
-
equals
-
hashCode
public int hashCode() -
toString
-