Package de.hybris.platform.commons.jalo

Class Format

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.commons.jalo.GeneratedFormat

de.hybris.platform.commons.jalo.Format

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class Format
extends GeneratedFormat

The main Item/Class of the extension commons.
The Format item contains one ItemFormatter (set with GeneratedFormat.setInitial(de.hybris.platform.commons.jalo.ItemFormatter)) and a Collection with at least one MediaFormatter (set with GeneratedFormat.setChained(java.util.Collection)).
After calling the method format(Item) there will be an Item Document attached to this instance which contains the result of the format process (as media).

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.commons.jalo.GeneratedFormat

CHAINED, CODE, DEFAULT_INITIAL_ATTRIBUTES, DOCUMENTTYPE, FORMAT2COMTYPREL_MARKMODIFIED, FORMAT2COMTYPREL_SRC_ORDERED, FORMAT2COMTYPREL_TGT_ORDERED, FORMAT2MEDFORREL_MARKMODIFIED, FORMAT2MEDFORREL_SRC_ORDERED, FORMAT2MEDFORREL_TGT_ORDERED, INITIAL, NAME, VALIDFOR

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, HJMPTS, 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	Description
Format()

Method Summary

Modifier and Type	Method	Description
Document	format(Item item)
Document	format(Item item, Document doc)	Formats document using public Document format(final Item item, final Document doc) throws JaloBusinessException

Methods inherited from class de.hybris.platform.commons.jalo.GeneratedFormat

addToChained, addToChained, addToValidFor, addToValidFor, getAllName, getAllName, getChained, getChained, getChainedCount, getChainedCount, getCode, getCode, getDefaultAttributeModes, getDocumentType, getDocumentType, getInitial, getInitial, getName, getName, getValidFor, getValidFor, getValidForCount, getValidForCount, isMarkModifiedDisabled, removeFromChained, removeFromChained, removeFromValidFor, removeFromValidFor, setAllName, setAllName, setChained, setChained, setCode, setCode, setDocumentType, setDocumentType, setInitial, setInitial, setName, setName, setValidFor, setValidFor

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

createItem, getImplementation, getInitialProperties, getNonInitialAttributes, getRelatedItems, setRelatedItems

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

Format

public Format()

Method Detail

format

public Document format(Item item)
                throws JaloBusinessException

Throws:

JaloBusinessException

format

public Document format(Item item,
                       Document doc)
                throws JaloBusinessException

Formats document using public Document format(final Item item, final Document doc) throws JaloBusinessException

Parameters:

item -

doc -

Returns:

formatted document

Throws:

JaloBusinessException