This project has retired. For details please refer to its Attic page.

org.apache.lenya.cms.site
Class SiteUtil

java.lang.Object
  org.apache.lenya.cms.site.SiteUtil

public class SiteUtil
extends java.lang.Object

Utility to handle site structures.

Version:

$Id: SiteUtil.java 566250 2007-08-15 16:34:09Z andreas $

Method Summary

static DocumentLocator	getAvailableLocator(org.apache.avalon.framework.service.ServiceManager manager, DocumentFactory factory, DocumentLocator locator)
static NodeSet	getSubSite(org.apache.avalon.framework.service.ServiceManager manager, SiteNode node) Returns a sub-site starting with a certain node, which includes the node itself and all nodes which require this node, in preorder.

Methods inherited from class java.lang.Object

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

Method Detail

getSubSite

public static NodeSet getSubSite(org.apache.avalon.framework.service.ServiceManager manager,
                                 SiteNode node)
                          throws SiteException

Returns a sub-site starting with a certain node, which includes the node itself and all nodes which require this node, in preorder.

Parameters:

manager - The service manager.

node - The top-level document.

Returns:

A document set.

Throws:

SiteException - if an error occurs.

getAvailableLocator

public static DocumentLocator getAvailableLocator(org.apache.avalon.framework.service.ServiceManager manager,
                                                  DocumentFactory factory,
                                                  DocumentLocator locator)
                                           throws SiteException

Parameters:

manager - The service manager.

factory - The factory.

locator - The locator.

Returns:

A document.

Throws:

SiteException - if an error occurs.

See Also:

SiteManager.getAvailableLocator(DocumentFactory, DocumentLocator)