com.day.cq.analytics.sitecatalyst

Class AnalyticsPageNameContext

java.lang.Object

com.day.cq.analytics.sitecatalyst.AnalyticsPageNameContext

public final class AnalyticsPageNameContext
extends Object

Context for Analytics pageName resolution. Provides access to key context objects like Framework and Resource.

Field Summary

Fields

Modifier and Type	Field and Description
static String	S_PAGE_NAME

Constructor Summary

Constructors

Constructor and Description
AnalyticsPageNameContext(Configuration configuration, Framework framework, ResourceResolver resourceResolver, Resource resource, String pageName, String basePath)

Method Summary

Modifier and Type	Method and Description
String	getBasePath() Getter for basePath
Configuration	getConfiguration() Getter for Configuration
Framework	getFramework() Getter for Framework
String	getPageName() Getter for pageName
Resource	getResource() Getter for Resource
ResourceResolver	getResourceResolver() Getter for ResourceResolver
void	setPageName(String pageName) Setter for pageName

Methods inherited from class java.lang.Object

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

Field Detail

S_PAGE_NAME

public static final String S_PAGE_NAME

See Also:

Constant Field Values

Constructor Detail

AnalyticsPageNameContext

public AnalyticsPageNameContext(Configuration configuration,
                                Framework framework,
                                ResourceResolver resourceResolver,
                                Resource resource,
                                String pageName,
                                String basePath)

Method Detail

getConfiguration

public Configuration getConfiguration()

Getter for Configuration

Returns:

the Configuration that defines the respective mapping

getFramework

public Framework getFramework()

Getter for Framework

Returns:

the Framework that defines the respective mapping

getResourceResolver

public ResourceResolver getResourceResolver()

Getter for ResourceResolver

Returns:

the ResourceResolver

getResource

public Resource getResource()

Getter for Resource

Returns:

the Resource that should be mapped

getPageName

public String getPageName()

Getter for pageName

Returns:

the pageName that should be mapped to a Resource in case AnalyticsPageNameResolver.getResource(AnalyticsPageNameContext) is called. Otherwise this can be null.

setPageName

public void setPageName(String pageName)

Setter for pageName

Parameters:

pageName - the pageName that should be mapped to a Resource in case AnalyticsPageNameResolver.getResource(AnalyticsPageNameContext) is called. Otherwise this can be null.

getBasePath

public String getBasePath()

Getter for basePath

Returns:

the basePath of the mapping. this is typically the path of the resource where the Configuration is set (parent of Resource or pageName). This can be null.