PageImpl (spa-project-core - Core 1.0.6 API)

java.lang.Object
- com.adobe.aem.spa.project.core.internal.impl.PageImpl

All Implemented Interfaces:

com.adobe.cq.export.json.ComponentExporter, com.adobe.cq.export.json.ContainerExporter, com.adobe.cq.export.json.hierarchy.HierarchyNodeExporter, com.adobe.cq.wcm.core.components.models.Page
```
@Model(adaptables=org.apache.sling.api.SlingHttpServletRequest.class,
       adapters={Page.class,com.adobe.cq.export.json.ContainerExporter.class},
       resourceType="spa-project-core/components/page")
public class PageImpl
extends Object
implements Page
```
Page that allows the retrieval of the model in JSON format with hierarchical structures of more than one page.
The content of the JSON export of the page's model is limited by two parameters (see HierarchyUtils):
- filterPatterns - paths from which Pages are to be included
- traversalDepth - number of levels to be included
However, there is also the possibility to use the Java API to get the model. If the getHierarchyRootModel() function is used, the HierarchyUtils.createHierarchyServletRequest(SlingHttpServletRequest, com.day.cq.wcm.api.Page, com.day.cq.wcm.api.Page) function would wrap the request saving…
- The original request
- The root page of the hierarchy
- The entry point page - so the page for which the actual request was made
…in order to provide the full hierarchy from the root, with all descendants' models of the root page (with respect to filterPatterns and traversalDepth) plus the entry point page (even if was excluded based on rules enforced by filterPatterns or traversalDepth).
Among other information, the exported structure would contain:
- A flat map of all descendants' models identifiable by their paths (getExportedChildren() → :children)
- A map of the content of the page (getExportedItems() → :items), together with the order (getExportedItemsOrder() → :itemsOrder

Field Summary
- Fields inherited from interface com.adobe.aem.spa.project.core.models.Page
  PN_STRUCTURE_DEPTH
- Fields inherited from interface com.adobe.cq.wcm.core.components.models.Page
  FN_FAVICON_ICO, FN_FAVICON_PNG, FN_TOUCH_ICON_120, FN_TOUCH_ICON_152, FN_TOUCH_ICON_60, FN_TOUCH_ICON_76, PN_APP_RESOURCES_CLIENTLIB, PN_FAVICON_ICO, PN_FAVICON_PNG, PN_TOUCH_ICON_120, PN_TOUCH_ICON_152, PN_TOUCH_ICON_60, PN_TOUCH_ICON_76

Constructor Summary

Constructors
Constructor and Description

PageImpl()

Constructors
Constructor and Description
`PageImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAppResourcesPath()`
`String[]`	`getClientLibCategories()`
`String[]`	`getClientLibCategoriesJsBody()`
`String[]`	`getClientLibCategoriesJsHead()`
`String`	`getCssClassNames()`
`String`	`getDesignPath()`
`@NotNull Map<String,? extends Page>`	`getExportedChildren()`
`@Nullable String`	`getExportedHierarchyType()`
`@NotNull Map<String,? extends com.adobe.cq.export.json.ComponentExporter>`	`getExportedItems()`
`@NotNull String[]`	`getExportedItemsOrder()`
`@NotNull String`	`getExportedPath()`
`@NotNull String`	`getExportedType()`
`@Nullable String`	`getHierarchyRootJsonExportUrl()` URL to the root model of the App
`@Nullable Page`	`getHierarchyRootModel()` Returns the model of the root page which this page is a part of
`String[]`	`getKeywords()`
`String`	`getLanguage()`
`Calendar`	`getLastModifiedDate()`
`@Nullable com.adobe.cq.wcm.core.components.models.NavigationItem`	`getRedirectTarget()`
`String`	`getStaticDesignPath()`
`String`	`getTemplateName()`
`String`	`getTitle()`
`boolean`	`hasCloudconfigSupport()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.adobe.cq.wcm.core.components.models.Page
getFavicons

- Constructor Detail
  - PageImpl
```
public PageImpl()
```
- Method Detail
  - getExportedHierarchyType
```
@Nullable
public @Nullable String getExportedHierarchyType()
```
    Specified by:
    
    getExportedHierarchyType in interface com.adobe.cq.export.json.hierarchy.HierarchyNodeExporter
    
    See Also:
    
    HierarchyNodeExporter.getExportedHierarchyType()
  - getExportedChildren
```
@NotNull
public @NotNull Map<String,? extends Page> getExportedChildren()
```
    Specified by:
    
    getExportedChildren in interface com.adobe.cq.export.json.hierarchy.HierarchyNodeExporter
    
    See Also:
    
    HierarchyNodeExporter.getExportedChildren()
  - getExportedPath
```
@NotNull
public @NotNull String getExportedPath()
```
    Specified by:
    
    getExportedPath in interface com.adobe.cq.export.json.hierarchy.HierarchyNodeExporter
    
    See Also:
    
    HierarchyNodeExporter.getExportedPath()
  - getHierarchyRootJsonExportUrl
```
@Nullable
public @Nullable String getHierarchyRootJsonExportUrl()
```
    Description copied from interface: Page
    
    URL to the root model of the App
    
    Returns:
    
    String
  - getHierarchyRootModel
```
@Nullable
public @Nullable Page getHierarchyRootModel()
```
    Returns the model of the root page which this page is a part of
    
    Returns:
    
    Root page model
  - getLanguage
```
public String getLanguage()
```
    Specified by:
    
    getLanguage in interface com.adobe.cq.wcm.core.components.models.Page
  - getLastModifiedDate
```
public Calendar getLastModifiedDate()
```
    Specified by:
    
    getLastModifiedDate in interface com.adobe.cq.wcm.core.components.models.Page
  - getKeywords
```
public String[] getKeywords()
```
    Specified by:
    
    getKeywords in interface com.adobe.cq.wcm.core.components.models.Page
  - getDesignPath
```
public String getDesignPath()
```
    Specified by:
    
    getDesignPath in interface com.adobe.cq.wcm.core.components.models.Page
  - getStaticDesignPath
```
public String getStaticDesignPath()
```
    Specified by:
    
    getStaticDesignPath in interface com.adobe.cq.wcm.core.components.models.Page
  - getTitle
```
public String getTitle()
```
    Specified by:
    
    getTitle in interface com.adobe.cq.wcm.core.components.models.Page
  - getTemplateName
```
public String getTemplateName()
```
    Specified by:
    
    getTemplateName in interface com.adobe.cq.wcm.core.components.models.Page
  - getClientLibCategories
```
public String[] getClientLibCategories()
```
    Specified by:
    
    getClientLibCategories in interface com.adobe.cq.wcm.core.components.models.Page
  - getExportedType
```
@NotNull
public @NotNull String getExportedType()
```
    Specified by:
    
    getExportedType in interface com.adobe.cq.export.json.ComponentExporter
    
    Specified by:
    
    getExportedType in interface com.adobe.cq.wcm.core.components.models.Page
    
    See Also:
    
    ComponentExporter.getExportedType()
  - getClientLibCategoriesJsBody
```
public String[] getClientLibCategoriesJsBody()
```
    Specified by:
    
    getClientLibCategoriesJsBody in interface com.adobe.cq.wcm.core.components.models.Page
  - getClientLibCategoriesJsHead
```
public String[] getClientLibCategoriesJsHead()
```
    Specified by:
    
    getClientLibCategoriesJsHead in interface com.adobe.cq.wcm.core.components.models.Page
  - getAppResourcesPath
```
public String getAppResourcesPath()
```
    Specified by:
    
    getAppResourcesPath in interface com.adobe.cq.wcm.core.components.models.Page
  - getCssClassNames
```
public String getCssClassNames()
```
    Specified by:
    
    getCssClassNames in interface com.adobe.cq.wcm.core.components.models.Page
  - getExportedItemsOrder
```
@NotNull
public @NotNull String[] getExportedItemsOrder()
```
    Specified by:
    
    getExportedItemsOrder in interface com.adobe.cq.export.json.ContainerExporter
    
    Specified by:
    
    getExportedItemsOrder in interface com.adobe.cq.wcm.core.components.models.Page
    
    See Also:
    
    ContainerExporter.getExportedItemsOrder()
  - getExportedItems
```
@NotNull
public @NotNull Map<String,? extends com.adobe.cq.export.json.ComponentExporter> getExportedItems()
```
    Specified by:
    
    getExportedItems in interface com.adobe.cq.export.json.ContainerExporter
    
    Specified by:
    
    getExportedItems in interface com.adobe.cq.wcm.core.components.models.Page
    
    See Also:
    
    ContainerExporter.getExportedItems()
  - getRedirectTarget
```
@Nullable
public @Nullable com.adobe.cq.wcm.core.components.models.NavigationItem getRedirectTarget()
```
    Specified by:
    
    getRedirectTarget in interface com.adobe.cq.wcm.core.components.models.Page
  - hasCloudconfigSupport
```
public boolean hasCloudconfigSupport()
```
    Specified by:
    
    hasCloudconfigSupport in interface com.adobe.cq.wcm.core.components.models.Page

Class PageImpl

Field Summary

Fields inherited from interface com.adobe.aem.spa.project.core.models.Page

Fields inherited from interface com.adobe.cq.wcm.core.components.models.Page

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.adobe.cq.wcm.core.components.models.Page

Constructor Detail

PageImpl

Method Detail

getExportedHierarchyType

getExportedChildren

getExportedPath

getHierarchyRootJsonExportUrl

getHierarchyRootModel

getLanguage

getLastModifiedDate

getKeywords

getDesignPath

getStaticDesignPath

getTitle

getTemplateName

getClientLibCategories

getExportedType

getClientLibCategoriesJsBody

getClientLibCategoriesJsHead

getAppResourcesPath

getCssClassNames

getExportedItemsOrder

getExportedItems

getRedirectTarget

hasCloudconfigSupport