com.hlcl.rql.hip.as
Class PageStructureCollector

java.lang.Object
  com.hlcl.rql.hip.as.PageStructureCollector

public class PageStructureCollector
extends java.lang.Object

Author:

lejafr This class collect all child pages (block pages) with their multi links. The deepness of each link and child will be calculated as well.

Constructor Summary

PageStructureCollector(java.lang.String isPhysicalPageTmpltElemName, java.lang.String ignoreTmpltElemNameSuffix)
Construct a page structure collector.

Method Summary

java.util.List	collectStructure(Page startPage) Startet das Suchen und linken ab der gegebenen Startseite.
java.util.List	compact(java.lang.String groupTempltElemNameList, java.lang.String delimiter, PageFilter seperateFilter) Fasst childs in media files und text table rows zusammen.
java.util.List	getStructure() Liefert die Seitenstruktur als geordnete Liste.
int[]	getStructureDeepnesses() Liefert eine geordnete Liste mit den deepness information für die vollständige Strutur.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageStructureCollector

public PageStructureCollector(java.lang.String isPhysicalPageTmpltElemName,
                              java.lang.String ignoreTmpltElemNameSuffix)

Construct a page structure collector.

Parameters:

isPhysicalPageTmpltElemName - if template of page contains an element with this name the page is a real HTML page

ignoreTmpltElemNameSuffix - skip child pages of multi links if a shadowed element for this suffix exists, e.g. _onlyPhysicalPages

Method Detail

collectStructure

public java.util.List collectStructure(Page startPage)
                                throws RQLException

Startet das Suchen und linken ab der gegebenen Startseite. Liefert die geordnete Liste mit der vollen Struktur zurück.

Throws:

RQLException

getStructure

public java.util.List getStructure()

Liefert die Seitenstruktur als geordnete Liste. Das erste Element ist immer die Startseite selbst.

compact

public java.util.List compact(java.lang.String groupTempltElemNameList,
                              java.lang.String delimiter,
                              PageFilter seperateFilter)
                       throws RQLException

Fasst childs in media files und text table rows zusammen. Ist optional.

Parameters:

groupTempltElemNameList - a list of multi link names for which child pages should be grouped, e.g. text_list,term_list

delimiter - the delimiter for this list, e.g. ,

seperateFilter - pages for which this filter returns true stay always outside the group, e.g. a ListPageFilter with all draft pages of author

Throws:

RQLException

getStructureDeepnesses

public int[] getStructureDeepnesses()

Liefert eine geordnete Liste mit den deepness information für die vollständige Strutur.