de.hybris.platform.catalog.jalo

Class ProductFeature

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.jalo.ExtensibleItem

de.hybris.platform.jalo.c2l.LocalizableItem

de.hybris.platform.jalo.GenericItem

de.hybris.platform.catalog.jalo.GeneratedProductFeature

de.hybris.platform.catalog.jalo.ProductFeature

All Implemented Interfaces:

Serializable, Comparable

public class ProductFeature
extends GeneratedProductFeature

A product features is used to describe a property of a product. It is identified by its qualifier and it contains one or more values. Additionally a unit, description and value details may be specified. Product feature are used mainly to allow generic representation of features of imported catalog products. When modeling own product features you may rather consider to use the platforms property concept.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.jalo.GenericItem

GenericItem.GenericItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LocalizableItem.LocalizableItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem

ExtensibleItem.ExtensibleItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Item

Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENABLE_STRING_TO_NUMBER_CONVERSION
static int	TYPE_BOOLEAN
static int	TYPE_DATE
static int	TYPE_NUMBER
static int	TYPE_STRING
static int	TYPE_VALUE
static String	VALUE

Fields inherited from class de.hybris.platform.catalog.jalo.GeneratedProductFeature

BOOLEANVALUE, CLASSIFICATIONATTRIBUTEASSIGNMENT, DEFAULT_INITIAL_ATTRIBUTES, DESCRIPTION, FEATUREPOSITION, LANGUAGE, NUMBERVALUE, PRODUCT, PRODUCTHANDLER, PRODUCTPOS, QUALIFIER, RAWVALUE, STRINGVALUE, UNIT, VALUEDETAILS, VALUEPOSITION, VALUETYPE

Fields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LANGUAGE_FALLBACK_ENABLED

Fields inherited from class de.hybris.platform.jalo.Item

_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPE

Fields inherited from class de.hybris.platform.util.BridgeAbstraction

impl, tenant

Constructor Summary

Constructors

Constructor and Description
ProductFeature()

Method Summary

Modifier and Type	Method and Description
protected int	calculateSingleValueType(Object value)
protected BigDecimal	convertToBigDecimal(Number number)
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Has to be implemented for each concrete subtype of item.
protected void	doSetSingleValue(SessionContext ctx, JaloPropertyContainer cont, Object value)
protected JaloPropertyContainer	getInitialProperties(JaloSession jaloSession, Item.ItemAttributeMap allAttributes) Override to specify all properties which should be written during ejbCreate.
protected Item.ItemAttributeMap	getNonInitialAttributes(SessionContext ctx, Item.ItemAttributeMap allAttributes) The default implementation of GenericItem.getNonInitialAttributes(SessionContext, Item.ItemAttributeMap ) assures that the 'registered initial' properties GenericItem.getInitialProperties(JaloSession, Item.ItemAttributeMap ) will be removed from the 'non initial map'.
Object	getValue() Deprecated.
Object	getValue(SessionContext ctx) Deprecated.
protected boolean	isStringToNumberConversionEnabled()
void	remove(SessionContext ctx) Removes this item.
protected void	removeLinks()
void	reType(ClassAttributeAssignment assignment) (Re-)connects this value to a existing ClassAttributeAssignment.
protected void	setSearchFields(SessionContext ctx, JaloPropertyContainer cont, Object value)
void	setValue(SessionContext ctx, Object value) Deprecated.
void	untype() Disconnects this value from its ClassAttributeAssignment.

Methods inherited from class de.hybris.platform.catalog.jalo.GeneratedProductFeature

getClassificationAttributeAssignment, getClassificationAttributeAssignment, getDefaultAttributeModes, getDescription, getDescription, getFeaturePosition, getFeaturePosition, getFeaturePositionAsPrimitive, getFeaturePositionAsPrimitive, getLanguage, getLanguage, getProduct, getProduct, getQualifier, getQualifier, getUnit, getUnit, getValueDetails, getValueDetails, getValuePosition, getValuePosition, getValuePositionAsPrimitive, getValuePositionAsPrimitive, setClassificationAttributeAssignment, setClassificationAttributeAssignment, setDescription, setDescription, setFeaturePosition, setFeaturePosition, setFeaturePosition, setFeaturePosition, setLanguage, setLanguage, setProduct, setProduct, setQualifier, setQualifier, setUnit, setUnit, setValueDetails, setValueDetails, setValuePosition, setValuePosition, setValuePosition, setValuePosition

Methods inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedProperty, setLocalizedProperty

Methods inherited from class de.hybris.platform.jalo.ExtensibleItem

createNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setProperty

Methods inherited from class de.hybris.platform.jalo.Item

addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, checkRemovable, clearPermission, compareTo, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getOwner, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, readResolve, refreshRemote, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setNonInitialAttributes, setOwner, setPermissionsByMap, setTransientObject, setUseTA, toString, useTA, writeReplace

Methods inherited from class de.hybris.platform.util.BridgeAbstraction

getImplementation, setTenant

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_STRING

public static final int TYPE_STRING

See Also:

Constant Field Values

TYPE_BOOLEAN

public static final int TYPE_BOOLEAN

See Also:

Constant Field Values

TYPE_NUMBER

public static final int TYPE_NUMBER

See Also:

Constant Field Values

TYPE_VALUE

public static final int TYPE_VALUE

See Also:

Constant Field Values

TYPE_DATE

public static final int TYPE_DATE

See Also:

Constant Field Values

ENABLE_STRING_TO_NUMBER_CONVERSION

public static final String ENABLE_STRING_TO_NUMBER_CONVERSION

See Also:

Constant Field Values

VALUE

public static final String VALUE

See Also:

Constant Field Values

Constructor Detail

ProductFeature

public ProductFeature()

Method Detail

createItem

protected Item createItem(SessionContext ctx,
                          ComposedType type,
                          Item.ItemAttributeMap allAttributes)
                   throws JaloBusinessException

Description copied from class: Item

Has to be implemented for each concrete subtype of item. This method is responsible for creating a new item instance ( by calling managers, ejb homes, etc. ) during ComposedType.newInstance(Map).

In case this method uses any of the attribute values during creation it is required to override Item.getNonInitialAttributes(SessionContext, ItemAttributeMap) too.
Sn example:

 public static final String MY_ATTRIBUTE = "someAttribute"; ... protected Item createItem(SessionContext
 ctx, ComposedType type, Map allAttributes ) throws JaloBusinessException { MyManager man = ... return
 man.createMyItem( (String)allAttributes.get(MY_ATTRIBUTE) );
 // here MY_ATTRIBUTE is used for creation, so it must not be set again } protected Map getNonInitialAttributes(
 SessionContext ctx, Map allAttributes ) { // let superclass remove its own initial attributes Map ret =
 super.getNonInitialAttributes( ctx, allAttributes );
 // remove MY_ATTRIBUTE from all attributes since if has already been set ret.remove(MY_ATTRIBUTE); return ret; }

 

Overrides:

createItem in class GeneratedProductFeature

Parameters:

ctx - the current session context which this item is created within

type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )

Returns:

the new item instance

Throws:

JaloBusinessException - indicates an error during creation - any changes will be rollbacked

getInitialProperties

protected JaloPropertyContainer getInitialProperties(JaloSession jaloSession,
                                                     Item.ItemAttributeMap allAttributes)

Description copied from class: GenericItem

Override to specify all properties which should be written during ejbCreate. This way is is possible to implement non-null property fields ( means property fields which are written in SQL INSERT ). Properties which are set via Item.setNonInitialAttributes(SessionContext, Item, Item.ItemAttributeMap) are usually written by additional SQL UPDATE statements.

 protected JaloPropertyContainer getInitialProperties(ItemAttributeMap allAttributes)
 {
        JaloPropertyContainer cont = jaloSession.createPropertyContainer();
        cont.setProperty("key", (Serializable) allAttributes.get("myKey"));
        return cont;
 }
 

The default implementation collects all initial properties (localized and unlocalized ones), which were registered by calling allAttributes.setAttributeMode( MYPROPERTY, Item.AttributeMode.INITIAL ); inside MyType#createItem( SessionContext , ComposedType , Item.ItemAttributeMap ).

Overrides:

getInitialProperties in class GenericItem

Parameters:

jaloSession - the jalo session which the new item is create within

allAttributes - the attribute values of the new item

getNonInitialAttributes

protected Item.ItemAttributeMap getNonInitialAttributes(SessionContext ctx,
                                                        Item.ItemAttributeMap allAttributes)

Description copied from class: GenericItem

The default implementation of GenericItem.getNonInitialAttributes(SessionContext, Item.ItemAttributeMap ) assures that the 'registered initial' properties GenericItem.getInitialProperties(JaloSession, Item.ItemAttributeMap ) will be removed from the 'non initial map'.

Overrides:

getNonInitialAttributes in class GenericItem

Parameters:

ctx - session context with language = NULL

allAttributes - a ItemAttributeMap contaning attribute values.

Returns:

a ItemAttributeMap containing all attribute values, which belong to non-initial attributes.

removeLinks

protected void removeLinks()

Overrides:

removeLinks in class Item

remove

public void remove(SessionContext ctx)
            throws ConsistencyCheckException

Description copied from class: Item

Removes this item.

This method is using the following attributes of the given SessionContext:

CacheUsage		Language		StagingMethod
n/a (this is a setter method)		no, language doesn't matter for removal		yes if called on a StageableItem, no otherwise

Overrides:

remove in class Item

Parameters:

ctx - A SessionContext object

Throws:

ConsistencyCheckException - if this item could not be removed for some reason

untype

public void untype()

Disconnects this value from its ClassAttributeAssignment. From this time on the value will only turn up inside untyped FeatureContainer.

reType

public void reType(ClassAttributeAssignment assignment)

(Re-)connects this value to a existing ClassAttributeAssignment.

Parameters:

assignment - the class-attribute relation which the value will belong to

calculateSingleValueType

protected int calculateSingleValueType(Object value)

setValue

@Deprecated
public void setValue(SessionContext ctx,
                                 Object value)
                          throws NullPointerException

Deprecated.

Changes the value of this feature.

Throws:

NullPointerException - if the value was null

getValue

@Deprecated
public Object getValue(SessionContext ctx)

Deprecated.

Returns the value of this feature.

getValue

@Deprecated
public Object getValue()

Deprecated.

Returns the value of this feature.

doSetSingleValue

protected void doSetSingleValue(SessionContext ctx,
                                JaloPropertyContainer cont,
                                Object value)

setSearchFields

protected void setSearchFields(SessionContext ctx,
                               JaloPropertyContainer cont,
                               Object value)

convertToBigDecimal

protected BigDecimal convertToBigDecimal(Number number)

isStringToNumberConversionEnabled

protected boolean isStringToNumberConversionEnabled()