org.gbif.api.model.checklistbank

Class TableOfContents

java.lang.Object

org.gbif.api.model.checklistbank.TableOfContents

public class TableOfContents
extends Object

A simple class to represent a table of contents for multiple languages. It is used by species pages to generate a table of contents menu with asynchronous loading of full descriptions.

Constructor Summary

Constructors

Constructor and Description
TableOfContents()

Method Summary

Modifier and Type	Method and Description
void	addDescription(int key, Language lang, String topic)
boolean	equals(Object o)
Map<Language,Map<String,List<Integer>>>	getToc()
int	hashCode()
boolean	isEmpty()
List<Language>	listLanguages()
Map<String,List<Integer>>	listTopicEntries(Language lang)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TableOfContents

public TableOfContents()

Method Detail

addDescription

public void addDescription(int key,
                           Language lang,
                           String topic)

isEmpty

public boolean isEmpty()

listLanguages

public List<Language> listLanguages()

Returns:

list of all languages available for this ToC

listTopicEntries

public Map<String,List<Integer>> listTopicEntries(Language lang)

Returns:

map of all topics for a given language with a list of entry keys for each language

getToc

public Map<Language,Map<String,List<Integer>>> getToc()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object