org.docgene.model.globals

Class ArticlesDictionary

java.lang.Object

org.docgene.model.AbstractXMLParent

org.docgene.model.globals.ArticlesDictionary

All Implemented Interfaces:

org.docgene.model.globals.PackagedElement, org.docgene.model.globals.RootElement, org.docgene.model.globals.XMLRootElement, HTMLOutput, XMLParent

public class ArticlesDictionary
extends AbstractXMLParent
implements HTMLOutput, org.docgene.model.globals.XMLRootElement

Maintains the dictionary of articles sorted by their first letter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ArticlesDictionary.Letter Represents one Letter in the dictionnary.

Field Summary

Fields inherited from class org.docgene.model.AbstractXMLParent

chapters, paragraphs

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
ArticlesDictionary(ArticlesModel model) Constructor.

Method Summary

Modifier and Type	Method and Description
Article	addArticle(Article article) Add an article to the dictionnary.
Article	addArticle(Article article, boolean checkName) Add an article to the dictionnary.
Article	addArticle(java.lang.String desc, boolean keepCase, Article article) Add an article to the dictionnary.
Article	addArticleToPackage(Article article) Add an article in its corresponding package.This method should only be called if the article is not included by default in the wiki.
void	allowAutoDisambiguation(boolean allowAutoDisambiguation) Set if the automatic creation of disambiguation articles is allowed.
void	clear() Clear the content of the dictionary.
java.util.SortedMap<java.lang.String,ArticlesDictionary.Letter>	getDictionary() Return the Map of articles sorted by their first letter.
java.lang.String	getID()
java.io.File	getInputFile() Return the dictionnary input XML file.
ArticlesModel	getModel() Return the articles model.
java.io.File	getOutputFile() Return the dictionnary output file.
XMLParent	getParent() Return null.
org.docgene.model.globals.RootDirectory	getRoot() Return the root directory.
short	getRootElementType() Return the RootElement.DICTIONARY type.
void	resolve() Setup the dictionary.
void	setInputFile(java.io.File file) Set the dictionnary input XML file.
void	setOutputFile(java.io.File file) Set the dictionnary output file.
void	setRoot(org.docgene.model.globals.RootDirectory root) Set the root directory.

Methods inherited from class org.docgene.model.AbstractXMLParent

addChapter, addParagraph, getChapters, getParagraphs, isEmpty

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.globals.XMLRootElement

getAbsolutePath, getPackage, getRelativePath, hasInputFile, hasPackage, isParsable, setPackage

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

hasRoot, isArticle, isFallback, notExistingInputFile

Constructor Detail

ArticlesDictionary

public ArticlesDictionary(ArticlesModel model)

Constructor.

Parameters:

model - the articles model

Method Detail

clear

public void clear()

Clear the content of the dictionary.

allowAutoDisambiguation

public void allowAutoDisambiguation(boolean allowAutoDisambiguation)

Set if the automatic creation of disambiguation articles is allowed.

Parameters:

allowAutoDisambiguation - true if if the automatic creation of disambiguation articles is allowed

getModel

public ArticlesModel getModel()

Return the articles model.

Returns:

the articles model

getParent

public XMLParent getParent()

Return null.

Specified by:

getParent in interface XMLParent

Returns:

null

setInputFile

public void setInputFile(java.io.File file)

Set the dictionnary input XML file.

Specified by:

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

Parameters:

file - the dictionnary input XML file

getInputFile

public java.io.File getInputFile()

Return the dictionnary input XML file.

Specified by:

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

Returns:

the dictionnary input XML file.

setRoot

public void setRoot(org.docgene.model.globals.RootDirectory root)

Set the root directory.

Parameters:

root - the root

getRoot

public org.docgene.model.globals.RootDirectory getRoot()

Return the root directory.

Specified by:

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

Returns:

the root

setOutputFile

public void setOutputFile(java.io.File file)

Set the dictionnary output file.

Parameters:

file - the dictionnary output file

getOutputFile

public java.io.File getOutputFile()

Return the dictionnary output file.

Specified by:

getOutputFile in interface HTMLOutput

Returns:

the dictionnary output file

getDictionary

public java.util.SortedMap<java.lang.String,ArticlesDictionary.Letter> getDictionary()

Return the Map of articles sorted by their first letter.

Returns:

the Map of articles sorted by their first letter

resolve

public void resolve()

Setup the dictionary.

addArticle

public Article addArticle(Article article)

Add an article to the dictionnary.

Parameters:

article - the article

Returns:

the added article

addArticleToPackage

public Article addArticleToPackage(Article article)

Add an article in its corresponding package.This method should only be called if the article is not included by default in the wiki.

Parameters:

article - the article

Returns:

the article, or null if the article must not be added

addArticle

public Article addArticle(Article article,
                          boolean checkName)

Add an article to the dictionnary.

Parameters:

article - the article

checkName - true if the name for the article must be checked

Returns:

the added article

addArticle

public Article addArticle(java.lang.String desc,
                          boolean keepCase,
                          Article article)

Add an article to the dictionnary.

Parameters:

desc - the article description to be added to the dictionnary

keepCase - true if the letter case should be kept

article - the article

Returns:

the added article

getRootElementType

public short getRootElementType()

Return the RootElement.DICTIONARY type.

Specified by:

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

Returns:

the element type

getID

public java.lang.String getID()

Specified by:

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