com.raritantechnologies.searchApp.sourceMap
Interface ISourceMapTreeNode

All Known Implementing Classes:

SourceMapTreeNode

public interface ISourceMapTreeNode

Basic interface for a Source mapping browse tree.

Developed by Raritan Technologies .

Author:

Ted Sullivan

Method Summary

ISourceMapTreeNode	getActiveSourceMapNode()
java.util.Iterator	getChildren()
java.lang.String	getDisplayFormName()
java.util.Map	getHiddenParams()
java.lang.String	getName() returns the name of this SourceMapTreeNode
ISourceMapTreeNode	getNode(java.lang.String path, java.lang.String separator, boolean initSeparator)
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()
java.lang.String	getSearchFormCategory() returns search form category - if return null - no search form for this node allows a search form to be determined.
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 name) 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)
void	setSearchFormName(java.lang.String searchFormName)
boolean	shouldPassRequestParams()
void	toggleState()

Method Detail

initialize

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

getName

public java.lang.String getName()

returns the name of this SourceMapTreeNode

getPath

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

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

getPathParam

public java.lang.String getPathParam()

getNode

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

getSourceMapParameters

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

setSearchFormName

public void setSearchFormName(java.lang.String searchFormName)

getSearchFormName

public java.lang.String getSearchFormName()

getSearchFormCategory

public java.lang.String getSearchFormCategory()

returns search form category - if return null - no search form for this node allows a search form to be determined.

hasChildren

public boolean hasChildren()

getChildren

public java.util.Iterator getChildren()

setOpenState

public void setOpenState(boolean isOpen)

toggleState

public void toggleState()

isOpen

public boolean isOpen()

isVisible

public boolean isVisible()

setActiveSourceMapNode

public void setActiveSourceMapNode(ISourceMapTreeNode node)

getActiveSourceMapNode

public ISourceMapTreeNode getActiveSourceMapNode()

getSourceParameterList

public SourceParameterList getSourceParameterList(java.lang.String name)

Used to build dropdown lists of source parameters

getSourceParameterListNames

public java.lang.String[] getSourceParameterListNames()

setDisplayFormName

public void setDisplayFormName(java.lang.String displayFormName)

getDisplayFormName

public java.lang.String getDisplayFormName()

needsSearchForm

public boolean needsSearchForm()

getSearchParams

public java.util.Map getSearchParams()

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

getHiddenParams

public java.util.Map getHiddenParams()

shouldPassRequestParams

public boolean shouldPassRequestParams()

needsHyperlink

public boolean needsHyperlink()