Module com.semanticcms.core.servlet

Package com.semanticcms.core.servlet

Class PageIndex

java.lang.Object

com.semanticcms.core.servlet.PageIndex

public class PageIndex
extends Object

Captures all pages recursively and builds an index of pages for fast page number lookups. The index may be created on the entire site or single subtree. The index is used when presenting multiple pages in a combined view.

Field Summary

Fields

Modifier and Type	Field	Description
static final ScopeEE.Request.Attribute<PageIndex>	REQUEST_ATTRIBUTE	The request scope variable containing any active page index.

Method Summary

Modifier and Type	Method	Description
static void	appendIdInPage(PageIndex pageIndex, Page page, String id, Appendable out)	Appends an id for use in referencing the given page.
static void	appendIdInPage(Integer index, String id, Appendable out)	Appends an id for use in referencing the page at the given index.
static PageIndex	getCurrentPageIndex(ServletRequest request)	Gets the current page index setup by a combined view or null if not doing a combined view.
Integer	getPageIndex(PageRef pagePath)
static PageIndex	getPageIndex(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, PageRef rootPageRef)	Captures the root with META capture level and all children as PAGE.
Map<PageRef,Integer>	getPageIndexes()
List<Page>	getPageList()
static String	getRefId(Integer index, String id)	Gets an id for use in referencing the page at the given index.
static String	getRefId(ServletContext servletContext, HttpServletRequest request, PageIndex pageIndex, String id)	Gets an id for use in the current page.
static String	getRefId(ServletContext servletContext, HttpServletRequest request, String id)	Gets an id for use in the current page.
static String	getRefIdInPage(PageIndex pageIndex, Page page, String id)	Gets an id for use in referencing the given page.
static String	getRefIdInPage(HttpServletRequest request, Page page, String id)	Gets an id for use in referencing the given page.
Page	getRootPage()	The root page, captured in META level.

Methods inherited from class java.lang.Object

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

Field Details

REQUEST_ATTRIBUTE

public static final ScopeEE.Request.Attribute<PageIndex> REQUEST_ATTRIBUTE

The request scope variable containing any active page index.

Method Details

getCurrentPageIndex

public static PageIndex getCurrentPageIndex(ServletRequest request)

Gets the current page index setup by a combined view or null if not doing a combined view.

getPageIndex

public static PageIndex getPageIndex(ServletContext servletContext,
 HttpServletRequest request,
 HttpServletResponse response,
 PageRef rootPageRef)
                              throws ServletException,
IOException

Captures the root with META capture level and all children as PAGE.

Throws:

ServletException

IOException

getRefId

public static String getRefId(Integer index,
 String id)

Gets an id for use in referencing the page at the given index. If the index is non-null, as in a combined view, will be "page#-id". Otherwise, the id is unchanged.

Parameters:

id - optional, id not added when null or empty

See Also:

• appendIdInPage(java.lang.Integer, java.lang.String, java.lang.Appendable)

getRefId

public static String getRefId(ServletContext servletContext,
 HttpServletRequest request,
 PageIndex pageIndex,
 String id)
                       throws ServletException

Gets an id for use in the current page. If the page is part of a page index, as in a combined view, will be "page#-id". Otherwise, the id is unchanged.

Parameters:

id - optional, id not added when null or empty

Throws:

ServletException

getRefId

public static String getRefId(ServletContext servletContext,
 HttpServletRequest request,
 String id)
                       throws ServletException

Gets an id for use in the current page. If the page is part of a page index, as in a combined view, will be "page#-id". Otherwise, the id is unchanged.

Parameters:

id - optional, id not added when null or empty

Throws:

ServletException

getRefIdInPage

public static String getRefIdInPage(PageIndex pageIndex,
 Page page,
 String id)

Gets an id for use in referencing the given page. If the page is part of a page index, as in a combined view, will be "page#-id". Otherwise, the id is unchanged.

Parameters:

id - optional, id not added when null or empty

See Also:

• appendIdInPage(com.semanticcms.core.servlet.PageIndex, com.semanticcms.core.model.Page, java.lang.String, java.lang.Appendable)

getRefIdInPage

public static String getRefIdInPage(HttpServletRequest request,
 Page page,
 String id)

Gets an id for use in referencing the given page. If the page is part of a page index, as in a combined view, will be "page#-id". Otherwise, the id is unchanged.

Parameters:

id - optional, id not added when null or empty

See Also:

• appendIdInPage(com.semanticcms.core.servlet.PageIndex, com.semanticcms.core.model.Page, java.lang.String, java.lang.Appendable)

appendIdInPage

public static void appendIdInPage(Integer index,
 String id,
 Appendable out)
                           throws IOException

Appends an id for use in referencing the page at the given index. If the index is non-null, as in a combined view, will be "page#-id". Otherwise, the id is unchanged.

Parameters:

id - optional, id not added when null or empty

Throws:

IOException

appendIdInPage

public static void appendIdInPage(PageIndex pageIndex,
 Page page,
 String id,
 Appendable out)
                           throws IOException

Appends an id for use in referencing the given page.

Parameters:

id - optional, id not added when null or empty

Throws:

IOException

See Also:

• getRefIdInPage(javax.servlet.http.HttpServletRequest, com.semanticcms.core.model.Page, java.lang.String)

getRootPage

public Page getRootPage()

The root page, captured in META level.

getPageList

public List<Page> getPageList()

getPageIndexes

public Map<PageRef,Integer> getPageIndexes()

getPageIndex

public Integer getPageIndex(PageRef pagePath)