org.docgene.model.globals

Class ArticlesGlossary

java.lang.Object

org.docgene.model.AbstractXMLParent

org.docgene.model.AbstractXMLParentArticle

org.docgene.model.XMLArticle

org.docgene.model.globals.ArticlesGlossary

All Implemented Interfaces:

java.lang.Comparable<Article>, Article, org.docgene.model.globals.PackagedElement, org.docgene.model.globals.RootElement, org.docgene.model.globals.XMLRootElement, HTMLOutput, XMLParent, XMLParentArticle

public class ArticlesGlossary
extends XMLArticle

Maintains a glossary of terms sorted by their first letter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArticlesGlossary.Letter Represents one Letter in the glossary.
class	ArticlesGlossary.Word Represents one Word in the glossary.

Field Summary

Fields inherited from class org.docgene.model.XMLArticle

desc, id

Fields inherited from class org.docgene.model.AbstractXMLParent

chapters, paragraphs

Fields inherited from interface org.docgene.model.Article

INDEX, INDEX_LC, TYPE_ARTICLE, TYPE_DISAMB, TYPE_FALLBACK, TYPE_INDEX, TYPE_RAW_HTML, TYPE_REDIRECT, TYPE_TEMPLATE

Fields inherited from interface org.docgene.model.globals.RootElement

ARTICLE, CATEGORIES, CATEGORY, DICTIONARY, FOOTER, FULL_TEXT_SEARCH, GLOSSARY, HEADER, IMAGE_DEFINITION, IMAGES_DEFINITION, INFOBOX_DEFINITION, INFOBOX_PROPERTY, MENUS, PACKAGE, RESOURCE_DEFINITION, RESOURCES_DEFINITION, UNDEFINED

Constructor Summary

Constructors

Constructor and Description
ArticlesGlossary(ArticlesModel model) Constructor.

Method Summary

Modifier and Type	Method and Description
ArticlesGlossary.Word	addWord(java.lang.String word, boolean keepCase) Add an word to the glossary.
void	addWordAnchor(XMLWord word) Add a word anchor.
java.util.SortedMap<java.lang.String,ArticlesGlossary.Letter>	getGlossary() Return the Map of letters.
java.lang.String	getID() Return the article ID.
java.io.File	getInputFile() Return the glossary input XML file.
ArticlesModel	getModel() Return the articles model.
short	getRootElementType() Return the RootElement.GLOSSARY type.
java.util.Map<java.lang.String,java.util.List<XMLWord>>	getWordAnchors() Return the word anchors.
java.util.Map<java.lang.String,ArticlesGlossary.Word>	getWords() Return the map of Words.
boolean	isFound() Return true if the glossary description was found.
boolean	isManualPolicy() Return true if the policy of the glossary is manual.
void	setFound(boolean isFound) Set if the glossary description was found.
void	setInputFile(java.io.File file) Set the glossary input XML file.
void	setManualPolicy(boolean manualPolicy) Set if the policy of the glossary is manual.

Methods inherited from class org.docgene.model.XMLArticle

addAlternateTitle, addAnchor, addCategory, addChapter, addChapter, addComment, addInclude, addInfobox, addMap, addMessageBox, addNote, addResolvedChapter, addResolvedTitle, addSeeAlsoReference, addTitle, addTitle, addTodo, articleNameAlreadyTaken, compareTo, countSortableTables, countTitles, equals, getAlternateTitles, getAlternateTitlesMap, getAnchor, getAnchorElements, getAnchors, getArticle, getArticleRef, getArticleType, getCategories, getDescription, getHeader, getHeader, getIncludes, getInfoboxes, getJustification, getLinksFromFile, getMaps, getMessageBoxes, getMeta, getNote, getNotes, getNotesByID, getOutputFile, getPackage, getParent, getRelativePath, getReviewElements, getSearchableTitles, getSeeAlso, getSeeAlsoHeading, getSuffix, getSyntaxType, getTitledElementsList, getTitlesOrIncludes, hasAnchor, hasAnchorElement, hasAnchors, hashCode, hasID, hasImageMaps, hasIncludes, hasInfoboxes, hasMaps, hasMessageBoxes, hasNote, hasPackage, hasReviewElements, hasSearchableTitles, hasTitledElementsList, hasTitles, hasTOC, incrementSortableTables, isDirect, isIndex, isKeepingCase, isNotesTwoColumns, isTemplate, isTitlesResolved, isXMLArticle, resolveTitles, setArticleNameAlreadyTaken, setCategories, setDescription, setHasImageMaps, setID, setJustification, setKeepCase, setLinksFromFile, setMeta, setNotesTwoColumns, setOutputFile, setPackage, setRelativePath, setSeeAlsoHeading, setSuffix, setSyntaxType, setTemplate, setTitledElementsList, setTOC, toString

Methods inherited from class org.docgene.model.AbstractXMLParentArticle

addArticleParent, addLinkFromArticle, addReference, addReference, getArticleParents, getCondition, getLinksFrom, getReferences, getRoot, hasCondition, hasImages, isPresent, setCondition, setImages, setLinkFromArticles, setRoot

Methods inherited from class org.docgene.model.AbstractXMLParent

addParagraph, getChapters, getParagraphs

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.docgene.model.XMLParentArticle

hasNotes, isGlobalIndex

Methods inherited from interface org.docgene.model.Article

getNormalizedAlternateTitles, getRef, getTitle, hasAlternateTitles, hasSuffix, isDirectXMLArticle, isRawHTMLArticle, isValid

Methods inherited from interface org.docgene.model.globals.XMLRootElement

getAbsolutePath, hasInputFile, isParsable

Methods inherited from interface org.docgene.model.globals.RootElement

hasRoot, isArticle, isFallback, notExistingInputFile

Methods inherited from interface org.docgene.model.XMLParent

addParagraph, getChapters, getParagraphs

Methods inherited from interface org.docgene.model.HTMLOutput

hasOutputFile

Constructor Detail

ArticlesGlossary

public ArticlesGlossary(ArticlesModel model)

Constructor.

Parameters:

model - the articles model

Method Detail

getRootElementType

public short getRootElementType()

Return the RootElement.GLOSSARY type.

Returns:

the element type

getID

public java.lang.String getID()

Description copied from class: XMLArticle

Return the article ID.

Specified by:

getID in interface Article

Specified by:

getID in interface org.docgene.model.globals.RootElement

Overrides:

getID in class XMLArticle

Returns:

the article ID

setFound

public void setFound(boolean isFound)

Set if the glossary description was found.

Parameters:

isFound - true if the glossary description was found

isFound

public boolean isFound()

Return true if the glossary description was found.

Returns:

true if the glossary description was found

setManualPolicy

public void setManualPolicy(boolean manualPolicy)

Set if the policy of the glossary is manual.

Parameters:

manualPolicy - true if the policy of the glossary is manual

isManualPolicy

public boolean isManualPolicy()

Return true if the policy of the glossary is manual.

Returns:

true if the policy of the glossary is manual

getModel

public ArticlesModel getModel()

Return the articles model.

Returns:

the articles model

setInputFile

public void setInputFile(java.io.File file)

Set the glossary input XML file.

Specified by:

setInputFile in interface org.docgene.model.globals.XMLRootElement

Overrides:

setInputFile in class XMLArticle

Parameters:

file - the glossary input XML file

getInputFile

public java.io.File getInputFile()

Return the glossary input XML file.

Specified by:

getInputFile in interface org.docgene.model.globals.RootElement

Overrides:

getInputFile in class XMLArticle

Returns:

the glossary input XML file.

getGlossary

public java.util.SortedMap<java.lang.String,ArticlesGlossary.Letter> getGlossary()

Return the Map of letters.

Returns:

the Map of letters

addWordAnchor

public void addWordAnchor(XMLWord word)

Add a word anchor.

Parameters:

word - the word anchor.

getWordAnchors

public java.util.Map<java.lang.String,java.util.List<XMLWord>> getWordAnchors()

Return the word anchors.

Returns:

the word anchors.

addWord

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

Add an word to the glossary. Note that if the word already exist, the previously defined word will be returned instead.

Parameters:

word - the word definition

keepCase -

Returns:

the word

getWords

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

Return the map of Words.

Returns:

the map of Words