Package de.hybris.platform.commons.jalo

Class ItemFormatter

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.media.GeneratedAbstractMedia

de.hybris.platform.jalo.media.AbstractMedia

de.hybris.platform.jalo.media.GeneratedMedia

de.hybris.platform.jalo.media.Media

de.hybris.platform.commons.jalo.GeneratedFormatter

de.hybris.platform.commons.jalo.Formatter

de.hybris.platform.commons.jalo.GeneratedItemFormatter

de.hybris.platform.commons.jalo.ItemFormatter

All Implemented Interfaces:

Serializable, Comparable

Direct Known Subclasses:

GeneratedCustomOrder2XML, GeneratedVelocityFormatter

public abstract class ItemFormatter
extends GeneratedItemFormatter

This abstract class ItemFormatter is for transforming an item of the platform into a media (for example the media could contain a xml file). The output media is processed to an implementation(s) of the abstract class MediaFormatter

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.GeneratedItemFormatter

DEFAULT_INITIAL_ATTRIBUTES

Fields inherited from class de.hybris.platform.commons.jalo.GeneratedFormatter

OUTPUTMIMETYPE, SCRIPT

Fields inherited from class de.hybris.platform.jalo.media.Media

FROM_JAR, HASDATA, ISONSERVER, PICTURE, THUMBNAIL, URL, URL2

Fields inherited from class de.hybris.platform.jalo.media.GeneratedMedia

ALTTEXT, CODE, DERIVEDMEDIAS, DERIVEDMEDIASHANDLER, DESCRIPTION, FOLDER, INTERNALURL, MEDIACONTAINER, MEDIACONTAINERHANDLER, MEDIAFORMAT, REMOVABLE, SUBFOLDERPATH

Fields inherited from class de.hybris.platform.jalo.media.GeneratedAbstractMedia

DATAPK, LOCATION, LOCATIONHASH, MIME, REALFILENAME, SIZE

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

Method Summary

Modifier and Type	Method	Description
abstract Media	format(Item item)

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

getDefaultAttributeModes

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

getScript, setScript

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

getOutputMimeType, getOutputMimeType, getScript, setOutputMimeType, setOutputMimeType, setScript

Methods inherited from class de.hybris.platform.jalo.media.Media

checkRemovable, copyToTempFile, createItem, getData, getDataFromInputStream, getDataFromInputStreamSure, getDataFromStream, getDataFromStreamSure, getDeniedPrincipals, getDeniedPrincipals, getDownloadURL, getDownloadURL, getFile, getFileExtensionFromMime, getFileName, getFileNameForFileBasedSoftware, getFiles, getFolder, getForContext, getForeignDataOwners, getForeignDataOwners, getInFormat, getLocation, getPermittedPrincipals, getPermittedPrincipals, getURL, getURL, getURL2, getURL2, getZipEntries, getZipEntryNames, hasData, hasForeignDataOwners, isOnServer, isRemovableAsPrimitive, moveData, moveDataTo, moveMedia, moveMedia, relocateData, remove, removeData, setData, setData, setData, setData, setData, setData, setData, setData, setDataByURL, setDataFromStream, setDataFromStream, setDataPK, setDeniedPrincipals, setDeniedPrincipals, setFile, setFile, setPermittedPrincipals, setPermittedPrincipals, setSize, setURL, setURL, setURL2, setURL2, toString

Methods inherited from class de.hybris.platform.jalo.media.GeneratedMedia

addToDerivedMedias, addToDerivedMedias, getAltText, getAltText, getCode, getCode, getDerivedMedias, getDerivedMedias, getDescription, getDescription, getFolder, getInternalURL, getInternalURL, getMediaContainer, getMediaContainer, getMediaFormat, getMediaFormat, getSubFolderPath, getSubFolderPath, isRemovable, isRemovable, isRemovableAsPrimitive, removeFromDerivedMedias, removeFromDerivedMedias, setAltText, setAltText, setCode, setCode, setDerivedMedias, setDerivedMedias, setDescription, setDescription, setFolder, setFolder, setInternalURL, setInternalURL, setMediaContainer, setMediaContainer, setMediaFormat, setMediaFormat, setRemovable, setRemovable, setRemovable, setRemovable, setSubFolderPath, setSubFolderPath

Methods inherited from class de.hybris.platform.jalo.media.GeneratedAbstractMedia

getDataPK, getDataPK, getDataPKAsPrimitive, getDataPKAsPrimitive, getLocation, getLocationHash, getLocationHash, getMime, getMime, getRealFileName, getRealFileName, getSize, getSize, getSizeAsPrimitive, getSizeAsPrimitive, setDataPK, setDataPK, setDataPK, setLocation, setLocation, setLocationHash, setLocationHash, setMime, setMime, setRealFileName, setRealFileName, setSize, setSize, setSize

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

getImplementation, getInitialProperties, getNonInitialAttributes, getRelatedItems, 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, 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, getPartOfRemovedSessionMarker, 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, suppressRelation, 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 Details

ItemFormatter

public ItemFormatter()

Method Details

format

public abstract Media format(Item item)
                      throws JaloBusinessException

Throws:

JaloBusinessException