com.adobe.cq.mobile.angular.data.util

Class FrameworkContentExporterUtils

java.lang.Object

com.adobe.cq.mobile.angular.data.util.FrameworkContentExporterUtils

public class FrameworkContentExporterUtils
extends java.lang.Object

Utility class for exporting content in a manner consistent with client side framework expectations

Since:

CQ 6.0 AdobePatentID="3773US01"

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NG_FRAMEWORK_TYPE_ID
static java.lang.String	NG_PAGE_RESOURCE_TYPE

Constructor Summary

Constructors

Constructor and Description
FrameworkContentExporterUtils()

Method Summary

Modifier and Type	Method and Description
static java.util.List<Page>	getAllAngularDescendantPages(Page page, PageFilter pageFilter)
static java.util.List<Resource>	getAllAngularPageComponents(Resource pageContentResource) Returns a list of all the 'angular' components that are descendants of the given resource.
static Resource	getAncestorTemplateResource(Resource resource, java.lang.String resourceType) Determines the nearest ancestor template resource.
static java.lang.String	getJsFriendlyResourceName(java.lang.String resourcePath) Returns a Javascript-friendly String to identify this resource.
static long	getMillisecondsSinceUnixEpoch() Returns the number of milliseconds since the UNIX epoch.
static java.lang.String	getPathToAsset(Resource parentResource, java.lang.String absoluteDescendantAssetPath, boolean appExport) Returns a path to the given asset.
static java.lang.String	getRelativeComponentPath(java.lang.String path) Trims a component path down to the substring following "jcr:content/".
static java.lang.String	getRelativePathToDescendantPath(Resource parentResource, java.lang.String absoluteDescendantPath) Returns a relative path from the parentResource to the absoluteDescendantPath
static java.lang.String	getRelativePathToDescendantResource(Resource parentResource, Resource descendantResource) Returns a relative path from the parentResource to the descendantResource.
static java.lang.String	getRelativePathToRootLevel(Resource resource) Returns a relative path to the root level nodes in the repository.
static Resource	getTopLevelAppResource(Resource resource) Returns a resource that is determined to be the top-level page in an application that resource is a descendant of.
static boolean	isTopLevelAppResource(Resource resource) Determines if this resource is the top level app resource.

Methods inherited from class java.lang.Object

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

Field Detail

NG_PAGE_RESOURCE_TYPE

public static final java.lang.String NG_PAGE_RESOURCE_TYPE

See Also:

Constant Field Values

NG_FRAMEWORK_TYPE_ID

public static final java.lang.String NG_FRAMEWORK_TYPE_ID

See Also:

Constant Field Values

Constructor Detail

FrameworkContentExporterUtils

public FrameworkContentExporterUtils()

Method Detail

getRelativePathToDescendantResource

public static java.lang.String getRelativePathToDescendantResource(Resource parentResource,
                                                                   Resource descendantResource)

Returns a relative path from the parentResource to the descendantResource.

Parameters:

parentResource - resulting path will be relative from this resource

descendantResource - descendant resource. Must be a descendant of parentResource

Returns:

a relative path or null if the descendantResource is not a descendant of parentResource

getRelativePathToDescendantPath

public static java.lang.String getRelativePathToDescendantPath(Resource parentResource,
                                                               java.lang.String absoluteDescendantPath)

Returns a relative path from the parentResource to the absoluteDescendantPath

Parameters:

parentResource - resulting path will be relative from this resource

absoluteDescendantPath - path to a descendant of parentResource

Returns:

a relative path or null if absoluteDescendantPath does not represent a descendant of parentResource

getPathToAsset

public static java.lang.String getPathToAsset(Resource parentResource,
                                              java.lang.String absoluteDescendantAssetPath,
                                              boolean appExport)

Returns a path to the given asset.

Parameters:

parentResource - path will be relative to this resource if appExport is true

absoluteDescendantAssetPath - absolute path to a descendant of parentResource

appExport - if true, content is being exported

Returns:

an absolute path if appExport is false, relative path (to parentResource) if appExport is true

getTopLevelAppResource

public static Resource getTopLevelAppResource(Resource resource)

Returns a resource that is determined to be the top-level page in an application that resource is a descendant of.

Parameters:

resource - the resource in question

Returns:

an ancestor of resource, or resource itself if it is the top-level page

isTopLevelAppResource

public static boolean isTopLevelAppResource(Resource resource)

Determines if this resource is the top level app resource.

Parameters:

resource - the resource in question

Returns:

true if this page is the top level app resource

getMillisecondsSinceUnixEpoch

public static long getMillisecondsSinceUnixEpoch()

Returns the number of milliseconds since the UNIX epoch.

Returns:

long, the current unix time

getAllAngularDescendantPages

public static java.util.List<Page> getAllAngularDescendantPages(Page page,
                                                                PageFilter pageFilter)

getJsFriendlyResourceName

public static java.lang.String getJsFriendlyResourceName(java.lang.String resourcePath)

Returns a Javascript-friendly String to identify this resource.

Parameters:

resourcePath - absolute path to the resource

Returns:

String with all alphanumeric characters removed and trimmed to the relative component path if jcr:content/ is found

getRelativePathToRootLevel

public static java.lang.String getRelativePathToRootLevel(Resource resource)

Returns a relative path to the root level nodes in the repository.

Parameters:

resource - the resource from which to derive the path

Returns:

relative path to content located at the root of the repository

getAllAngularPageComponents

public static java.util.List<Resource> getAllAngularPageComponents(Resource pageContentResource)

Returns a list of all the 'angular' components that are descendants of the given resource.

Parameters:

pageContentResource - resource to search for components

Returns:

list of 'angular' components

getAncestorTemplateResource

public static Resource getAncestorTemplateResource(Resource resource,
                                                   java.lang.String resourceType)

Determines the nearest ancestor template resource. This enables multiple similar resources to share the same template.

Parameters:

resource - A resource that requires a template to render

Returns:

template for the given resource, or null if this resource has no template resource

getRelativeComponentPath

public static java.lang.String getRelativeComponentPath(java.lang.String path)

Trims a component path down to the substring following "jcr:content/".

Parameters:

path -

Returns:

substring of the path following "jcr:content"