org.docgene.model.globals

Class ArticlesGlossary.Letter

java.lang.Object

org.docgene.model.globals.ArticlesGlossary.Letter

Enclosing class:

ArticlesGlossary

public static class ArticlesGlossary.Letter
extends java.lang.Object

Represents one Letter in the glossary.

Since:

1.3

Constructor Summary

Constructors

Constructor and Description
Letter()

Method Summary

Modifier and Type	Method and Description
void	addWord(ArticlesGlossary.Word word) Add an word to the Letter.
ArticlesGlossary.Word	getWord(java.lang.String word) Return the word for a specified definition.
java.util.SortedMap<java.lang.String,ArticlesGlossary.Word>	getWords() Return the Map of words for the letter.
boolean	hasWord(java.lang.String word) Return true if the letter contains a specified word definition.

Methods inherited from class java.lang.Object

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

Constructor Detail

Letter

public Letter()

Method Detail

addWord

public void addWord(ArticlesGlossary.Word word)

Add an word to the Letter.

Parameters:

word - the word

hasWord

public boolean hasWord(java.lang.String word)

Return true if the letter contains a specified word definition.

Parameters:

word - the word

Returns:

true if the letter contains the specified word definition

getWord

public ArticlesGlossary.Word getWord(java.lang.String word)

Return the word for a specified definition.

Parameters:

word - the word definition

Returns:

the word for a specified definition

getWords

public java.util.SortedMap<java.lang.String,ArticlesGlossary.Word> getWords()

Return the Map of words for the letter.

Returns:

the Map of words