Class DefaultTypeAttributeDescriptor
- All Implemented Interfaces:
TypeAttributeDescriptor
This implementation is effectively immutable and therefore is thread safe.
Reuse this class through composition, not inheritance.
-
Method Summary
Modifier and TypeMethodDescriptionaccessor()Gets theAttributeValueAccessorfor accessing this attribute's valuebooleanGets name of the attribute described by this descriptor.Retrieves type of this attribute value(s).Gets theCollectionDescriptorGets a map descriptor for this attribute.Gets name of this attribute in the platform type system.@NotNull TypeDescriptorRetrieves descriptor of the type, this attribute is associated with.inthashCode()booleanDetermines whether the item referenced by this attribute should be persisted when the item with this attribute is persisted.booleanDetermines whether this attribute contains a single value or multiple values (a collection of values).booleanDetermines whether this attribute is a key attributebooleanDetermines whether the value of this descriptor can be localized.booleanisMap()Determines whether the attribute is referring to a map of values.booleanDetermines whether the attribute represented by this descriptor can takenullvalues.booleanisPartOf()Determines whether the item referenced by this attribute should be a part of the attribute's item model or not.booleanDetermines whether the value of this descriptor is a primitive typebooleanDetermines whether this attribute is readablebooleanisSettable(Object item) Indicates whether this attribute's value can be set.reverse()Reverses the relation described by this attribute descriptor and retrieves an attribute descriptor defined in theTypeAttributeDescriptor.getAttributeType()type descriptor withTypeAttributeDescriptor.getTypeDescriptor()attribute type.toString()Methods inherited from class de.hybris.platform.integrationservices.model.impl.AbstractDescriptor
getFactory
-
Method Details
-
getQualifier
Description copied from interface:TypeAttributeDescriptorGets name of this attribute in the platform type system.- Returns:
- name of this attribute in the type system.
-
isCollection
public boolean isCollection()Determines whether this attribute contains a single value or multiple values (a collection of values).- Returns:
true, if the underlyingAttributeDescriptorModelrepresents a collection or a one-to-many relationship or, in other words, if the corresponding accessor in the generated item has aCollectionreturn type, e.g.public class Parent { ... Collection<Child> Parent.getChildren() {...} ... }From the implementation standpoint it does not matter how that collection is modeled byCollectionTypeModelorRelationDescriptorModel- as long as it's a collection or one of its subtypes returned this method returnstrue. Otherwise, it returnsfalse
-
getCollectionDescriptor
Description copied from interface:TypeAttributeDescriptorGets theCollectionDescriptor- Returns:
- A collection descriptor
-
getMapDescriptor
Description copied from interface:TypeAttributeDescriptorGets a map descriptor for this attribute.- Returns:
Optionalcontaining aMapDescriptor, if this attribute is of Map type; otherwise returnsOptional.empty()- See Also:
-
reverse
Description copied from interface:TypeAttributeDescriptorReverses the relation described by this attribute descriptor and retrieves an attribute descriptor defined in the
TypeAttributeDescriptor.getAttributeType()type descriptor withTypeAttributeDescriptor.getTypeDescriptor()attribute type.For example, type
Parenthas attributechildrenthat refers a collection of typeChild; and typeChildhas an attributeparentreferring back toParenttype. Then attribute descriptor forparentattribute is reverse forchildrenattribute descriptor.Another example, type
Organizationhas attributeaddressesthat refers a collection of typeAddress; but typeAddressdoes not refer back to typeOrganization. In this case there is no reverse attribute foraddressesattribute descriptor.- Returns:
- an optional containing a descriptor for the attribute in type returned by
TypeAttributeDescriptor.getAttributeType(), which refers back to the type retrieved by callingTypeAttributeDescriptor.getTypeDescriptor()on this attribute descriptor; or an empty optional that attribute type of this descriptor does not refer back to the type containing this attribute descriptor.
-
isNullable
public boolean isNullable()Description copied from interface:TypeAttributeDescriptorDetermines whether the attribute represented by this descriptor can takenullvalues.- Returns:
true, if the attribute can takenullvalues;false, if the attribute value is required.
-
isPartOf
public boolean isPartOf()Description copied from interface:TypeAttributeDescriptorDetermines whether the item referenced by this attribute should be a part of the attribute's item model or not. This defines in particular whether the nested referenced item will be created whenever the "container" item is persisted (part of) or it can and should exist and persist independently (not a part of). For example, aCarhas an attributeengine, which refers itemEngine. If the business model is interested in cars only and does not care about engines outside of the car model, then the attribute should be defined withpartOf == true. If the engine has independent existence, e.g. engine can be sold without a car, then the attribute should defined withpartOf == false.In other words, this attribute descriptor defines a relation between an owner and the owned item. Thus in the example above
Engineis owned byCaras it does not have independent existence in the model.- Returns:
true, if the item referenced by this attribute descriptor is an integral part of its owner model.- See Also:
-
isAutoCreate
public boolean isAutoCreate()Determines whether the item referenced by this attribute should be persisted when the item with this attribute is persisted. UnlikeTypeAttributeDescriptor.isPartOf()this method does not require the referenced item to be an integral part of the owner item. The referenced item may have its independent existence in the domain model and yet it will be persisted together with the item holding an attribute described by this descriptor.- Returns:
true, if the attribute is defined withpartOf == truein the type system or the correspondingIntegrationObjectItemAttributeModelhasautoCreate == true;false, otherwise.- See Also:
-
isLocalized
public boolean isLocalized()Description copied from interface:TypeAttributeDescriptorDetermines whether the value of this descriptor can be localized. This method may need to be used withTypeAttributeDescriptor.isMap()to determine whether the attribute supports multiple locale specific values. Some attributes may be localized but do not support multi-locale values. For example, a simple Numeric or Boolean attribute can be declared as localized.- Returns:
- true if localized, else false
-
isPrimitive
public boolean isPrimitive()Description copied from interface:TypeAttributeDescriptorDetermines whether the value of this descriptor is a primitive type- Returns:
- true if it's a primitive type, else false
-
isReadable
public boolean isReadable()Description copied from interface:TypeAttributeDescriptorDetermines whether this attribute is readable- Returns:
trueif the attribute is readable, false otherwise. Returnstrueby default for backwards compatibility
-
isMap
public boolean isMap()Description copied from interface:TypeAttributeDescriptorDetermines whether the attribute is referring to a map of values. Typically used to determiine in conjunction withTypeAttributeDescriptor.isLocalized()to determine whether the attribute can hold multiple locale specific values. However, it can be used by itself.- Returns:
true, if the attribute refers to a map;falseotherwise.
-
isSettable
Description copied from interface:TypeAttributeDescriptorIndicates whether this attribute's value can be set.- Returns:
trueif value is settable,falseotherwise
-
isKeyAttribute
public boolean isKeyAttribute()Description copied from interface:TypeAttributeDescriptorDetermines whether this attribute is a key attribute- Returns:
true, if the attribute is a key attribute, otherwise, false
-
getAttributeName
Description copied from interface:TypeAttributeDescriptorGets name of the attribute described by this descriptor.- Specified by:
getAttributeNamein interfaceTypeAttributeDescriptor- Returns:
- name of the attribute as it was defined for the integration object.
-
getAttributeType
Description copied from interface:TypeAttributeDescriptorRetrieves type of this attribute value(s).- Specified by:
getAttributeTypein interfaceTypeAttributeDescriptor- Returns:
- type of this attribute value, which may be a primitive type or a complex type referring an item in the type system; or a type of the referenced element(s) in case, if this attribute contains a collection of values or represents a one-to-one, one-to-many or many-to-many relationship.
- See Also:
-
getTypeDescriptor
Description copied from interface:TypeAttributeDescriptorRetrieves descriptor of the type, this attribute is associated with.- Specified by:
getTypeDescriptorin interfaceTypeAttributeDescriptor- Returns:
- descriptor of the item type that contains the attribute described by this attribute descriptor.
-
accessor
Description copied from interface:TypeAttributeDescriptorGets theAttributeValueAccessorfor accessing this attribute's value- Specified by:
accessorin interfaceTypeAttributeDescriptor- Returns:
- The AttributeValueAccessor
-
equals
-
hashCode
public int hashCode() -
toString
-