com.tridion.smarttarget.utils

Class ParamHelper

java.lang.Object

com.tridion.smarttarget.utils.ParamHelper

public class ParamHelper
extends Object

ParamHelper.

Method Summary

Modifier and Type	Method and Description
static String	combineUri(String componentUri, String templateUri, boolean escape) Creates a combined URI from the specified Component and Template URIs.
static OffsetDateTime	dateTimeFromObject(Object input)
static Double	doubleFromObject(Object input)
static String	escapeAttributeValue(String name, String text) Escapes a string so that it can be used to filter a query using an attribute in Elasticsearch.
static String	escapeAttributeValue(String name, String text, boolean isIdentifiableFieldValue) Escapes a string so that it can be used to filter a query using an attribute in Elasticsearch.
static List<String>	escapeAttributeValues(String name, List<String> values) Escapes a List of strings so that it can be used to filter a query using an attribute in Elasticsearch.
static String	escapeIdentifier(String text) Escapes a string so that it can be used for an identifier attribute in Elasticsearch.
static String	getBaseUri(String tcmUri) Get the base part of an URI.
static String	getComponentUri(String combinedUri, boolean escape) Gets the componentUri from a combinedUri.
static String	getLocationFromKeyword(String keywordUri)
static String	getTemplateUri(String combinedUri, boolean escape) Gets the templateUri from a combinedUri.
static Boolean	isPathRooted(String path) Gets a value indicating whether the specified path string contains absolute or relative path information.
static String	parseReferrerQuery(String referrerUrl) Parses the specified referrer string using the SmartTarget referrer configuration and returns the search query if successful.
static String	stringToMD5(String value) Creates an MD5 checksum for a given String.
static String	urlDecode(String text) Decodes a application/x-www-form-urlencoded string using a specific encoding scheme.
static String	urlEncode(String text) Translates a string into application/x-www-form-urlencoded format using UTF-8 as the encoding scheme.
static String	urlEncodeAndSpace(String text) Translates a string into application/x-www-form-urlencoded format using UTF-8 as the encoding scheme.

Methods inherited from class java.lang.Object

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

Method Detail

getComponentUri

public static String getComponentUri(String combinedUri,
                                     boolean escape)

Gets the componentUri from a combinedUri.

Parameters:

combinedUri - a combination of a component and a template Uri

escape - if true replaces the : with a _

Returns:

a string representation of a component Uri

getTemplateUri

public static String getTemplateUri(String combinedUri,
                                    boolean escape)

Gets the templateUri from a combinedUri.

Parameters:

combinedUri - a combination of a component and a template Uri

escape - if true replaces the : with a _

Returns:

a string representation of a template Uri

combineUri

public static String combineUri(String componentUri,
                                String templateUri,
                                boolean escape)

Creates a combined URI from the specified Component and Template URIs.

Parameters:

componentUri - a component Uri

templateUri - a template Uri

escape - if true replaces all : by _

Returns:

the combined URI as a string.

getBaseUri

public static String getBaseUri(String tcmUri)

Get the base part of an URI. This method removes for example the "-16" that is appended to a component URI if that is present.

Parameters:

tcmUri - The URI to get the base part of.

Returns:

The base part of the URI (with for example the "-16" removed).

escapeIdentifier

public static String escapeIdentifier(String text)

Escapes a string so that it can be used for an identifier attribute in Elasticsearch. A Elasticsearch identifier attribute can only contain digits, underscores and lower-case letters.

Parameters:

text - The text to escape.

Returns:

The escaped text.

escapeAttributeValue

public static String escapeAttributeValue(String name,
                                          String text)

Escapes a string so that it can be used to filter a query using an attribute in Elasticsearch.

Parameters:

name - the name of the attribute.

text - The text to escape.

Returns:

The escaped text.

escapeAttributeValue

public static String escapeAttributeValue(String name,
                                          String text,
                                          boolean isIdentifiableFieldValue)

Escapes a string so that it can be used to filter a query using an attribute in Elasticsearch.

Parameters:

name - the name of the attribute.

text - The text to escape.

isIdentifiableFieldValue - Set to True if this attribute represents a field that should be an 'identifiable' list field.

Returns:

The escaped text.

escapeAttributeValues

public static List<String> escapeAttributeValues(String name,
                                                 List<String> values)

Escapes a List of strings so that it can be used to filter a query using an attribute in Elasticsearch.

Parameters:

values - The list of strings to escape.

Returns:

List of escaped attribute values.

urlEncode

public static String urlEncode(String text)

Translates a string into application/x-www-form-urlencoded format using UTF-8 as the encoding scheme.

Parameters:

text - The value to encode.

Returns:

The url-encoded version of the supplied value.

urlEncodeAndSpace

public static String urlEncodeAndSpace(String text)

Translates a string into application/x-www-form-urlencoded format using UTF-8 as the encoding scheme. replaces spaces by %20 instead of +

Parameters:

text - The value to encode.

Returns:

The url-encoded version of the supplied value.

urlDecode

public static String urlDecode(String text)

Decodes a application/x-www-form-urlencoded string using a specific encoding scheme.

Parameters:

text - The value to decode.

Returns:

The decode version of the url-encoded value.

parseReferrerQuery

public static String parseReferrerQuery(String referrerUrl)
                                 throws com.tridion.smarttarget.SmartTargetException

Parses the specified referrer string using the SmartTarget referrer configuration and returns the search query if successful.

Parameters:

referrerUrl - The referrer string that should be parsed.

Returns:

The search query (such as 'cars') if parsing was successful, otherwise a null.

Throws:

com.tridion.smarttarget.SmartTargetException

isPathRooted

public static Boolean isPathRooted(String path)

Gets a value indicating whether the specified path string contains absolute or relative path information.

Parameters:

path - The path to test.

Returns:

true if path contains an absolute path; otherwise, false.

getLocationFromKeyword

public static String getLocationFromKeyword(String keywordUri)

Parameters:

keywordUri - The Keyword to use when querying for dynamic facet promotions

stringToMD5

public static String stringToMD5(String value)

Creates an MD5 checksum for a given String.

Parameters:

value - The string to generate the MD5 checksum for.

Returns:

An MD5 checksum.

dateTimeFromObject

public static OffsetDateTime dateTimeFromObject(Object input)

doubleFromObject

public static Double doubleFromObject(Object input)