de.hybris.platform.print.util

Class PagePreviewTools

java.lang.Object

de.hybris.platform.print.util.PagePreviewTools

public class PagePreviewTools
extends Object

Provides utility methods for dealing with the page preview functionality.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CREATE_PREVIEW_BOTH
static int	CREATE_PREVIEW_IMAGES
static int	CREATE_PREVIEW_PDF

Constructor Summary

Constructors

Constructor and Description
PagePreviewTools()

Method Summary

Modifier and Type	Method and Description
static String	changeFileIDString(String oldFileID, PrintPublication publication) Change the given filename from the .crpt script (pdf: pagepreview_pdf_timestamp_indesignfilename.pdf, image: pagepreview_img_timestamp_full_(pagenumber)_indesignfilename.jpg) into a better media code (pdf: pdfprefix+page.pk+timestamp, image: imageprefix+page.pk+timestamp+imagenumber) This method also works if instead the indesignfilename the page id is trasmitted.
static void	createPreviewChapterJob(Chapter chapter, CometConstants.AutoCometJob status, EnumerationValue enumvalue, boolean useTemporaryFiles, Integer previewSize, EnumerationValue pdfPreset)
static void	createPreviewChapterJob(Chapter chapter, CometConstants.AutoCometJob status, EnumerationValue enumvalue, boolean useTemporaryFiles, Integer previewSize, EnumerationValue pdfPreset, int mode) Creates an AutoCometJob that creates previews for chapters
static void	createPreviewPageJob(Page page) Creates an AutoCometJob that creates previews for pages
static void	createPreviewPageJob(Page page, CometConstants.AutoCometJob status) Creates an AutoCometJob that creates previews for pages.
static void	createPreviewPageJob(Page page, CometConstants.AutoCometJob status, EnumerationValue enumvalue) Creates an AutoCometJob that creates previews for pages
static void	createPreviewPageJob(Page page, CometConstants.AutoCometJob status, EnumerationValue enumvalue, boolean useTemporaryFiles) Creates an AutoCometJob that creates previews for pages
static void	createPreviewPageJob(Page page, CometConstants.AutoCometJob status, EnumerationValue enumvalue, boolean useTemporaryFiles, Integer previewSize, EnumerationValue pdfPreset)
static void	createPreviewPageJob(Page page, CometConstants.AutoCometJob status, EnumerationValue enumvalue, boolean useTemporaryFiles, Integer previewSize, EnumerationValue pdfPreset, int mode) Creates an AutoCometJob that creates previews for pages
static void	createPreviewPublicationJob(Publication publication, CometConstants.AutoCometJob status, EnumerationValue enumvalue, boolean useTemporaryFiles, Integer previewSize, EnumerationValue pdfPreset)
static void	createPreviewPublicationJob(Publication publication, CometConstants.AutoCometJob status, EnumerationValue enumvalue, boolean useTemporaryFiles, Integer previewSize, EnumerationValue pdfPreset, int mode) Creates an AutoCometJob that creates previews for publication
static Item	getPageByIdentifier(String id, PrintPublication publication)
static Collection<CometFile>	getPagePreviewMedias(String searchstring) returns all medias which starts with the given code
static Collection<CometFile>	getPagePreviewPDFMedias(String scriptstring, PrintPublication publication) Returns for the given String which has to start with PrintConstants.PAGEPREVIEW_PDF_PREFIX and the given PrintPublication the Page from this publication.

Methods inherited from class java.lang.Object

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

Field Detail

CREATE_PREVIEW_IMAGES

public static final int CREATE_PREVIEW_IMAGES

See Also:

Constant Field Values

CREATE_PREVIEW_PDF

public static final int CREATE_PREVIEW_PDF

See Also:

Constant Field Values

CREATE_PREVIEW_BOTH

public static final int CREATE_PREVIEW_BOTH

See Also:

Constant Field Values

Constructor Detail

PagePreviewTools

public PagePreviewTools()

Method Detail

changeFileIDString

public static String changeFileIDString(String oldFileID,
                                        PrintPublication publication)
                                 throws CometException

Change the given filename from the .crpt script (pdf: pagepreview_pdf_timestamp_indesignfilename.pdf, image: pagepreview_img_timestamp_full_(pagenumber)_indesignfilename.jpg) into a better media code (pdf: pdfprefix+page.pk+timestamp, image: imageprefix+page.pk+timestamp+imagenumber) This method also works if instead the indesignfilename the page id is trasmitted.

Parameters:

oldFileID - the filename String from the 601.crpt script

publication - needed for finding the correct page

Returns:

the new generated media code

Throws:

CometException

getPagePreviewPDFMedias

public static Collection<CometFile> getPagePreviewPDFMedias(String scriptstring,
                                                            PrintPublication publication)
                                                     throws CometException

Returns for the given String which has to start with PrintConstants.PAGEPREVIEW_PDF_PREFIX and the given PrintPublication the Page from this publication.

Parameters:

scriptstring -

publication -

Returns:

Collection of CometFiles

Throws:

CometException

getPagePreviewMedias

public static Collection<CometFile> getPagePreviewMedias(String searchstring)

returns all medias which starts with the given code

Parameters:

searchstring -

Returns:

Collection of CometFiles

getPageByIdentifier

public static Item getPageByIdentifier(String id,
                                       PrintPublication publication)
                                throws CometException

Throws:

CometException

createPreviewPageJob

public static void createPreviewPageJob(Page page)

Creates an AutoCometJob that creates previews for pages

Parameters:

page - The Page for which to create the previews

createPreviewPageJob

public static void createPreviewPageJob(Page page,
                                        CometConstants.AutoCometJob status)

Creates an AutoCometJob that creates previews for pages. The created Job will not be deleted after fished.

Parameters:

page - The Page for which to create the previews

status - The AutoCometJob's initial status

createPreviewPageJob

public static void createPreviewPageJob(Page page,
                                        CometConstants.AutoCometJob status,
                                        EnumerationValue enumvalue)

Creates an AutoCometJob that creates previews for pages

Parameters:

page - The Page for which to create the previews

status - The AutoCometJob's initial status

enumvalue - These Job will be, depending of the enum, deleted

createPreviewPageJob

public static void createPreviewPageJob(Page page,
                                        CometConstants.AutoCometJob status,
                                        EnumerationValue enumvalue,
                                        boolean useTemporaryFiles)

Creates an AutoCometJob that creates previews for pages

Parameters:

page - The Page for which to create the previews

status - The AutoCometJob's initial status

enumvalue - These Job will be, depending of the enum, deleted

useTemporaryFiles - the indd file will be deleted by the comet plugin afterwards

createPreviewPageJob

public static void createPreviewPageJob(Page page,
                                        CometConstants.AutoCometJob status,
                                        EnumerationValue enumvalue,
                                        boolean useTemporaryFiles,
                                        Integer previewSize,
                                        EnumerationValue pdfPreset)

createPreviewChapterJob

public static void createPreviewChapterJob(Chapter chapter,
                                           CometConstants.AutoCometJob status,
                                           EnumerationValue enumvalue,
                                           boolean useTemporaryFiles,
                                           Integer previewSize,
                                           EnumerationValue pdfPreset)

createPreviewPublicationJob

public static void createPreviewPublicationJob(Publication publication,
                                               CometConstants.AutoCometJob status,
                                               EnumerationValue enumvalue,
                                               boolean useTemporaryFiles,
                                               Integer previewSize,
                                               EnumerationValue pdfPreset)

createPreviewPageJob

public static void createPreviewPageJob(Page page,
                                        CometConstants.AutoCometJob status,
                                        EnumerationValue enumvalue,
                                        boolean useTemporaryFiles,
                                        Integer previewSize,
                                        EnumerationValue pdfPreset,
                                        int mode)

Creates an AutoCometJob that creates previews for pages

Parameters:

page - The Page for which to create the previews

status - The AutoCometJob's initial status

enumvalue - These Job will be, depending of the enum, deleted

useTemporaryFiles - the indd file will be deleted by the comet plugin afterwards

previewSize - size of generated preview, if null then default value will be taken

pdfPreset - generated pdf will be of pdfPreset type, if null then default value will be taken

mode - - to create images, pdfs or both

createPreviewChapterJob

public static void createPreviewChapterJob(Chapter chapter,
                                           CometConstants.AutoCometJob status,
                                           EnumerationValue enumvalue,
                                           boolean useTemporaryFiles,
                                           Integer previewSize,
                                           EnumerationValue pdfPreset,
                                           int mode)

Creates an AutoCometJob that creates previews for chapters

Parameters:

chapter - The Chapter for which to create the previews

status - The AutoCometJob's initial status

enumvalue - These Job will be, depending of the enum, deleted

useTemporaryFiles - the indd file will be deleted by the comet plugin afterwards

previewSize - size of generated preview, if null then default value will be taken

pdfPreset - generated pdf will be of pdfPreset type, if null then default value will be taken

mode - - to create images, pdfs or both

createPreviewPublicationJob

public static void createPreviewPublicationJob(Publication publication,
                                               CometConstants.AutoCometJob status,
                                               EnumerationValue enumvalue,
                                               boolean useTemporaryFiles,
                                               Integer previewSize,
                                               EnumerationValue pdfPreset,
                                               int mode)

Creates an AutoCometJob that creates previews for publication

Parameters:

publication - The Publication for which to create the previews

status - The AutoCometJob's initial status

enumvalue - These Job will be, depending of the enum, deleted

useTemporaryFiles - the indd file will be deleted by the comet plugin afterwards

previewSize - size of generated preview, if null then default value will be taken

pdfPreset - generated pdf will be of pdfPreset type, if null then default value will be taken

mode - - to create images, pdfs or both