com.raritantechnologies.searchApp.sourceMap
Class SourceMapTreeNode

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

All Implemented Interfaces:

ISourceMapTreeNode

Direct Known Subclasses:

SourceMapTree

public class SourceMapTreeNode

extends TreeNode

implements ISourceMapTreeNode

Defines a SourceMapTree node.

XML Configuration Template:

  <SourceMapTree param="smTreeName" category="aCategory" displayFormName="theGrid" >
     <SourceMapNode name="smNodeName" >
       <Description>[ descriptive text for this source map node ]</Description>
       <SourceMapNode name="childNode" searchForm="searchFormName" category="anotherCategory">
         <SourceMapList name="documentType" >
           <params>
             <param name="Article" value="Article" />
             <param name="Ptnt" value="Patent" />
           </params>
         </SourceMapList>

       </SourceMapNode>
    </SourceMapNode>

    <SourceMapNode name="presetNode" searchForm="none" >
      <SearchParams>
        <Field ID="fieldID" value="field Value" />
        <Field ID="field2"  value="field 2 value" />
      </SearchParams>
    </SourceMapNode>
  </SourceMapTree>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

protected ISourceMapTreeNode	activeNode
protected SourceMapTreeNode	parent
protected java.lang.Boolean	passRequestParams
protected java.lang.String	pathParam
protected java.lang.String	searchFormCategory
protected java.lang.String	searchFormName
protected java.util.HashMap	theNodeLists

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

maxCount, name, needsUpdate, nodeCount, nodeID

Constructor Summary

SourceMapTreeNode()

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

Method Summary

protected void	addChildNode(SourceMapTreeNode smTreeNode)
void	addChildNode(TreeNode node)
ISourceMapTreeNode	getActiveSourceMapNode()
java.util.Iterator	getChildren()
java.lang.String	getDescription()
java.lang.String	getDisplayFormName()
java.util.Map	getHiddenParams()
protected SourceParameterList	getInheritedSourceList(java.lang.String paramName)
protected SourceParameterList	getLocalSourceList(java.lang.String paramName)
java.lang.String	getName() returns the name of this SourceMapTreeNode
ISourceMapTreeNode	getNode(java.lang.String path, java.lang.String separator, boolean initSeparator)
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.
java.lang.String	getPathParam()
protected SourceMapTreeNode	getRootSourceMapNode()
java.lang.String	getSearchFormCategory() Returns search form category: determines which SearchForm to use.
java.lang.String	getSearchFormName()
java.util.Map	getSearchParams() Used if the SourceMapTreeNode has pre-set parameters sufficient to search.
OrderedMap	getSourceMapParameters(java.lang.String separator, boolean initSeparator)
SourceParameterList	getSourceParameterList(java.lang.String param) Used to build dropdown lists of source parameters
java.lang.String[]	getSourceParameterListNames()
boolean	hasChildren()
void	initialize(org.w3c.dom.Element elem)
boolean	isOpen()
boolean	isVisible()
boolean	needsHyperlink()
boolean	needsSearchForm()
void	setActiveSourceMapNode(ISourceMapTreeNode node)
void	setDisplayFormName(java.lang.String displayFormName)
void	setOpenState(boolean isOpen)
protected void	setParent(SourceMapTreeNode smTreeNode)
void	setSearchFormName(java.lang.String searchFormName)
boolean	shouldPassRequestParams()
void	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

Field Detail

pathParam

protected java.lang.String pathParam

searchFormName

protected java.lang.String searchFormName

searchFormCategory

protected java.lang.String searchFormCategory

parent

protected SourceMapTreeNode parent

activeNode

protected ISourceMapTreeNode activeNode

theNodeLists

protected java.util.HashMap theNodeLists

passRequestParams

protected java.lang.Boolean passRequestParams

Constructor Detail

SourceMapTreeNode

public SourceMapTreeNode()

SourceMapTreeNode

public SourceMapTreeNode(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

getName

public java.lang.String getName()

Description copied from interface: ISourceMapTreeNode

returns the name of this SourceMapTreeNode

Specified by:

getName in interface ISourceMapTreeNode

Overrides:

getName in class TreeNode

getDescription

public java.lang.String getDescription()

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 TreeNode

getSearchFormCategory

public java.lang.String getSearchFormCategory()

Returns search form category: determines which SearchForm to use.

Specified by:

getSearchFormCategory in interface ISourceMapTreeNode

hasChildren

public boolean hasChildren()

Specified by:

hasChildren in interface ISourceMapTreeNode

Overrides:

hasChildren in class TreeNode

getChildren

public java.util.Iterator getChildren()

Specified by:

getChildren in interface ISourceMapTreeNode

Overrides:

getChildren in class TreeNode

getNode

public ISourceMapTreeNode getNode(java.lang.String path,
                                  java.lang.String separator,
                                  boolean initSeparator)

Specified by:

getNode in interface ISourceMapTreeNode

getRootSourceMapNode

protected SourceMapTreeNode getRootSourceMapNode()

addChildNode

protected void addChildNode(SourceMapTreeNode smTreeNode)

addChildNode

public void addChildNode(TreeNode node)

Overrides:

addChildNode in class TreeNode

setOpenState

public void setOpenState(boolean isOpen)

Specified by:

setOpenState in interface ISourceMapTreeNode

Overrides:

setOpenState in class TreeNode

toggleState

public void toggleState()

Specified by:

toggleState in interface ISourceMapTreeNode

Overrides:

toggleState in class TreeNode

isOpen

public boolean isOpen()

Specified by:

isOpen in interface ISourceMapTreeNode

Overrides:

isOpen in class TreeNode

isVisible

public boolean isVisible()

Specified by:

isVisible in interface ISourceMapTreeNode

Overrides:

isVisible in class TreeNode

setActiveSourceMapNode

public void setActiveSourceMapNode(ISourceMapTreeNode node)

Specified by:

setActiveSourceMapNode in interface ISourceMapTreeNode

getActiveSourceMapNode

public ISourceMapTreeNode getActiveSourceMapNode()

Specified by:

getActiveSourceMapNode in interface ISourceMapTreeNode

getSourceParameterList

public SourceParameterList getSourceParameterList(java.lang.String param)

Used to build dropdown lists of source parameters

Specified by:

getSourceParameterList in interface ISourceMapTreeNode

getSourceParameterListNames

public java.lang.String[] getSourceParameterListNames()

Specified by:

getSourceParameterListNames in interface ISourceMapTreeNode

getSourceMapParameters

public OrderedMap getSourceMapParameters(java.lang.String separator,
                                         boolean initSeparator)

Specified by:

getSourceMapParameters in interface ISourceMapTreeNode

setParent

protected void setParent(SourceMapTreeNode smTreeNode)

getParent

public TreeNode getParent()

Overrides:

getParent in class TreeNode

getInheritedSourceList

protected SourceParameterList getInheritedSourceList(java.lang.String paramName)

getLocalSourceList

protected SourceParameterList getLocalSourceList(java.lang.String paramName)

needsSearchForm

public boolean needsSearchForm()

Specified by:

needsSearchForm in interface ISourceMapTreeNode

setSearchFormName

public void setSearchFormName(java.lang.String searchFormName)

Specified by:

setSearchFormName in interface ISourceMapTreeNode

getSearchFormName

public java.lang.String getSearchFormName()

Specified by:

getSearchFormName in interface ISourceMapTreeNode

getSearchParams

public java.util.Map getSearchParams()

Description copied from interface: ISourceMapTreeNode

Used if the SourceMapTreeNode has pre-set parameters sufficient to search.

Specified by:

getSearchParams in interface ISourceMapTreeNode

getHiddenParams

public java.util.Map getHiddenParams()

Specified by:

getHiddenParams in interface ISourceMapTreeNode

shouldPassRequestParams

public boolean shouldPassRequestParams()

Specified by:

shouldPassRequestParams in interface ISourceMapTreeNode

setDisplayFormName

public void setDisplayFormName(java.lang.String displayFormName)

Specified by:

setDisplayFormName in interface ISourceMapTreeNode

getDisplayFormName

public java.lang.String getDisplayFormName()

Specified by:

getDisplayFormName in interface ISourceMapTreeNode

getPathParam

public java.lang.String getPathParam()

Specified by:

getPathParam in interface ISourceMapTreeNode

needsHyperlink

public boolean needsHyperlink()

Specified by:

needsHyperlink in interface ISourceMapTreeNode