public abstract class AbstractPageLayoutActivityESpot
extends java.lang.Object
This class is used in conjunction with AbstractPageLayoutActivityHelper and AbstractPageLayoutActivity. A Page Layout Activity follows a naming convention where the ESpot Name itself identifies a specific Page, e.g. a name like "Category_1008" identifies that the ESpot corresponds to a Category Page and the Id of the Category is 10008. This class contains methods that parses the ESpot Name into different properties like page group, id, etc, and also contains methods to do the reverse - to build the ESpot Name for the specified properties.
| Modifier | Constructor and Description |
|---|---|
| AbstractPageLayoutActivityESpot()
Default Constructor.
|
|
| protected | AbstractPageLayoutActivityESpot(AbstractPageLayoutActivityESpot spot)
This is a Copy Constructor that does a shallow copy.
|
| protected | AbstractPageLayoutActivityESpot(java.lang.String properties)
This Constructor initializes the properties of the ESpot using a given Campaign Element Properties string.
|
| Modifier and Type | Method and Description |
|---|---|
| abstract java.lang.String | buildESpotName()
This method builds the ESpot Name using the ESpot properties present in this ESpot.
|
| protected abstract java.lang.String | buildProperties()
This method builds a properties string using the properties that are set in this ESpot.
|
| protected java.lang.String | get(java.lang.String key)
Returns the property value for the given property key.
|
| protected abstract void | parse(java.lang.String properties)
This method parses a given properties string into individual properties.
|
| protected void | put(java.lang.String key, java.lang.String value)
Puts a property into this ESpot.
|
| java.lang.String | toString()
Returns the string representation of the properties of this ESpot.
|
public AbstractPageLayoutActivityESpot()
protected AbstractPageLayoutActivityESpot(java.lang.String properties)
protected AbstractPageLayoutActivityESpot(AbstractPageLayoutActivityESpot spot)
protected final void put(java.lang.String key,
java.lang.String value)
protected final java.lang.String get(java.lang.String key)
public abstract java.lang.String buildESpotName()
The child classes that extend this class must implement this method according to the ESpot Naming Convention that it follows.
protected abstract void parse(java.lang.String properties)
The Campaign Element for an ESpot in an Activity only stores the ESpot Id as the Value. The ESpot properties, e.g. pageGroup, object Id, object name, etc are stored in a string format as the Campaign Element Properties.
For example, consider "pageGroup=Category;objectId=10008;objectName=Apparel" as the Campaign Element Properties for the ESpot. This method will parse the pageGroup, objectId and objectName from this string and put them into the properties Map of this ESpot by invoking put(String, String) e.g. put("pageGroup", "Category").
The child classes that extend this class must implement this method according to the ESpot Naming Convention and the Properties format that it uses.
protected abstract java.lang.String buildProperties()
The Page Layout Activity Framework uses this method to set the ESpot Campaign Element Properties while setting an ESpot in to the corresponding Page Layout Activity. Logically, this method does the reverse of parse(String).
The child classes that extend this class must implement this method according to the ESpot Naming Convention and the Properties format that it uses.
public java.lang.String toString()