org.docgene.model

Class XMLCommentList

java.lang.Object

org.docgene.model.XMLCommentList

All Implemented Interfaces:

ParagraphElement, StyledElement

public class XMLCommentList
extends java.lang.Object
implements ParagraphElement

Represent the content of a <commentlist> tag.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMLCommentList.ArticleComments The review elements for one article.

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Method Summary

Modifier and Type	Method and Description
void	addComment(XMLArticle article, XMLComment comment) Add a comment reference.
void	addTODO(XMLArticle article, TodoElement todo) Add a comment reference.
java.util.Map<java.lang.String,XMLCommentList.ArticleComments>	getComments() Return the comments sorted by article id.
java.lang.String	getDeclaration() Return the declaration ID of the element.
static XMLCommentList	getInstance()
XMLList	getList() Return the comment list as a "ol" element.
boolean	hasComments() Return true if there are comments.

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.StyledElement

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

Method Detail

getInstance

public static XMLCommentList getInstance()

getDeclaration

public java.lang.String getDeclaration()

Return the declaration ID of the element.

Specified by:

getDeclaration in interface StyledElement

Returns:

the declaration ID of the element

getList

public XMLList getList()

Return the comment list as a "ol" element.

Returns:

the comment list as a "ol" element.

getComments

public java.util.Map<java.lang.String,XMLCommentList.ArticleComments> getComments()

Return the comments sorted by article id.

Returns:

the comments

hasComments

public boolean hasComments()

Return true if there are comments.

Returns:

true if there are comments

addComment

public void addComment(XMLArticle article,
                       XMLComment comment)

Add a comment reference.

Parameters:

article - the article where there is the comment

comment - the comment

addTODO

public void addTODO(XMLArticle article,
                    TodoElement todo)

Add a comment reference.

Parameters:

article - the article where there is the comment

todo - the todo