com.day.cq.dam.word.extraction

Class WordExtractionHandler

java.lang.Object

com.day.cq.dam.indd.AbstractPageExtractionHandler

com.day.cq.dam.word.extraction.WordExtractionHandler

All Implemented Interfaces:

PageExtractionHandler

public class WordExtractionHandler
extends AbstractPageExtractionHandler

A PageExtractionHandler for Word's DOCX and DOC format.

An extraction handler to extract a page from a Word .docx and .doc files.

See Also:

PageExtractionHandler

Field Summary

Fields inherited from interface com.day.cq.dam.indd.PageExtractionHandler

SERVICE_PROPERTY_DESCRIPTION, SERVICE_PROPERTY_LABEL

Constructor Summary

Constructors

Constructor and Description
WordExtractionHandler()

Method Summary

Modifier and Type	Method and Description
Page	extractPage(Rendition rend, java.lang.String pageRoot, java.lang.String pageName, java.lang.String pageTitle, java.lang.String pageTemplate, java.lang.String pageDesign) Extract a Page from the given Rendition.
RenditionPicker	getRenditionPicker() Get an MS Word targeted rendition picker.

Methods inherited from class java.lang.Object

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

Constructor Detail

WordExtractionHandler

public WordExtractionHandler()

Method Detail

getRenditionPicker

public RenditionPicker getRenditionPicker()

Get an MS Word targeted rendition picker.

Get the rendition picker.

Implementations must provide a RenditionPicker to indicate what renditions they can handle.

Returns:

The rendition picker.

extractPage

public Page extractPage(Rendition rend,
                        java.lang.String pageRoot,
                        java.lang.String pageName,
                        java.lang.String pageTitle,
                        java.lang.String pageTemplate,
                        java.lang.String pageDesign)
                 throws PageExtractionException

Extract a Page from the given Rendition.

The parameters are set by the configuration of the com.day.cq.dam.indd.process.INDDPageExtractProcess.

Parameters:

rend - The renditions to extract the page from.

pageRoot - The root path for the page.

pageName - The page name.

pageTitle - The page title.

pageTemplate - The page template.

pageDesign - The design

Returns:

Page The extracted page.

Throws:

PageExtractionException - exception caused in extracting page.