com.raritantechnologies.searchApp.sourceMap
Class SourceMapTree

java.lang.Object
  com.raritantechnologies.utils.tree.TreeNode
      com.raritantechnologies.searchApp.sourceMap.SourceMapTreeNode
          com.raritantechnologies.searchApp.sourceMap.SourceMapTree

All Implemented Interfaces:

ISourceMapTreeNode

public class SourceMapTree

extends SourceMapTreeNode

Defines a Source Map Tree. Defines a hierarchy of abstract source types. Works with an ISourceMap instance to relate a specific source type (e.g. "Research Documents" ) with a one or more SearchSources.

XML Configuration Template:

  <SourceMapTree name="Subjects" param="treepath" >
   <SourceMapTreeNode name="Documents" >

    <!-- SourceMapList provides a list of sub-types -->
    <SourceMapList param="docType" >
      <params>
        <param name="Book"        value="Book" />
        <param name="RefArticle"  value="Reference Article" />
        <param name="NewsArticle" value="News Article" />
      </params>
    </SourceMapList>

  </SourceMapTreeNode>
 </SourceMapTree>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

Fields inherited from class com.raritantechnologies.searchApp.sourceMap.SourceMapTreeNode

activeNode, parent, passRequestParams, pathParam, searchFormCategory, searchFormName, theNodeLists

Fields inherited from class com.raritantechnologies.utils.tree.TreeNode

maxCount, name, needsUpdate, nodeCount, nodeID

Constructor Summary

SourceMapTree()

SourceMapTree(java.lang.String name, java.lang.String searchFormCategory)

Method Summary

protected SourceParameterList	getInheritedSourceList(java.lang.String name)
TreeNode	getParent()
java.lang.String	getPath(java.lang.String separator, boolean initSeparator) returns the path to this node using the separator provided by the caller.
protected SourceMapTreeNode	getRootSourceMapNode()
void	initialize(org.w3c.dom.Element elem)
protected void	setParent(SourceMapTreeNode smTreeNode)

Methods inherited from class com.raritantechnologies.searchApp.sourceMap.SourceMapTreeNode

addChildNode, addChildNode, getActiveSourceMapNode, getChildren, getDescription, getDisplayFormName, getHiddenParams, getLocalSourceList, getName, getNode, getPathParam, getSearchFormCategory, getSearchFormName, getSearchParams, getSourceMapParameters, getSourceParameterList, getSourceParameterListNames, hasChildren, isOpen, isVisible, needsHyperlink, needsSearchForm, setActiveSourceMapNode, setDisplayFormName, setOpenState, setSearchFormName, shouldPassRequestParams, toggleState

Methods inherited from class com.raritantechnologies.utils.tree.TreeNode

addAttribute, addChildNode, addParent, addResult, convertToResult, copyNode, copyNode, copyNodeAttributes, copyNodeCount, copyNodeOnly, createAttributesResult, deleteChildNodes, findNode, getActiveNode, getAllParentAttributes, getAllParentAttributes, getAllParentAttributes, getAllSubAttributes, getAllSubAttributes, getAllSubAttributes, getAncestorPaths, getAncestors, getAncestors, getAttribute, getAttributeNames, getAttributeSet, getAttributeSet, getAttributeSet, getAttributeValues, getAttributeValues, getChildNode, getChildrenCount, getDescendents, getDescendents, getDescendents, getLevel, getNameCount, getNestedResultSet, getNestedResultSet, getNodeCount, getNodeID, getNodeIDValue, getParents, getPathNoRoot, getPaths, getPathsNoRoot, getPatternStringValue, getResultSet, getRootNode, getSiblings, getSiblings, getTreeRoot, hasAttributeValue, hasMultipleParents, hasMultipleValues, haveChildNode, isRoot, needsUpdate, removeAttribute, removeChildNode, setActiveNode, setActiveNodeID, setAttribute, setMaxCount, setName, setNeedsUpdate, setNodeCount, setNodeID, setParent, setResultSet, sortChildren

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceMapTree

public SourceMapTree()

SourceMapTree

public SourceMapTree(java.lang.String name,
                     java.lang.String searchFormCategory)

Method Detail

initialize

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

Specified by:

initialize in interface ISourceMapTreeNode

Overrides:

initialize in class SourceMapTreeNode

getPath

public java.lang.String getPath(java.lang.String separator,
                                boolean initSeparator)

Description copied from interface: ISourceMapTreeNode

returns the path to this node using the separator provided by the caller. prepend a separator to the root node if initSeparator is true.

Specified by:

getPath in interface ISourceMapTreeNode

Overrides:

getPath in class SourceMapTreeNode

getParent

public TreeNode getParent()

Overrides:

getParent in class SourceMapTreeNode

getRootSourceMapNode

protected SourceMapTreeNode getRootSourceMapNode()

Overrides:

getRootSourceMapNode in class SourceMapTreeNode

setParent

protected void setParent(SourceMapTreeNode smTreeNode)

Overrides:

setParent in class SourceMapTreeNode

getInheritedSourceList

protected SourceParameterList getInheritedSourceList(java.lang.String name)

Overrides:

getInheritedSourceList in class SourceMapTreeNode