com.day.cq.dam.handler.standard.pdf

Class PdfHandler

java.lang.Object

com.day.cq.dam.commons.handler.AbstractAssetHandler

com.day.cq.dam.handler.standard.pdf.PdfHandler

All Implemented Interfaces:

AssetHandler

Direct Known Subclasses:

PostScriptHandler

public class PdfHandler
extends AbstractAssetHandler

The PdfHandler class ... handles pdfs and illustrator files.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTENT_MIMETYPE Mime type

Fields inherited from class com.day.cq.dam.commons.handler.AbstractAssetHandler

PROPERTY_DEACTIVATED_MIME_TYPES

Constructor Summary

Constructors

Constructor and Description
PdfHandler()

Method Summary

Modifier and Type	Method and Description
boolean	canHandleSubAssets() Indicates if the handler supports processing of sub assets
ExtractedMetadata	extractMetadata(Asset asset) This method is used by the ExtractMetadataProcess as part of the DAM Update Asset workflow during import or update of an asset.
java.awt.image.BufferedImage	getImage(Rendition rendition) This method retrieves the graphical representation of an Assets given Rendition.
java.awt.image.BufferedImage	getImage(Rendition rendition, java.awt.Dimension dim) This method retrieves the graphical representation of an Assets given Rendition.
java.lang.String[]	getMimeTypes() This method returns the mime types a particular AssetHandler supports.
ByteWriter	getRAFByteWriter(java.io.File file)
java.util.Iterator<? extends AssetRelation>	processRelated(Asset asset) extracts and stores the links to the assets related with provided asset.
java.util.List<java.lang.String>	processSubAssets(Asset asset) Handler implementations may choose to support sub asset creation for the file types it handles.

Methods inherited from class com.day.cq.dam.commons.handler.AbstractAssetHandler

createThumbnails, createThumbnails, createThumbnails, exportAsset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONTENT_MIMETYPE

public static final java.lang.String CONTENT_MIMETYPE

Mime type

See Also:

Constant Field Values

Constructor Detail

PdfHandler

public PdfHandler()

Method Detail

extractMetadata

public ExtractedMetadata extractMetadata(Asset asset)

This method is used by the ExtractMetadataProcess as part of the DAM Update Asset workflow during import or update of an asset. Implementations must return an ExtractedMetadata object, which may be empty if no metadata is extracted, or contains the metadata values extracted from the binary being imported/updated at the time. The ExtractMetadataProcess will later save the metadata contained in ExtractedMetadata to the asset's metadata node (e.g. /content/dam/geometrixx/banners/banner-mono.png/jcr:content/metadata). Implementations are free to decide which and how many metadata values are extracted.

The method argument represents the javax.jcr.Node of type nt:file holding the binary content or the DAM Asset node (type dam:Asset), for which its original rendition would be retrieved.

Parameters:

asset - The Asset, from whose original binary metadata will extracted.

Returns:

The extracted metadata.

getRAFByteWriter

public ByteWriter getRAFByteWriter(java.io.File file)
                            throws java.io.IOException

Throws:

java.io.IOException

canHandleSubAssets

public boolean canHandleSubAssets()

Indicates if the handler supports processing of sub assets

Specified by:

canHandleSubAssets in interface AssetHandler

Overrides:

canHandleSubAssets in class AbstractAssetHandler

Returns:

true if handler is able to process sub assets

processSubAssets

public java.util.List<java.lang.String> processSubAssets(Asset asset)

Handler implementations may choose to support sub asset creation for the file types it handles. The method is called by the CreateSubAssetsProcess during import/update of an asset and its binary, as part of the DAM Update Asset workflow. Sub assets represent fragments of the original asset, for example every page of a multi-page PDF document are sub assets. Sub assets are stored as assets themselves under the parent asset. Sub assets are stored in the subassets folder of the main asset, e.g. at /content/dam/geometrixx/documents/ECM Artikel.pdf/subassets.

The asset argument represents the javax.jcr.Node of type nt:file holding the binary content or the DAM Asset node (type dam:Asset), for which its original rendition would be retrieved.

Specified by:

processSubAssets in interface AssetHandler

Overrides:

processSubAssets in class AbstractAssetHandler

Parameters:

asset - asset to extract sub assets

Returns:

List constaining all paths to the newly created assets

See Also:

AssetHandler.canHandleSubAssets(), Asset.isSubAsset()

getMimeTypes

public java.lang.String[] getMimeTypes()

This method returns the mime types a particular AssetHandler supports.

Returns:

mime type, e.g. image/jpg

getImage

public java.awt.image.BufferedImage getImage(Rendition rendition)
                                      throws java.io.IOException

This method retrieves the graphical representation of an Assets given Rendition. For images the BufferedImage of the original image is returned, for other formats the first page is retrieved as BufferedImage

Specified by:

getImage in interface AssetHandler

Overrides:

getImage in class AbstractAssetHandler

Parameters:

rendition - The rendition for which to retrieve its graphical representation.

Returns:

BufferedImage if a graphical representation exists, otherwise null

Throws:

java.io.IOException - in case an error is thrown while fetching the buffered image

getImage

public java.awt.image.BufferedImage getImage(Rendition rendition,
                                             java.awt.Dimension dim)
                                      throws java.io.IOException

This method retrieves the graphical representation of an Assets given Rendition. For images the BufferedImage of the original image is returned, for other formats the first page is retrieved as BufferedImage.

If maxDimension is given, the handler should return an image where no dimension extends the given value. This can be used to reduce the memory footprint of large buffered images if the full resolution is not needed.

Specified by:

getImage in interface AssetHandler

Overrides:

getImage in class AbstractAssetHandler

Parameters:

rendition - The rendition for which to retrieve its graphical representation.

dim - optional constraint for the maximal dimension of the image.

Returns:

BufferedImage if a graphical representation exists, otherwise null

Throws:

java.io.IOException - in case an error is thrown while fetching the buffered image

processRelated

public java.util.Iterator<? extends AssetRelation> processRelated(Asset asset)

extracts and stores the links to the assets related with provided asset.

Specified by:

processRelated in interface AssetHandler

Overrides:

processRelated in class AbstractAssetHandler

Parameters:

asset - asset to process

Returns:

Iterator of AssetRelation or an empty iterator if no related assets are available