com.raritantechnologies.webdav
Class WebDAVTreeBuilder

java.lang.Object
  com.raritantechnologies.webdav.WebDAVTreeBuilder

All Implemented Interfaces:

IConfigurable, ITreeBuilder

public class WebDAVTreeBuilder

extends java.lang.Object

implements ITreeBuilder

Builds a TreeRoot object from a WebDAV collection hierarchy. A WebDAV Resource maps to a TreeNode - child resources map to child TreeNoes.

XML Configuration Template:

    <TreeBuilder class="com.raritantechnologies.webdav.WebDAVTreeBuilder"
                    webDavURL="[ url to WebDav resource ]" >

       <!-- List of WebDAV Properties to retrieve as TreeNode attributes -->
       <WebDAVProperties>
          <!-- One or more Property elements -->
          <Property name="[ name of WebDAV Property ]" attribute="[ (optional) name of TreeNode attribute ]" />
       <WebDAVProperties>

    </TreeBuilder>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.utils.tree.ITreeBuilder

TEMPLATE

Constructor Summary

WebDAVTreeBuilder()

Method Summary

TreeRoot	buildTree(RaritanPageContext pContext)
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
TreeRoot	refreshTree(TreeRoot tree, RaritanPageContext pContext) Method to enable dynamic or refreshable trees.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebDAVTreeBuilder

public WebDAVTreeBuilder()

Method Detail

buildTree

public TreeRoot buildTree(RaritanPageContext pContext)

Specified by:

buildTree in interface ITreeBuilder

refreshTree

public TreeRoot refreshTree(TreeRoot tree,
                            RaritanPageContext pContext)

Description copied from interface: ITreeBuilder

Method to enable dynamic or refreshable trees. Static tree builders should implement this by returning the passed in tree object. Dynamic tree builders should implement this by returning the output of their buildTree( ) method or by pruning/growing the given tree as appropriate.

ITreeBuilders that support "lazy tree node evaluation" should use this method to determine which nodes in the tree need to be updated (TreeNode.needsUpdate( ) method returns true.

Specified by:

refreshTree in interface ITreeBuilder

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable