org.docgene.model.globals

Class ArticlesCategories

java.lang.Object

org.docgene.model.globals.ArticlesCategories

All Implemented Interfaces:

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

public class ArticlesCategories
extends java.lang.Object
implements HTMLOutput, org.docgene.model.globals.XMLRootElement

Represdents the articles categories.

Field Summary

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
ArticlesCategories(ArticlesModel model)

Method Summary

Modifier and Type	Method and Description
void	addCategory(ArticleCategory cat) Add a category to the model.
java.util.List<Article>	getArticlesToResolve() Return the list of articles to resolve (may be null).
java.util.Map<java.lang.String,ArticleCategory>	getCategories() Return the categories.
ArticleCategory	getCategory(java.lang.String catID) Return the category with a specified ID.
ArticleCategory	getDefaultCategory() The default category is the category of articles which belong to no category.
java.lang.String	getID()
java.io.File	getInputFile()
java.io.File	getOutputFile() Return the HTML root element output file.
org.docgene.model.globals.RootDirectory	getRoot() Return null.
short	getRootElementType() Return the RootElement.CATEGORIES type.
boolean	hasArticlesToResolve() Return true if there are articles to resolve.
boolean	hasCategory(java.lang.String catID) Return true if the model has a category with a specified ID.
void	refreshCategories(org.docgene.model.globals.PackagesDependencies dependencies, Article article, boolean resolve) Integrate the categories of an article in the list of categories.
void	setInputFile(java.io.File file) Do nothing.
void	setOutputFile(java.io.File file) Set the categories output file.

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

ArticlesCategories

public ArticlesCategories(ArticlesModel model)

Method Detail

getRootElementType

public short getRootElementType()

Return the RootElement.CATEGORIES type.

Specified by:

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

Returns:

the element type

getCategories

public java.util.Map<java.lang.String,ArticleCategory> getCategories()

Return the categories.

Returns:

the categories

hasCategory

public boolean hasCategory(java.lang.String catID)

Return true if the model has a category with a specified ID.

Parameters:

catID - the category ID

Returns:

true if the model has a category with the specified ID

getCategory

public ArticleCategory getCategory(java.lang.String catID)

Return the category with a specified ID.

Parameters:

catID - the category ID

Returns:

the category with the specified ID

getDefaultCategory

public ArticleCategory getDefaultCategory()

The default category is the category of articles which belong to no category.

Returns:

the default category

refreshCategories

public void refreshCategories(org.docgene.model.globals.PackagesDependencies dependencies,
                              Article article,
                              boolean resolve)

Integrate the categories of an article in the list of categories.

Parameters:

dependencies - the packages dependencies

article - the article

resolve - true to perform the resolution

hasArticlesToResolve

public boolean hasArticlesToResolve()

Return true if there are articles to resolve.

Returns:

true if there are articles to resolve

getArticlesToResolve

public java.util.List<Article> getArticlesToResolve()

Return the list of articles to resolve (may be null).

Returns:

the list of articles to resolve

addCategory

public void addCategory(ArticleCategory cat)

Add a category to the model.

Parameters:

cat - the category

setOutputFile

public void setOutputFile(java.io.File file)

Set the categories output file.

Parameters:

file - the dictionnary output file

getOutputFile

public java.io.File getOutputFile()

Description copied from interface: HTMLOutput

Return the HTML root element output file.

Specified by:

getOutputFile in interface HTMLOutput

Returns:

the HTML root element output file

getRoot

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

Return null.

Specified by:

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

Returns:

null

setInputFile

public void setInputFile(java.io.File file)

Do nothing.

Specified by:

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

getID

public java.lang.String getID()

Specified by:

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

getInputFile

public java.io.File getInputFile()

Specified by:

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