public abstract class ElementBaseTag extends BaseTag
An abstract tag class which generates the data required for an analytics vendor to trigger
a intra-page content event. The generated data is placed in a HashMap
object
paramMap
which the analytics vendor classes can consume. The value for all the
keys in the HashMap
, except for EXTRA_PARAMS, are String
objects.
The value for EXTRA_PARAMS will be an ArrayList
object which inturn contain
String
objects
Following is the structure of the HashMap
object. The keys used in the map are
defined in the TagConstants
class.
+------------------------------------------------------------+ | ELEMENT_ID | The value of the elementId attribute | +------------------------------------------------------------+ | CATEGORY | The category to which the element belongs | +------------------------------------------------------------+ | PAGE_ID | The page identifier where the element is | | | placed | +------------------------------------------------------------+ | PAGE_CATEGORY | The category of the page | +------------------------------------------------------------+ | EXTRA_PARAMS | The extra parameters which the users | | | want to send along with the element | | | tag. The value for this key will be an | | | object of type 'java.util.ArrayList' | | | which inturn contains String objects | +------------------------------------------------------------+ | STORE_ID | The store identifier | +------------------------------------------------------------+
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM copyright notice field.
|
Constructor and Description |
---|
ElementBaseTag() |
Modifier and Type | Method and Description |
---|---|
int |
doStartTag()
Gathers the required data to trigger the event data.
|
java.lang.String |
getDataAsJSON()
Returns the analytics data in a JSON format
|
java.util.HashMap<java.lang.String,java.lang.Object> |
getParamMap()
Returns the element data map which contain the data required for an analytics
vendor to invoke a element view event
|
boolean |
isReturnAsJSON()
Checks whether the tag need to return the data as JSON
|
void |
setCategory(java.lang.String categoryVar)
Sets the category to which the element belongs
|
void |
setElementId(java.lang.String elementIdVar)
Sets the elementId value
|
void |
setExtraparms(java.lang.String extraparmsVar)
Sets the additional parameters that should be passed in the page view map
|
void |
setLocation(java.lang.String locationVar)
Sets the location value
|
void |
setPageCategory(java.lang.String pageCategoryVar)
Sets the page category value
|
void |
setPageId(java.lang.String pageIdVar)
Sets the pageId value
|
void |
setReturnAsJSON(boolean flag)
Sets the boolean value whether to return the data as JSON
|
getBiprovider, getCategoryIdForProduct, getCollator, getCommandContext, getConfig, getNumberFormat, getOptionValue, getStoreId, isDebug, isOptionDisabled, isOptionEnabled, setBiprovider, setDebug
public static final java.lang.String COPYRIGHT
public int doStartTag() throws javax.servlet.jsp.JspException
doStartTag
in interface javax.servlet.jsp.tagext.Tag
doStartTag
in class BaseTag
EVAL_PAGE
constantjavax.servlet.jsp.JspException
- on any Exceptionpublic java.util.HashMap<java.lang.String,java.lang.Object> getParamMap()
public void setCategory(java.lang.String categoryVar)
categoryVar
- The category to which the element belongspublic void setExtraparms(java.lang.String extraparmsVar)
extraparmsVar
- The additional parameters that will be passed in the page
view map. Fields delimited by $ will be assumed to be methods applied to
com.ibm.commerce.search.beans.CatEntrySearchListDataBean
.public java.lang.String getDataAsJSON()
public boolean isReturnAsJSON()
public void setReturnAsJSON(boolean flag)
flag
- The boolean value whether to return the data as JSONpublic void setElementId(java.lang.String elementIdVar)
elementIdVar
- The elementId to setpublic void setPageId(java.lang.String pageIdVar)
pageIdVar
- The pageId value to setpublic void setPageCategory(java.lang.String pageCategoryVar)
pageCategoryVar
- The page category value to setpublic void setLocation(java.lang.String locationVar)
locationVar
- The location value to set