de.hybris.platform.jalo.product

Class Unit

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.jalo.product.GeneratedUnit

de.hybris.platform.jalo.product.Unit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

Direct Known Subclasses:

MyTestUnit, MyUnit

public class Unit
extends GeneratedUnit

The base class which represents a Unit.

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 inherited from class de.hybris.platform.jalo.product.GeneratedUnit

CODE, CONVERSION, DEFAULT_INITIAL_ATTRIBUTES, NAME, UNITTYPE

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
Unit()

Method Summary

Modifier and Type	Method and Description
int	compareQuantity(double value, Unit toUnit, double otherValue) Compares the quantity of first argument (related to this unit) and third argument (related to second argument unit).
long	convert(Unit targetUnit, long value) Converts a quantity of this unit into another quantity of a specified target unit.
double	convertExact(Unit targetUnit, double value) Converts a quantity of this unit into another quantity of a specified target unit.
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Has to be implemented for each concrete subtype of item.
java.util.Map	getAllNames(SessionContext ctx) Deprecated. since ages - useGeneratedUnit.getAllName(SessionContext)
double	getConversionFactor() Gets the conversion factor used by this unit.
double	getConversionFactor(SessionContext ctx) Deprecated. since ages - useGeneratedUnit.getConversionAsPrimitive(SessionContext) instead;
java.util.Set<Unit>	getConvertibleUnits() Gets all units with the same unit type.
boolean	isConvertibleTo(Unit unit) Checks if values of this unit can be converted to given unit.
void	setAllNames(SessionContext ctx, java.util.Map names) Deprecated. since ages - useGeneratedUnit.setAllName(SessionContext, Map)
void	setConversionFactor(double factor) Deprecated. since ages - useGeneratedUnit.setConversion(double) instead
void	setConversionFactor(SessionContext ctx, double factor) Deprecated. since ages - useGeneratedUnit.setConversion(SessionContext,double) instead
java.lang.String	toString() Returns the String representation of this item.

Methods inherited from class de.hybris.platform.jalo.product.GeneratedUnit

getAllName, getAllName, getCode, getCode, getConversion, getConversion, getConversionAsPrimitive, getConversionAsPrimitive, getDefaultAttributeModes, getName, getName, getUnitType, getUnitType, setAllName, setAllName, setCode, setCode, setConversion, setConversion, setConversion, setConversion, setName, setName, setUnitType, setUnitType

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

getInitialProperties, getNonInitialAttributes

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, getImplementation, 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, isMarkModifiedDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, notifyManagerAboutItemRemoval, readResolve, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, 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, useTA, writeReplace

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

setTenant

Methods inherited from class java.lang.Object

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

Constructor Detail

Unit

public Unit()

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 GenericItem

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

getAllNames

@Deprecated
public java.util.Map getAllNames(SessionContext ctx)

Deprecated. since ages - useGeneratedUnit.getAllName(SessionContext)

Gets all names (in all languages).

Parameters:

ctx - A SessionContext object

Returns:

map with following combination key:language, value:name

setAllNames

@Deprecated
public void setAllNames(SessionContext ctx,
                                    java.util.Map names)

Deprecated. since ages - useGeneratedUnit.setAllName(SessionContext, Map)

Sets names (in all languages).

Parameters:

ctx - A SessionContext object

names - map with following combination key:language, value:name

getConversionFactor

public double getConversionFactor()

Gets the conversion factor used by this unit.

getConversionFactor

@Deprecated
public double getConversionFactor(SessionContext ctx)

Deprecated. since ages - useGeneratedUnit.getConversionAsPrimitive(SessionContext) instead;

Gets the conversion factor used by this unit.

setConversionFactor

@Deprecated
public void setConversionFactor(double factor)

Deprecated. since ages - useGeneratedUnit.setConversion(double) instead

Sets the conversion factor used by this unit.

Parameters:

factor - new conversion factor

setConversionFactor

@Deprecated
public void setConversionFactor(SessionContext ctx,
                                            double factor)

Deprecated. since ages - useGeneratedUnit.setConversion(SessionContext,double) instead

Sets the conversion factor used by this unit.

Parameters:

factor - new conversion factor

convert

public long convert(Unit targetUnit,
                    long value)
             throws JaloInvalidParameterException

Converts a quantity of this unit into another quantity of a specified target unit.

Parameters:

targetUnit - target unit for conversion

value - value to convert

Throws:

JaloInvalidParameterException - if this unit type not equals target unit type

convertExact

public double convertExact(Unit targetUnit,
                           double value)
                    throws JaloInvalidParameterException

Converts a quantity of this unit into another quantity of a specified target unit. Does no rounding to get an exact results.

Parameters:

targetUnit - target unit for conversion

value - value to convert

Throws:

JaloInvalidParameterException - if this unit type not equals target unit type

toString

public java.lang.String toString()

Description copied from class: Item

Returns the String representation of this item. This is by default the representation of the primary key of this item.

Overrides:

toString in class Item

Returns:

the String representation of this item.

isConvertibleTo

public boolean isConvertibleTo(Unit unit)

Checks if values of this unit can be converted to given unit.

Parameters:

unit - target unit for which conversion will be checked

Returns:

true if this unit is convertible to given unit

compareQuantity

public int compareQuantity(double value,
                           Unit toUnit,
                           double otherValue)

Compares the quantity of first argument (related to this unit) and third argument (related to second argument unit).

getConvertibleUnits

public java.util.Set<Unit> getConvertibleUnits()

Gets all units with the same unit type.

Returns:

all units with the same unit type. these units are considered to be convertible using the conversion factor attribute.