Package de.hybris.platform.commons.jalo

Class FOPFormatter

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

de.hybris.platform.commons.jalo.MediaFormatter

de.hybris.platform.commons.jalo.GeneratedFOPFormatter

de.hybris.platform.commons.jalo.FOPFormatter

All Implemented Interfaces:

Serializable, Comparable

public class FOPFormatter
extends GeneratedFOPFormatter

This Implementation of the Formatter class transform a given xml-fo file (as parameter of the method format(Media)) with the given xslt file (the media of this class, use Media.setData(java.io.DataInputStream) and Media.getData() for access) into a pdf file (stored as return 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.GeneratedFOPFormatter

DEFAULT_INITIAL_ATTRIBUTES

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

FORMAT2MEDFORREL_MARKMODIFIED, FORMAT2MEDFORREL_SRC_ORDERED, FORMAT2MEDFORREL_TGT_ORDERED, FORMATS, INPUTMIMETYPE

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

Method Summary

Modifier and Type	Method	Description
Media	format(Media media)	Transform the given media (xml file) with the attached media (xslt file) into a new media (xml/pdf file)
Media	format(InputStream inputStream)
protected org.apache.fop.configuration.Configuration	loadConfig(String fopConfigXml)	Loads configuration either from file or from classpath resource.
protected boolean	validate(File temporaryFile)	Validation of the temp file if it is of MimeConstants.MIME_PDF type

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

getDefaultAttributeModes

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

addToFormats, addToFormats, getFormats, getFormats, getFormatsCount, getFormatsCount, getInputMimeType, getInputMimeType, isMarkModifiedDisabled, removeFromFormats, removeFromFormats, setFormats, setFormats, setInputMimeType, setInputMimeType

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

FOPFormatter

public FOPFormatter()

Method Details

format

public Media format(Media media)

Description copied from class: MediaFormatter

Transform the given media (xml file) with the attached media (xslt file) into a new media (xml/pdf file)

Specified by:

format in class MediaFormatter

Parameters:

media - a media from an ItemFormatter or other MediaFormatter(s)

Returns:

a media which contains the transformed data

format

public Media format(InputStream inputStream)
             throws JaloSystemException

Throws:

JaloSystemException

loadConfig

protected org.apache.fop.configuration.Configuration loadConfig(String fopConfigXml)
                                                         throws org.apache.fop.configuration.ConfigurationException,
SAXException,
IOException

Loads configuration either from file or from classpath resource. Glassfish classloader compatible.

Throws:

IOException

SAXException

org.apache.fop.configuration.ConfigurationException

validate

protected boolean validate(File temporaryFile)
                    throws IllegalArgumentException,
IOException

Validation of the temp file if it is of MimeConstants.MIME_PDF type

Parameters:

temporaryFile -

Throws:

IllegalArgumentException

IOException