org.docgene.model.globals

Class ArticleCategory

java.lang.Object

org.docgene.model.AbstractXMLParent

org.docgene.model.globals.ArticleCategory

All Implemented Interfaces:

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

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

Represents an article category.

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
ArticleCategory(ArticlesModel model) Constructor.
ArticleCategory(ArticlesModel model, java.lang.String desc) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addArticle(Article article) Add an article.
void	addSubCategory(ArticleCategory category) Add a sub-category.
java.util.Map<java.lang.String,Article>	getArticles() Return the articles in this category.
java.util.Map<ArticleRef,Article>	getArticlesByRef() Return the articles in this category, mapped by their ref.
org.docgene.main.props.CountProperty	getCount() Return the number of articles in the category.
java.lang.String	getDesc() Return the category title.
java.lang.String	getDescription() Return the category description.
java.lang.String	getID() Return the category ID.
java.io.File	getInputFile() Return the category input XML file.
XMLParentArticle	getMainArticle() Return the main article of the category.
ArticlesModel	getModel() Return the articles model.
java.io.File	getOutputFile() Return the category description output file.
XMLParent	getParent() Return null.
java.util.Map<java.lang.String,ArticleCategory>	getParentCategories() Return the parent categories.
org.docgene.model.globals.RootDirectory	getRoot() Return the root directory.
short	getRootElementType() Return the RootElement.CATEGORY type.
java.util.Map<java.lang.String,ArticleCategory>	getSubCategories() Return the sub-categories.
boolean	hasMainArticle() Return true if there is a main article for the category.
boolean	hasParentCategories() Return true if there are parent categories.
boolean	hasSubCategories() Return true if there are sub-categories.
boolean	isEmpty() Return true if this category is empty.
void	setDescription(java.lang.String desc) Set the category description.
void	setInputFile(java.io.File file) Set the category input XML file.
void	setMainArticle(XMLParentArticle mainArticle) Set the main article of the category.
void	setOutputFile(java.io.File file) Set the category description output file.
void	setRoot(org.docgene.model.globals.RootDirectory root) Set the root directory.
java.lang.String	toString()

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, 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

ArticleCategory

public ArticleCategory(ArticlesModel model)

Constructor.

Parameters:

model - the articles model

ArticleCategory

public ArticleCategory(ArticlesModel model,
                       java.lang.String desc)

Constructor.

Parameters:

model - the articles model

desc - the category name

Method Detail

getModel

public ArticlesModel getModel()

Return the articles model.

Returns:

the articles model

setMainArticle

public void setMainArticle(XMLParentArticle mainArticle)

Set the main article of the category.

Parameters:

mainArticle - the article

getMainArticle

public XMLParentArticle getMainArticle()

Return the main article of the category.

Returns:

the article

addSubCategory

public void addSubCategory(ArticleCategory category)

Add a sub-category.

Parameters:

category - the sub-category

hasSubCategories

public boolean hasSubCategories()

Return true if there are sub-categories.

Returns:

true if there are sub-categories

getSubCategories

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

Return the sub-categories.

Returns:

the sub-categories

hasParentCategories

public boolean hasParentCategories()

Return true if there are parent categories.

Returns:

true if there are parent categories

getParentCategories

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

Return the parent categories.

Returns:

the parent categories

hasMainArticle

public boolean hasMainArticle()

Return true if there is a main article for the category.

Returns:

true if there is a main article for the category

getCount

public org.docgene.main.props.CountProperty getCount()

Return the number of articles in the category. This is a property which can be accessed through the CountProperty.COUNT property.

Returns:

the number of articles in the category

getParent

public XMLParent getParent()

Return null.

Specified by:

getParent in interface XMLParent

Returns:

null

setInputFile

public void setInputFile(java.io.File file)

Set the category input XML file.

Specified by:

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

Parameters:

file - the category input XML file

getInputFile

public java.io.File getInputFile()

Return the category input XML file.

Specified by:

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

Returns:

the category 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 category description output file.

Parameters:

file - the category description output file

getOutputFile

public java.io.File getOutputFile()

Return the category description output file.

Specified by:

getOutputFile in interface HTMLOutput

Returns:

the category description output file

getID

public java.lang.String getID()

Return the category ID.

Specified by:

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

Returns:

the category ID

getDesc

public java.lang.String getDesc()

Return the category title.

Returns:

the category title

setDescription

public void setDescription(java.lang.String desc)

Set the category description.

Parameters:

desc - the description

getDescription

public java.lang.String getDescription()

Return the category description.

Returns:

the category description

addArticle

public void addArticle(Article article)

Add an article.

Parameters:

article - the article

getArticles

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

Return the articles in this category.

Returns:

the articles

isEmpty

public boolean isEmpty()

Return true if this category is empty.

Specified by:

isEmpty in interface XMLParent

Overrides:

isEmpty in class AbstractXMLParent

Returns:

true if this category is empty

getArticlesByRef

public java.util.Map<ArticleRef,Article> getArticlesByRef()

Return the articles in this category, mapped by their ref.

Returns:

the articles

getRootElementType

public short getRootElementType()

Return the RootElement.CATEGORY type.

Specified by:

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

Returns:

the element type

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object