de.innovationgate.webgate.api

Class WGDatabase.DocumentCollectionHierarchy

java.lang.Object

de.innovationgate.webgate.api.WGDatabase.DocumentCollectionHierarchy

All Implemented Interfaces:

PageHierarchyNode

Enclosing class:

WGDatabase

public class WGDatabase.DocumentCollectionHierarchy
extends java.lang.Object
implements PageHierarchyNode

Constructor Summary

Constructors

Constructor and Description
WGDatabase.DocumentCollectionHierarchy(int type)

Method Summary

Methods

Modifier and Type	Method and Description
de.innovationgate.utils.SkippingIterator<? extends PageHierarchyNode>	getChildNodeIterator(int pageSize) Returns an iterator for the child nodes of this hierarchy node
java.util.List<? extends PageHierarchyNode>	getChildNodes() Returns the child nodes of this hierarchy node
java.lang.Class<? extends WGDocument>	getChildNodeType() Return the class type of child nodes
java.lang.String	getNodeKey() Returns a string key for the node that is unique among all keys of PageHierarchyNodes in this database.
java.lang.String	getNodeTitle(java.lang.String language) Returns the display title for the node.
PageHierarchyNode	getParentNode() Return the parent of this node in hierarchy.

Methods inherited from class java.lang.Object

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

Constructor Detail

WGDatabase.DocumentCollectionHierarchy

public WGDatabase.DocumentCollectionHierarchy(int type)

Method Detail

getChildNodeType

public java.lang.Class<? extends WGDocument> getChildNodeType()

Description copied from interface: PageHierarchyNode

Return the class type of child nodes

Specified by:

getChildNodeType in interface PageHierarchyNode

getChildNodes

public java.util.List<? extends PageHierarchyNode> getChildNodes()
                                                          throws WGAPIException

Description copied from interface: PageHierarchyNode

Returns the child nodes of this hierarchy node

Specified by:

getChildNodes in interface PageHierarchyNode

Throws:

WGAPIException

getChildNodeIterator

public de.innovationgate.utils.SkippingIterator<? extends PageHierarchyNode> getChildNodeIterator(int pageSize)
                                                                                           throws WGAPIException

Description copied from interface: PageHierarchyNode

Returns an iterator for the child nodes of this hierarchy node

Specified by:

getChildNodeIterator in interface PageHierarchyNode

Parameters:

pageSize - The size of a fetch page, if the implementation fetches childnodes page-wise

Throws:

WGAPIException

getNodeKey

public java.lang.String getNodeKey()
                            throws WGAPIException

Description copied from interface: PageHierarchyNode

Returns a string key for the node that is unique among all keys of PageHierarchyNodes in this database.

Specified by:

getNodeKey in interface PageHierarchyNode

Throws:

WGAPIException

getNodeTitle

public java.lang.String getNodeTitle(java.lang.String language)
                              throws WGAPIException

Description copied from interface: PageHierarchyNode

Returns the display title for the node. If multiple titles for multiple languages exist we choose a specific one for the given language.

Specified by:

getNodeTitle in interface PageHierarchyNode

Parameters:

language - The language whose title is wanted

Returns:

The title

Throws:

WGAPIException

getParentNode

public PageHierarchyNode getParentNode()
                                throws WGAPIException

Description copied from interface: PageHierarchyNode

Return the parent of this node in hierarchy. Return null at the root level.

Specified by:

getParentNode in interface PageHierarchyNode

Throws:

WGAPIException