org.docgene.model.globals

Class ArticlesGlossary.Word

java.lang.Object

org.docgene.model.AbstractXMLParent

org.docgene.model.globals.ArticlesGlossary.Word

All Implemented Interfaces:

ArticleReference, ElementReference, HTMLOutput, ParagraphArticleReference, ParagraphElement, StyledElement, XMLParent

Enclosing class:

ArticlesGlossary

public class ArticlesGlossary.Word
extends AbstractXMLParent
implements HTMLOutput, StyledElement, ParagraphArticleReference

Represents one Word in the glossary.

Field Summary

Fields inherited from class org.docgene.model.AbstractXMLParent

chapters, paragraphs

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
Word(java.lang.String word)
Word(java.lang.String word, boolean keepCase) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addAlternateTerm(java.lang.String altTerm, boolean keepCase) Add an alternate term for the Word.
void	addArticle(Article article, java.lang.String line) Add an article to the Word.
void	addWordAnchor(XMLWord wordAnchor) Add a word anchor to the word.
void	bind(XMLParentArticle article) Set the referenced article.
void	bind(XMLParentArticle article, AnchorElement anchor) Set the referenced article and associated chapter or title.
java.util.Map<java.lang.String,java.lang.Boolean>	getAlternateTerms() Return the alternate terms fo the Word.
AnchorElement	getAnchorElement() Return the referenced anchor element.
ArticleRef	getArticleRef() Return the associated reference.
java.util.SortedMap<java.lang.String,Article>	getArticles() Return the Map of articles for the letter.
java.lang.String	getContext(java.lang.String articleDesc) Return the word context for an article.
java.lang.String	getDesc() Return the word.
int	getLineNumber() Return -1.
java.io.File	getOutputFile() Return the HTML root element output file.
XMLParent	getParent() Return null.
XMLParentArticle	getReferencedArticle() Return the referenced article.
java.lang.String	getRefID() Return the other article reference ID.
java.lang.String	getRefPackage() Return null.
java.lang.String	getTitle() Return the word title.
java.lang.String	getWord() Return the word.
java.util.SortedMap<ArticleRef,java.util.List<XMLWord>>	getWordAnchors() Return ther word anchors associated with the word.
boolean	hasAlternateTerms() Return true if there are alternate terms for the word.
boolean	hasReference() Return true if the word has a reference to an anchor or article.
boolean	hasWordAnchors() Return true if there are word anchors for this word.
boolean	isBound() Return true if the reference is bound.
boolean	isKeepingCase() Return true if the word should keep its case.
void	setID(java.lang.String id) Set the word reference ID.
void	setTitle(java.lang.String title) Set the word title.

Methods inherited from class org.docgene.model.AbstractXMLParent

addChapter, addParagraph, getChapters, getParagraphs

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.docgene.model.HTMLOutput

hasOutputFile

Methods inherited from interface org.docgene.model.ArticleReference

isAutoDesc, isBareReference, setDesc

Methods inherited from interface org.docgene.model.StyledElement

getCustomStyles, getDeclaration, getInlinedStyle, getStyle, hasInlinedStyle, setCustomStyles, setCustomStyles, setInlinedStyle

Methods inherited from interface org.docgene.model.ElementReference

hasLineNumber

Constructor Detail

Word

public Word(java.lang.String word)

Word

public Word(java.lang.String word,
            boolean keepCase)

Constructor.

Parameters:

word - the word

keepCase - true if the article title should keep the title description case

Method Detail

isKeepingCase

public boolean isKeepingCase()

Return true if the word should keep its case.

Returns:

true if the word should keep its case

setTitle

public void setTitle(java.lang.String title)

Set the word title.

Parameters:

title - the title

getLineNumber

public int getLineNumber()

Return -1.

Specified by:

getLineNumber in interface ElementReference

Returns:

-1

setID

public void setID(java.lang.String id)

Set the word reference ID.

Parameters:

id - the ID

getTitle

public java.lang.String getTitle()

Return the word title.

Returns:

the word title

hasReference

public boolean hasReference()

Return true if the word has a reference to an anchor or article.

Returns:

true if the word has a reference to an anchor or article.

isBound

public boolean isBound()

Return true if the reference is bound.

Specified by:

isBound in interface ArticleReference

Returns:

true if the reference is bound

addAlternateTerm

public void addAlternateTerm(java.lang.String altTerm,
                             boolean keepCase)

Add an alternate term for the Word.

Parameters:

altTerm - the alternate term

keepCase - true if the alternate term should keep its case

hasAlternateTerms

public boolean hasAlternateTerms()

Return true if there are alternate terms for the word.

Returns:

true if there are alternate terms for the word

getAlternateTerms

public java.util.Map<java.lang.String,java.lang.Boolean> getAlternateTerms()

Return the alternate terms fo the Word.

Returns:

the alternate terms

getWord

public java.lang.String getWord()

Return the word.

Returns:

the word

addArticle

public void addArticle(Article article,
                       java.lang.String line)

Add an article to the Word.

Parameters:

article - the article

line - the context where the term was found

getArticles

public java.util.SortedMap<java.lang.String,Article> getArticles()

Return the Map of articles for the letter.

Returns:

the Map of articles

getContext

public java.lang.String getContext(java.lang.String articleDesc)

Return the word context for an article.

Parameters:

articleDesc - the article description

Returns:

the context

addWordAnchor

public void addWordAnchor(XMLWord wordAnchor)

Add a word anchor to the word.

Parameters:

wordAnchor - the word anchor

getWordAnchors

public java.util.SortedMap<ArticleRef,java.util.List<XMLWord>> getWordAnchors()

Return ther word anchors associated with the word.

Returns:

the word anchors

hasWordAnchors

public boolean hasWordAnchors()

Return true if there are word anchors for this word.

Returns:

true if there are word anchors for this word

getParent

public XMLParent getParent()

Return null.

Specified by:

getParent in interface XMLParent

Returns:

null

getOutputFile

public java.io.File getOutputFile()

Return the HTML root element output file.

Specified by:

getOutputFile in interface HTMLOutput

Returns:

the HTML root element output file

getRefID

public java.lang.String getRefID()

Return the other article reference ID.

Specified by:

getRefID in interface ArticleReference

Returns:

the other article reference ID

getReferencedArticle

public XMLParentArticle getReferencedArticle()

Return the referenced article.

Specified by:

getReferencedArticle in interface ArticleReference

Returns:

the referenced article

getArticleRef

public ArticleRef getArticleRef()

Return the associated reference.

Specified by:

getArticleRef in interface ArticleReference

Returns:

the reference

getAnchorElement

public AnchorElement getAnchorElement()

Return the referenced anchor element. Return null by default.

Specified by:

getAnchorElement in interface ArticleReference

Returns:

the referenced anchor element

getDesc

public java.lang.String getDesc()

Return the word.

Specified by:

getDesc in interface ArticleReference

Returns:

the word

getRefPackage

public java.lang.String getRefPackage()

Return null.

Specified by:

getRefPackage in interface ArticleReference

Returns:

null

bind

public void bind(XMLParentArticle article)

Set the referenced article.

Specified by:

bind in interface ArticleReference

Parameters:

article - the referenced article

bind

public void bind(XMLParentArticle article,
                 AnchorElement anchor)

Set the referenced article and associated chapter or title.

Specified by:

bind in interface ArticleReference

Parameters:

article - the referenced article

anchor - the AnchorElement