de.hybris.platform.jalo.c2l

Class Language

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.c2l.GeneratedC2LItem

de.hybris.platform.jalo.c2l.C2LItem

de.hybris.platform.jalo.c2l.GeneratedLanguage

de.hybris.platform.jalo.c2l.Language

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

Direct Known Subclasses:

MyTestLanguage

public class Language
extends GeneratedLanguage

The platform language item.

As the basis of localization in the hybris Platform, they are used for example by localized attributes and links.

Some examples for the use the language items:

• Each session to the hybris Platform defines in its SessionContext the current session language ( SessionContext.getLanguage()). All localized attributes for example will by default return their value for the session language. Therefore it is very easy to realize multilingual frontends, since you only have to set once the correct session language of get the correct localized values.
• Localized attributes are internally implemented as MapTypes by mapping languages to their values (language -> localized value). A localized String therefore is realized as a MapType which maps languages to strings.

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 java.lang.String	FALLBACK_LANGUAGES Deprecated. since ages - useGeneratedLanguage.FALLBACKLANGUAGES instead
protected java.lang.String	isoCodeCheck internal, dont use
protected java.util.Locale	localeCache internal, dont use

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

DEFAULT_INITIAL_ATTRIBUTES, FALLBACKLANGUAGES

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

ACTIVE, ISOCODE, NAME

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

Method Summary

Modifier and Type	Method and Description
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Has to be implemented for each concrete subtype of item.
java.util.List<Language>	getFallbackLanguages(SessionContext ctx) Generated method - Getter of the Language.fallbackLanguages attribute.
java.util.Locale	getLocale() Returns the corresponding Locale instance according to the isocode of this Language .
static void	registerAsJaloObject() Deprecated. since ages - this is done automatically during initialization of the hybris Platform implementation
void	remove(SessionContext ctx) Removes this Language.
void	setFallbackLanguages(Language... fallBackTo)
void	setFallbackLanguages(SessionContext ctx, java.util.List<Language> fallBackTo) Generated method - Setter of the Language.fallbackLanguages attribute.

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

getDefaultAttributeModes, getFallbackLanguages, setFallbackLanguages

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

checkConsistencyActive, checkConsistencyIsocode, getAllNames, getIsoCode, getIsoCode, isActive, setActive, setAllNames, setIsocode, setIsoCode, setIsoCode, toString

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

getAllName, getAllName, getIsocode, getIsocode, getName, getName, isActive, isActiveAsPrimitive, isActiveAsPrimitive, setActive, setActive, setActive, setAllName, setAllName, setIsocode, setName, setName

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, 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

Field Detail

FALLBACK_LANGUAGES

@Deprecated
public static final java.lang.String FALLBACK_LANGUAGES

Deprecated. since ages - useGeneratedLanguage.FALLBACKLANGUAGES instead

Since:

2.20

See Also:

Constant Field Values

isoCodeCheck

protected java.lang.String isoCodeCheck

internal, dont use

localeCache

protected java.util.Locale localeCache

internal, dont use

Constructor Detail

Language

public Language()

Method Detail

registerAsJaloObject

@Deprecated
public static void registerAsJaloObject()

Deprecated. since ages - this is done automatically during initialization of the hybris Platform implementation

Method registerAsJaloObject

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

getLocale

public java.util.Locale getLocale()

Returns the corresponding Locale instance according to the isocode of this Language . Therefore the isocode must match the following pattern:

• Pattern: LANGUAGE-CODE('.'COUNTRY-CODE('.'VARIANT-CHARS))
• Example: de.DE, en, es.ES.Traditional_WIN

Returns:

the corresponding Locale instance according to the isocode of this Language

See Also:

Locale

setFallbackLanguages

public void setFallbackLanguages(SessionContext ctx,
                                 java.util.List<Language> fallBackTo)

Description copied from class: GeneratedLanguage

Generated method - Setter of the Language.fallbackLanguages attribute.

Specified by:

setFallbackLanguages in class GeneratedLanguage

fallBackTo - the fallbackLanguages

setFallbackLanguages

public void setFallbackLanguages(Language... fallBackTo)
                          throws JaloInvalidParameterException

Throws:

JaloInvalidParameterException

Since:

3.0 M3

getFallbackLanguages

public java.util.List<Language> getFallbackLanguages(SessionContext ctx)

Description copied from class: GeneratedLanguage

Generated method - Getter of the Language.fallbackLanguages attribute.

Specified by:

getFallbackLanguages in class GeneratedLanguage

Returns:

the fallbackLanguages

remove

public void remove(SessionContext ctx)
            throws ConsistencyCheckException

Removes this Language. If this language is the current session language ( JaloSession.getSessionContext(), SessionContext.getLanguage()), an ConsistencyCheckException is thrown.

Overrides:

remove in class Item

Parameters:

ctx - A SessionContext object

Throws:

ConsistencyCheckException - if the language which should be removed is the current session language

See Also:

Item.remove(de.hybris.platform.jalo.SessionContext)