com.tridion.smarttarget.utils

Class AmbientDataHelper

java.lang.Object

com.tridion.smarttarget.utils.AmbientDataHelper

public class AmbientDataHelper
extends Object

Exposes Ambient Data Framework functionality used by SmartTarget.

This class can be used to extract values from the ClaimStore and in composing FH query string parameters.

Field Summary

Fields

Modifier and Type	Field and Description
static URI	AUDIENCE_MANAGER_KEYWORDS AM Keywords Claim Uri.
static URI	AUDIENCE_MANAGER_SEGMENTS AM Segments Claim Uri.
protected static Logger	LOG
static URI	ONLINEMARKETINGEXPLORER_DATA Promotions Claim Uri.
static URI	TRIGGERTYPES_URI Defined Trigger Types Claim Uri.

Method Summary

Modifier and Type	Method and Description
static void	addComponentPresentation(String secondid, String compuri, String tempuri, String region, String promoId, String promoName, String promoTitle, String promoSlogan) Call this whenever a componentpresentaion is known to be outputted to the page.
protected static String	createTriggerName(URI uri) Gets the trigger name from a ClaimStore value URI.
protected static Map	getOmeData()
static Map<String,List<String>>	getTriggerMap(Map<URI,Object> claims) This method returns additional triggers to use in a Fredhopper query string.
static String	getTriggers(com.tridion.ambientdata.claimstore.ClaimStore claimStore) This method returns the SmartTarget Triggers found on the specified ClaimStore.
static String	getTriggers(Map<URI,Object> claims) This method returns additional triggers to use in a Fredhopper query string.
static void	initializeOmeData() Call this method when starting to loop over promotions/items.
static void	invalidateTriggerTypes(com.tridion.ambientdata.claimstore.ClaimStore claimStore) Deprecated. Trigger types are no longer stored in the claim store so there is no need to invalidate them.
static void	writeOmeData() Call this method when you are done looping over promotions/items.

Methods inherited from class java.lang.Object

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

Field Detail

TRIGGERTYPES_URI

public static final URI TRIGGERTYPES_URI

Defined Trigger Types Claim Uri.

ONLINEMARKETINGEXPLORER_DATA

public static final URI ONLINEMARKETINGEXPLORER_DATA

Promotions Claim Uri.

AUDIENCE_MANAGER_KEYWORDS

public static final URI AUDIENCE_MANAGER_KEYWORDS

AM Keywords Claim Uri.

AUDIENCE_MANAGER_SEGMENTS

public static final URI AUDIENCE_MANAGER_SEGMENTS

AM Segments Claim Uri.

LOG

protected static final Logger LOG

Method Detail

getTriggers

public static String getTriggers(Map<URI,Object> claims)

This method returns additional triggers to use in a Fredhopper query string.

The triggers get their values from the Ambient Data Framework ClaimStore, and are only added if a matching trigger has been configured in Fredhopper.

Parameters:

claims - map of all entries in the Claim Store. Can be retrieved by calling ClaimStore.fromSession(). getAll().

Returns:

valid FredHopper query parameters string that can be directly attached to the end of query string.

getTriggerMap

public static Map<String,List<String>> getTriggerMap(Map<URI,Object> claims)

This method returns additional triggers to use in a Fredhopper query string.

The triggers get their values from the Ambient Data Framework ClaimStore, and are only added if a matching trigger has been configured in Fredhopper.

Parameters:

claims - map of all entries in the Claim Store. Can be retrieved by calling ClaimStore.fromSession(). getAll().

Returns:

map of trigger names and values, which can be used to update the Fredhopper query directly or for adding criteria to the QueryBuilder.

getTriggers

public static String getTriggers(com.tridion.ambientdata.claimstore.ClaimStore claimStore)

This method returns the SmartTarget Triggers found on the specified ClaimStore.

Parameters:

claimStore - actual ClaimStore object. ClaimStore can be retrieved by calling ClaimStore.fromSession()

Returns:

valid FredHopper's query parameters string that can be directly attached to the end of FH query string.

invalidateTriggerTypes

@Deprecated
public static void invalidateTriggerTypes(com.tridion.ambientdata.claimstore.ClaimStore claimStore)

Deprecated. Trigger types are no longer stored in the claim store so there is no need to invalidate them.

Removes list of defined trigger types from claim store.

Parameters:

claimStore - The ClaimStore to remove the TriggerTypes from.

createTriggerName

protected static String createTriggerName(URI uri)

Gets the trigger name from a ClaimStore value URI.

Parameters:

uri - the URI of the key in the ClaimStore.

Returns:

the trigger name.

getOmeData

protected static Map getOmeData()

initializeOmeData

public static void initializeOmeData()

Call this method when starting to loop over promotions/items.

writeOmeData

public static void writeOmeData()

Call this method when you are done looping over promotions/items.

addComponentPresentation

public static void addComponentPresentation(String secondid,
                                            String compuri,
                                            String tempuri,
                                            String region,
                                            String promoId,
                                            String promoName,
                                            String promoTitle,
                                            String promoSlogan)

Call this whenever a componentpresentaion is known to be outputted to the page.

Parameters:

secondid - the secondid of the item

compuri - its component uri

tempuri - its template uri

region - the region in which the cp will be shown

promoId - the Id of the Promotion in which the item will be shown

promoName - the Name of the Promotion in which the item will be shown

promoTitle - the title of the Promotion in which the item will be shown

promoSlogan - the Slogan of the Promotion in which the item will be shown