de.innovationgate.webgate.api

Class WGContentNavigator

java.lang.Object

de.innovationgate.webgate.api.WGContentNavigator

public class WGContentNavigator
extends java.lang.Object

Utility object to navigate the content hierarchy. The WGContentNavigator in most methods takes a content as parameter and determines a content position in the site hierarchy relative to this content, e.g. the parent content or a sibling content. The return is always a valid and released content object of the same language (except in those cases, where something different is configured - as described below). So this object is used by the navigation elements of WebTML to quickly determine the content links to display.

If a content position does not provide a valid content as requested, the navigator searches further along the given direction (e.g. when searching parent, goes further up the hierarchy, when searching sibling, goes to the nex sibling) and tries to return a valid content from there. If the hierarchy ends in that direction without finding valid content, methods return null.

WGContentNavigator also takes into account visibility settings and automatically ignores contents that are not visible. Therefor the constructor takes a displaytype parameter, telling the navigator to behave like a (WebTML-Navigator), a sitemap or a search, so contents hidden from one of these facilities can be ignored.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WGContentNavigator.Iterator
static interface	WGContentNavigator.IteratorCreator Class capable of producing iterators for a content collection

Constructor Summary

Constructors

Constructor and Description
WGContentNavigator(java.lang.String displayType, WGLanguageChooser chooser) Public constructor for WGContentNavigator.

Method Summary

Methods

Modifier and Type	Method and Description
WGContent	chooseRelevantContent(WGContent retrievedContent, WGContent previewContent) Chooses the relevant content between a retrieved content, and a content currently previewed as draft, review or archived doc.
java.util.List<WGContent>	collectRelevantContents(WGStructEntryList siblings) Given a list of struct entry siblings this method retrieves the relevant contents for all siblings.
WGContentNavigator.IteratorCreator	createChildContentIterable(WGContent relContent, int pageSize) Creates an Iterable for the child contents of the given content
WGContentNavigator.IteratorCreator	createChildContentIterable(WGContent relContent, int pageSize, java.lang.String orderExpression) Creates an Iterable for the child contents of the given content
WGContentNavigator.Iterator	createContentIterator(WGStructEntryIterator structs) Creates a content iterator for contents of the struct entries, returned by the given WGStructEntryIterator The iterator will choose contents based on the settings in this content navigator.
WGContentNavigator.IteratorCreator	createParentContentIterable(WGContent relContent, int pageSize) Creates an Iterable for the parent contents of the given content
WGContentNavigator.IteratorCreator	createParentContentIterable(WGContent relContent, int pageSize, java.lang.String orderExpression) Creates an Iterable for the parent contents of the given content
WGContentNavigator.IteratorCreator	createSiblingContentIterable(WGContent relContent, int pageSize) Creates an Iterable for the sibling contents of the given content
WGContentNavigator.IteratorCreator	createSiblingContentIterable(WGContent relContent, int pageSize, java.lang.String orderExpression) Creates an Iterable for the sibling contents of the given content
WGContent	getChildContent(WGContent relContent, int idx) Returns the nth child content of a parent content with the same language.
WGContent	getChildContent(WGContent relContent, int idx, int searchOrder) Deprecated. searchOrder argument is ineffective. Use getChildContent(WGContent, int) instead.
java.lang.Integer	getContentLevel(WGContent relContent) Retrieves the hierarchical level of a content document.
java.lang.String	getDisplayType() Gets the display type (i.e. role in WebTML), that this content navigator uses to determine contents to show.
WGContentList	getLanguagesContent(WGContent relContent, boolean includeThisOne) Returns all available languages for the the given content as content list.
WGContent	getNextSibling(WGContent relContent) Gets the next siblings content with the same language.
WGContent	getParentContent(WGContent relContent) Gets the parent content to the given content with the same language.
WGContent	getPreviousSibling(WGContent relContent) Gets the previous siblings content with the same language.
WGContent	getRelevantContent(WGStructEntry entry) Returns the "relevant" content of a struct entry.
WGContent	getRootContent(WGArea relArea) Returns the first root content of an area in the given language.
WGContent	getRootContent(WGContent relContent) Returns the root content for a given content in the same language
WGContent	getSiblingContent(WGContent relContent, int idx, boolean relative) Returns a sibling content of the given content that is at a certain index position in the siblings list and has the same language.
int	getSiblingsCount(WGContent relContent) Returns the number of siblings (of the same language) of a content.
java.lang.Integer	getSiblingsIndex(WGContent relContent) Returns the absolute index position of a given content among its siblings
boolean	hasContentChildren(WGContent relContent) Returns, if the given context has released child contexts in the same language.
boolean	isOnlyPublished() Returns if only published contents are to be retrieved
void	setDisplayType(java.lang.String displayType) Sets the display type (i.e. role in WebTML) that this navigator should use.
void	setOnlyPublished(boolean onlyPublished) Sets if only published contents are to be retrieved

Methods inherited from class java.lang.Object

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

Constructor Detail

WGContentNavigator

public WGContentNavigator(java.lang.String displayType,
                  WGLanguageChooser chooser)
                   throws WGAPIException

Public constructor for WGContentNavigator.

Parameters:

displayType - The display type (i.e. role in WebTML) this navigator works for. Use constants WGContent.DISPLAYTYPE_...

chooser - A language chooser choosing the relevant language version for pages

Throws:

WGAPIException

Method Detail

getRootContent

public WGContent getRootContent(WGContent relContent)
                         throws WGAPIException

Returns the root content for a given content in the same language

Parameters:

relContent - The content to find root content for

Returns:

The root content. Can be the same content as the given one, if this was a root content itself.

Throws:

WGAPIException

getRootContent

public WGContent getRootContent(WGArea relArea)
                         throws WGAPIException

Returns the first root content of an area in the given language.

Parameters:

relArea - The area to search for the first root content.

Returns:

WGContent

Throws:

WGAPIException

getRelevantContent

public WGContent getRelevantContent(WGStructEntry entry)
                             throws WGAPIException

Returns the "relevant" content of a struct entry. That is, a content that is released and that matches one relevant language. Takes into account the eventually given draft content of this navigator and returns this one, if it should.

Parameters:

entry - Entry to search for relevant content

Returns:

WGContent

Throws:

WGAPIException

getDisplayType

public java.lang.String getDisplayType()

Gets the display type (i.e. role in WebTML), that this content navigator uses to determine contents to show.

setDisplayType

public void setDisplayType(java.lang.String displayType)

Sets the display type (i.e. role in WebTML) that this navigator should use.

Parameters:

displayType - The display type. Use constants WGContent.DISPLAYTYPE....

getSiblingContent

public WGContent getSiblingContent(WGContent relContent,
                          int idx,
                          boolean relative)
                            throws WGAPIException

Returns a sibling content of the given content that is at a certain index position in the siblings list and has the same language.

Parameters:

relContent - The content whose sibling is to be found.

idx - The index position at which to find the sibling.

relative - If true, the index position is regarded relative, i.e. +1 will fetch the next sibling, -1 the previous sibling. If false, the index position is regarded absolute, where 0 denotes the first sibling

Returns:

The content at that index position.

Throws:

WGAPIException

getPreviousSibling

public WGContent getPreviousSibling(WGContent relContent)
                             throws WGAPIException

Gets the previous siblings content with the same language.

Parameters:

relContent - The content to find the sibling for

Returns:

WGContent

Throws:

WGAPIException

getNextSibling

public WGContent getNextSibling(WGContent relContent)
                         throws WGAPIException

Gets the next siblings content with the same language.

Parameters:

relContent - The content to find the sibling for

Returns:

WGContent

Throws:

WGAPIException

getChildContent

public WGContent getChildContent(WGContent relContent,
                        int idx,
                        int searchOrder)
                          throws WGAPIException

Deprecated. searchOrder argument is ineffective. Use getChildContent(WGContent, int) instead.

Returns the nth child content of a parent content with the same language.

Parameters:

relContent - The parent content

idx - The index position of the needed child content (!= the struct entries position metadata!)

searchOrder - The search order. Use constants WGContent.SEARCHORDER_.... INEFFECTIVE SINCE OPENWGA 6.1

Returns:

The child content at that index position

Throws:

WGAPIException

getChildContent

public WGContent getChildContent(WGContent relContent,
                        int idx)
                          throws WGAPIException

Returns the nth child content of a parent content with the same language.

Parameters:

relContent - The parent content

idx - The index position of the needed child content (!= the struct entries position metadata!), 0 denoting the first one

Returns:

The child content at that index position

Throws:

WGAPIException

getLanguagesContent

public WGContentList getLanguagesContent(WGContent relContent,
                                boolean includeThisOne)
                                  throws WGAPIException

Returns all available languages for the the given content as content list.

Parameters:

relContent - The content to retrieve languages for.

includeThisOne - If true, the given content will be included in the list, if false won't

Returns:

WGContentList

Throws:

WGAPIException

getParentContent

public WGContent getParentContent(WGContent relContent)
                           throws WGAPIException

Gets the parent content to the given content with the same language.

Parameters:

relContent - content to find parent for

Returns:

WGContent

Throws:

WGAPIException

getSiblingsIndex

public java.lang.Integer getSiblingsIndex(WGContent relContent)
                                   throws WGAPIException

Returns the absolute index position of a given content among its siblings

Parameters:

relContent - The context, whose index position is evaluated

Returns:

Integer

Throws:

WGAPIException

getSiblingsCount

public int getSiblingsCount(WGContent relContent)
                     throws WGAPIException

Returns the number of siblings (of the same language) of a content.

Parameters:

relContent - The content to find the siblings count for.

Returns:

The count of siblings EXCLUDING the given content

Throws:

WGAPIException

chooseRelevantContent

public WGContent chooseRelevantContent(WGContent retrievedContent,
                              WGContent previewContent)
                                throws WGAPIException

Chooses the relevant content between a retrieved content, and a content currently previewed as draft, review or archived doc. When previewing a content at non-published state, all links that go back to it's struct entry position should not point to the currently released content but to the previewed version.. Therefor this method should be called in preview mode with each content to show links for. It will tes, when this case occurs and return the preview content instead.

Parameters:

retrievedContent - The retrieved content, that under normal conditions should be shown

previewContent - The previewed content, that should be shown when the retrieved content is the released version of it

Returns:

WGContent The content to show

Throws:

WGAPIException

getContentLevel

public java.lang.Integer getContentLevel(WGContent relContent)
                                  throws WGAPIException

Retrieves the hierarchical level of a content document.

Parameters:

relContent - The content, whose level is requested.

Returns:

The hierarchical level, 1 being the main document level.

Throws:

WGAPIException

hasContentChildren

public boolean hasContentChildren(WGContent relContent)
                           throws WGAPIException

Returns, if the given context has released child contexts in the same language.

Parameters:

relContent -

Returns:

boolean

Throws:

WGAPIException

isOnlyPublished

public boolean isOnlyPublished()

Returns if only published contents are to be retrieved

setOnlyPublished

public void setOnlyPublished(boolean onlyPublished)

Sets if only published contents are to be retrieved

collectRelevantContents

public java.util.List<WGContent> collectRelevantContents(WGStructEntryList siblings)
                                                  throws WGAPIException

Given a list of struct entry siblings this method retrieves the relevant contents for all siblings.

Parameters:

siblings - The siblings of type WGStructEntry

Returns:

A list of WGContent objects

Throws:

WGAPIException

createContentIterator

public WGContentNavigator.Iterator createContentIterator(WGStructEntryIterator structs)

Creates a content iterator for contents of the struct entries, returned by the given WGStructEntryIterator The iterator will choose contents based on the settings in this content navigator.

Parameters:

structs - The struct entry iterator

Returns:

The content iterator

createChildContentIterable

public WGContentNavigator.IteratorCreator createChildContentIterable(WGContent relContent,
                                                            int pageSize)
                                                              throws WGAPIException

Creates an Iterable for the child contents of the given content

Parameters:

relContent - The content

pageSize - The fetch size for the iterable, determining how many contents will be fetched at once

Returns:

The iterable

Throws:

WGAPIException

createChildContentIterable

public WGContentNavigator.IteratorCreator createChildContentIterable(WGContent relContent,
                                                            int pageSize,
                                                            java.lang.String orderExpression)
                                                              throws WGAPIException

Creates an Iterable for the child contents of the given content

Parameters:

relContent - The content

pageSize - The fetch size for the iterable, determining how many contents will be fetched at once

orderExpression - A column set expression denoting the order in which to return contents, null for default oder (position, title, both ascending)

Returns:

The iterable

Throws:

WGAPIException

createSiblingContentIterable

public WGContentNavigator.IteratorCreator createSiblingContentIterable(WGContent relContent,
                                                              int pageSize)
                                                                throws WGAPIException

Creates an Iterable for the sibling contents of the given content

Parameters:

relContent - The content

pageSize - The fetch size for the iterable, determining how many contents will be fetched at once

Returns:

The iterable

Throws:

WGAPIException

createSiblingContentIterable

public WGContentNavigator.IteratorCreator createSiblingContentIterable(WGContent relContent,
                                                              int pageSize,
                                                              java.lang.String orderExpression)
                                                                throws WGAPIException

Creates an Iterable for the sibling contents of the given content

Parameters:

relContent - The content

pageSize - The fetch size for the iterable, determining how many contents will be fetched at once

orderExpression - A column set expression denoting the order in which to return contents, null for default oder (position, title, both ascending)

Returns:

The iterable

Throws:

WGAPIException

createParentContentIterable

public WGContentNavigator.IteratorCreator createParentContentIterable(WGContent relContent,
                                                             int pageSize)
                                                               throws WGAPIException

Creates an Iterable for the parent contents of the given content

Parameters:

relContent - The content

Returns:

The iterable

Throws:

WGAPIException

createParentContentIterable

public WGContentNavigator.IteratorCreator createParentContentIterable(WGContent relContent,
                                                             int pageSize,
                                                             java.lang.String orderExpression)
                                                               throws WGAPIException

Creates an Iterable for the parent contents of the given content

Parameters:

relContent - The content

pageSize - The fetch size for the iterable, determining how many contents will be fetched at once

Returns:

The iterable

Throws:

WGAPIException