de.hybris.platform.print.comet.utils

Class CometPrintTools

java.lang.Object

de.hybris.platform.print.comet.utils.CometPrintTools

public class CometPrintTools
extends Object

Provides utility methods that are useful while processing Werk II Comet requests.

Field Summary

Fields

Modifier and Type	Field and Description
static char	COMET_EMPTY_STRING_MARGKER_CHARACTER
static String	COMET_EMPTY_STRING_MARGKER_TAG
static String	INDESIGN_NORMAL_PARAGRAPH_STYLE_TAG

Constructor Summary

Constructors

Constructor and Description
CometPrintTools()

Method Summary

Modifier and Type	Method and Description
static String	createW2CrossreferenceSource(Item sourceItem, Item targetItem, SessionContext ctx) Creates a Werk II crossreference source tag / <w2: ...> tag for the given source and target item
static String	createW2CrossreferenceSource(Item source, String itemLink, SessionContext ctx) Converts an itemlink to a Werk II crossreference source tag / <w2: ...> tag
static String	createW2CrossreferenceSource(String sourceItemPK, String itemLink) Converts an itemlink to a Werk II crossreference source tag / <w2: ...> tag
static String	createW2CrossreferenceSourceForPKs(String sourceItemPK, String targetItemPK, SessionContext ctx, String linkId, String replacementType) Creates a Werk II crossreference source tag / <w2: ...> tag for the given source and target item
static String	createW2CrossreferenceTarget(Item targetItem, String displayName, SessionContext ctx) Creates a Werk II crossreference target tag / <w2cross: ...> tag for the given target item
static String	createW2CrossreferenceTarget(String itemLink, String displayName, SessionContext ctx) Converts an itemlink to a Werk II crossreference target tag / <w2cross: ...> tag
static Node	getChildNodeByName(Node node, String childNodeName) Returns the first found child node with the specified (local)name
static String	getCompletePath(SessionContext ctx, String pathTemplate) Tries to resolve the variables in a given path template and returns the resulting path. A path template e.g.
static String	getCompletePath(String pathTemplate) Tries to resolve the variables in a given path template and returns the resulting path. A path template e.g.
static List<? extends PrintPublication>	getPublications()
static String	normalizePath(String path)
static Map<String,CometCondition>	parseConditions(Map<String,CometCondition> map, CometCondition[] conditions) Parses the given conditions
static Map<String,String>	parseParameters(String parameters) Parses the parameters specified in the given String
static double	pixToPt(double dim) Converts dimensions specified in pixel to pt (point).
static double	pixToPt(double dim, JaloTranslatorConfiguration translatorConfig) Converts dimensions specified in pixel to pt (point).
static String	prepareLineBreaksForInDesign(String text) Converts the different Windows, Linux or MacOS style line breaks to InDesign specific entities This prevents problems with Windows-style linebreaks that lead to "double linebreaks" in InDesign
static String	removeHTMLFormattings(String text) Removes all HTML tags from the given string. Converts all kinds of line breaks to '\n'.
static String	removeInDesignFormattings(String text) Removes any TaggedText tags from the given text. Converts all kinds of line breaks to '\n'.
static String	removeQuotes(String quotedString) Removes surrounding quote characters (' and ") (ATTENTION: Works only if a string has the same signs at the beginning and at the end.)
static void	writeTagWithValue(XMLOutputter xmlOut, String tag, Double value) Writes the tag with the given Double value.
static void	writeTagWithValue(XMLOutputter xmlOut, String tag, Integer value) Writes the tag with the given Integer value.
static void	writeTagWithValue(XMLOutputter xmlOut, String tag, String value) Writes the tag with the given text value.

Methods inherited from class java.lang.Object

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

Field Detail

COMET_EMPTY_STRING_MARGKER_TAG

public static final String COMET_EMPTY_STRING_MARGKER_TAG

See Also:

Constant Field Values

COMET_EMPTY_STRING_MARGKER_CHARACTER

public static final char COMET_EMPTY_STRING_MARGKER_CHARACTER

See Also:

Constant Field Values

INDESIGN_NORMAL_PARAGRAPH_STYLE_TAG

public static final String INDESIGN_NORMAL_PARAGRAPH_STYLE_TAG

See Also:

Constant Field Values

Constructor Detail

CometPrintTools

public CometPrintTools()

Method Detail

parseConditions

public static Map<String,CometCondition> parseConditions(Map<String,CometCondition> map,
                                                         CometCondition[] conditions)
                                                  throws InvalidParameterException

Parses the given conditions

Parameters:

map - The map where to store the conditions in

conditions - The array that contains Comet conditions

Returns:

A HashMap that contains the given conditions as: Key:String to Value:CometCondition pairs

Throws:

InvalidParameterException - If the conditions are unspecified

parseParameters

public static Map<String,String> parseParameters(String parameters)
                                          throws InvalidParameterException

Parses the parameters specified in the given String

Parameters:

parameters - The String that contains Comet action parameters

Returns:

A HashMap that contains the given parameters as: Key:String to Value:String pairs

Throws:

InvalidParameterException - If the parameters are unspecified

removeQuotes

public static String removeQuotes(String quotedString)

Removes surrounding quote characters (' and ")
(ATTENTION: Works only if a string has the same signs at the beginning and at the end.)

Parameters:

quotedString - The String that is surrounded by quote characters

Returns:

The String without the surrounding quote characters

removeInDesignFormattings

public static String removeInDesignFormattings(String text)

Removes any TaggedText tags from the given text.
Converts all kinds of line breaks to '\n'.

Parameters:

text - The String that contains formatting tags

Returns:

The String without the formatting tags

removeHTMLFormattings

public static String removeHTMLFormattings(String text)

Removes all HTML tags from the given string.
Converts all kinds of line breaks to '\n'.

Parameters:

text - The String that contains formatting tags

Returns:

The String without the formatting tags

prepareLineBreaksForInDesign

public static String prepareLineBreaksForInDesign(String text)

Converts the different Windows, Linux or MacOS style line breaks to InDesign specific entities
This prevents problems with Windows-style linebreaks that lead to "double linebreaks" in InDesign

 Windows = CR+LF   0D+0A    \r\n
 Unix    = LF         0A      \n
 Mac     = CR      0D       \r
 

Parameters:

text - The text wherein to convert the line breaks symbols

Returns:

The text containing InDesign specific line break entities instead of line break characters

getChildNodeByName

public static Node getChildNodeByName(Node node,
                                      String childNodeName)

Returns the first found child node with the specified (local)name

Parameters:

node - The node in which's child nodes to find a node with the given (local)name

childNodeName - The (local, unqualified) name of the child node

Returns:

The first found child node with the specified (local)name

pixToPt

public static double pixToPt(double dim)

Converts dimensions specified in pixel to pt (point).

Parameters:

dim - dimension specified in pixel

Returns:

dimension in pt

pixToPt

public static double pixToPt(double dim,
                             JaloTranslatorConfiguration translatorConfig)

Converts dimensions specified in pixel to pt (point).

Parameters:

dim - dimension specified in pixel

translatorConfig - The JaloTranslatorConfiguration from where to get the configured multiplier

Returns:

dimension in pt

writeTagWithValue

public static void writeTagWithValue(XMLOutputter xmlOut,
                                     String tag,
                                     String value)
                              throws IOException

Writes the tag with the given text value.

Parameters:

xmlOut -

tag -

value -

Throws:

IOException

writeTagWithValue

public static void writeTagWithValue(XMLOutputter xmlOut,
                                     String tag,
                                     Integer value)
                              throws IOException

Writes the tag with the given Integer value.

Parameters:

xmlOut -

tag -

value -

Throws:

IOException

writeTagWithValue

public static void writeTagWithValue(XMLOutputter xmlOut,
                                     String tag,
                                     Double value)
                              throws IOException

Writes the tag with the given Double value.

Parameters:

xmlOut -

tag -

value -

Throws:

IOException

createW2CrossreferenceTarget

public static String createW2CrossreferenceTarget(String itemLink,
                                                  String displayName,
                                                  SessionContext ctx)
                                           throws JaloBusinessException,
                                                  JaloInvalidParameterException,
                                                  JaloItemNotFoundException

Converts an itemlink to a Werk II crossreference target tag / <w2cross: ...> tag

Parameters:

itemLink - The textual item link

displayName - The name that is used in InDesign to display the crossreference (may be null)

ctx - The SessionContext

Returns:

The itemlink as <w2cross: ...> tag

Throws:

JaloBusinessException - If an error occured while resolving the item link

JaloInvalidParameterException - If there is no or more then one item found

JaloItemNotFoundException - If the referenced item could not be found

createW2CrossreferenceTarget

public static String createW2CrossreferenceTarget(Item targetItem,
                                                  String displayName,
                                                  SessionContext ctx)

Creates a Werk II crossreference target tag / <w2cross: ...> tag for the given target item

Parameters:

targetItem - The target item

displayName - The name that is used in InDesign to display the crossreference (may be null)

ctx - The SessionContext

Returns:

A <w2cross: ...> tag

createW2CrossreferenceSource

public static String createW2CrossreferenceSource(Item source,
                                                  String itemLink,
                                                  SessionContext ctx)
                                           throws JaloBusinessException,
                                                  JaloInvalidParameterException,
                                                  JaloItemNotFoundException

Converts an itemlink to a Werk II crossreference source tag / <w2: ...> tag

Parameters:

source - The source item that references to another item with the given textual item link

itemLink - The textual item link

ctx - The SessionContext

Returns:

The itemlink as <w2: ...> tag

Throws:

JaloBusinessException - If an error occured while resolving the item link

JaloInvalidParameterException - If there is no or more then one item found

JaloItemNotFoundException - If the referenced item could not be found

createW2CrossreferenceSource

public static String createW2CrossreferenceSource(String sourceItemPK,
                                                  String itemLink)
                                           throws JaloBusinessException,
                                                  JaloInvalidParameterException,
                                                  JaloItemNotFoundException

Converts an itemlink to a Werk II crossreference source tag / <w2: ...> tag

Parameters:

sourceItemPK - The PK of the source item that references to another item with the given textual item link

itemLink - The textual item link

Returns:

The itemlink as <w2: ...> tag

Throws:

JaloBusinessException - If an error occured while resolving the item link

JaloInvalidParameterException - If there is no or more then one item found

JaloItemNotFoundException - If the referenced item could not be found

createW2CrossreferenceSource

public static String createW2CrossreferenceSource(Item sourceItem,
                                                  Item targetItem,
                                                  SessionContext ctx)

Creates a Werk II crossreference source tag / <w2: ...> tag for the given source and target item

Parameters:

sourceItem - The source item that references to the target item

targetItem - The target item where the crossreference links to

ctx - The SessionContext

Returns:

A <w2: ...> tag

createW2CrossreferenceSourceForPKs

public static String createW2CrossreferenceSourceForPKs(String sourceItemPK,
                                                        String targetItemPK,
                                                        SessionContext ctx,
                                                        String linkId,
                                                        String replacementType)

Creates a Werk II crossreference source tag / <w2: ...> tag for the given source and target item

Parameters:

sourceItemPK - The PK of the source item that references to the target item

targetItemPK - The PK of the target item where the crossreference links to

ctx - The SessionContext

Returns:

A <w2: ...> tag

getPublications

public static List<? extends PrintPublication> getPublications()

getCompletePath

public static String getCompletePath(String pathTemplate)

Tries to resolve the variables in a given path template and returns the resulting path.
A path template e.g. like {pathPrefix:aPrefixeID}/{user_ID}/further/path/and/filename.extension
would be translated e.g. to /home/users/johndoe/further/path/and/filename.extension

Parameters:

pathTemplate - A path template that might contain several variables

Returns:

The path with resolved variables

getCompletePath

public static String getCompletePath(SessionContext ctx,
                                     String pathTemplate)

Tries to resolve the variables in a given path template and returns the resulting path.
A path template e.g. like {pathPrefix:aPrefixeID}/{user_ID}/further/path/and/filename.extension
would be translated e.g. to /home/users/johndoe/further/path/and/filename.extension

Parameters:

ctx - The SessionContext

pathTemplate - A path template that might contain several variables

Returns:

The path with resolved variables

normalizePath

public static String normalizePath(String path)