Interface FrameworkComponent
-
- All Superinterfaces:
InheritanceValueMap
,Map<String,Object>
,ValueMap
public interface FrameworkComponent extends InheritanceValueMap
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ValueMap
getAnalyticsProperties()
Returns aValueMap
of the componentsanalytics
node.MultiValueMap
getCqMappings()
Returns aMultiValueMap
of the CQ mapping, using CQ variables as keys.String
getPath()
Return the path of this component.JSONArray
getScVars(String cqVar)
Returns aJSONArray
of the SiteCatalyst mapping.String[]
getTrackedVarsEvents()
Returns a concatenated array of variable and event names.String
getType()
Returns the resource type of this component.Set<String>
inheritedKeySet()
Returns a set of SiteCatalyst variables mapped in this or inherited framework component.-
Methods inherited from interface com.day.cq.commons.inherit.InheritanceValueMap
getInherited, getInherited
-
Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
-
-
-
-
Method Detail
-
getType
String getType()
Returns the resource type of this component.- Returns:
- Resource type
-
getPath
String getPath()
Return the path of this component.- Returns:
- Component path
-
getTrackedVarsEvents
String[] getTrackedVarsEvents()
Returns a concatenated array of variable and event names.- Returns:
- String array of variable and event names
-
getCqMappings
MultiValueMap getCqMappings()
Returns aMultiValueMap
of the CQ mapping, using CQ variables as keys.- Returns:
MultiValueMap
of the CQ mapping
-
getScVars
JSONArray getScVars(String cqVar)
Returns aJSONArray
of the SiteCatalyst mapping.- Parameters:
cqVar
- CQ Variable- Returns:
- SiteCatalyst Mapping for given CQ Variable
-
inheritedKeySet
Set<String> inheritedKeySet()
Returns a set of SiteCatalyst variables mapped in this or inherited framework component.- Returns:
- Set of SiteCatalyst variable names.
-
-