no.sesat.search.result
Class BasicNavigationItem

java.lang.Object
  no.sesat.search.result.BasicResultItem
      no.sesat.search.result.BasicResultList<NavigationItem>
          no.sesat.search.result.BasicNavigationItem

All Implemented Interfaces:

Serializable, NavigationItem, ResultItem, ResultList<NavigationItem>

public class BasicNavigationItem
extends BasicResultList<NavigationItem>
implements NavigationItem

Version:

$Id: BasicNavigationItem.java 7225 2009-04-09 00:32:20Z ssmiweve $

See Also:

Serialized Form

Constructor Summary

BasicNavigationItem()

BasicNavigationItem(String title, String url, int hitCount)

Method Summary

NavigationItem	getChildByTitle(String title)
List<NavigationItem>	getChildrenRecursive() Create a list off all children collected recursivly (Depth first).
int	getDepth() The depth of this element.
List<NavigationItem>	getSelectedBranch() Return a list of NavigationItem's that makes up the selected path of this NavigationItem.
NavigationItem	getSelectedChild()
boolean	isChildSelected()
boolean	isSelected()
void	setDepth(int d) The depth of this element.
void	setSelected(boolean selected)

Methods inherited from class no.sesat.search.result.BasicResultList

addField, addObjectField, addQuerySuggestion, addRelevantQuery, addResult, addResults, addSpellingSuggestion, addToMultivaluedField, getHitCount, getQuerySuggestions, getRelevantQueries, getResults, getResultsSize, getSpellingSuggestions, getSpellingSuggestionsMap, removeResult, removeResults, replaceResult, setHitCount, sortResults

Methods inherited from class no.sesat.search.result.BasicResultItem

equals, getField, getField, getFieldNames, getFields, getInteger, getMultivaluedField, getObjectField, getTitle, getUrl, hashCode, setTitle, setUrl

Methods inherited from class java.lang.Object

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

Methods inherited from interface no.sesat.search.result.ResultList

addField, addObjectField, addQuerySuggestion, addResult, addResults, addSpellingSuggestion, getHitCount, getQuerySuggestions, getRelevantQueries, getResults, getSpellingSuggestions, removeResult, removeResults, replaceResult, setHitCount, sortResults

Methods inherited from interface no.sesat.search.result.ResultItem

addToMultivaluedField, getField, getFieldNames, getMultivaluedField, getObjectField, getTitle, getUrl, setTitle, setUrl

Constructor Detail

BasicNavigationItem

public BasicNavigationItem()

BasicNavigationItem

public BasicNavigationItem(String title,
                           String url,
                           int hitCount)

Parameters:

title -

url -

hitCount -

Method Detail

setSelected

public void setSelected(boolean selected)

Specified by:

setSelected in interface NavigationItem

Parameters:

selected -

isSelected

public boolean isSelected()

Specified by:

isSelected in interface NavigationItem

Returns:

getSelectedChild

public NavigationItem getSelectedChild()

Specified by:

getSelectedChild in interface NavigationItem

isChildSelected

public boolean isChildSelected()

Specified by:

isChildSelected in interface NavigationItem

getChildByTitle

public NavigationItem getChildByTitle(String title)

Specified by:

getChildByTitle in interface NavigationItem

getSelectedBranch

public List<NavigationItem> getSelectedBranch()

Return a list of NavigationItem's that makes up the selected path of this NavigationItem. This path will go from this element all the way to the last selected child.

Returns:

List of selected elements.

getChildrenRecursive

public List<NavigationItem> getChildrenRecursive()

Create a list off all children collected recursivly (Depth first).

Returns:

getDepth

public int getDepth()

Description copied from interface: NavigationItem

The depth of this element. (Used when elements are organized in tree like struktures) (This might not be the global depth of the navigation item)

Specified by:

getDepth in interface NavigationItem

Returns:

Depth of this element.

setDepth

public void setDepth(int d)

The depth of this element. (Used when elements are organized in tree like struktures

Parameters:

d - Depth of element.