org.docgene.model

Class XMLComment

java.lang.Object

org.docgene.model.XMLComment

All Implemented Interfaces:

ImportanceType, ParagraphElement, ReviewElement, StyledElement

public class XMLComment
extends java.lang.Object
implements ParagraphElement, ReviewElement, ImportanceType

Represent the content of a <comment> tag.

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Fields inherited from interface org.docgene.model.ImportanceType

CRITICAL, IMPORTANT, NORMAL

Constructor Summary

Constructors

Constructor and Description
XMLComment()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthor() Return the author.
java.lang.String	getComment() Return the comment.
java.lang.String	getDate() Return the date.
java.lang.String	getDeclaration() Return the declaration ID of the element.
int	getIndex() Return the comment index.
java.lang.String	getRef() Return the comment reference composed using the comment index.
java.lang.String	getTODOText() Return the text of the comment.
short	getType() Return the type of the comment.
boolean	hasAuthor() Return true if the comment has an author.
boolean	hasDate() Return true if the comment has a date.
void	setAuthor(java.lang.String author) Set the author.
void	setComment(java.lang.String comment) Set the comment.
void	setDate(java.lang.String date) Set the date.
void	setIndex(int index) Set the comment index.
void	setType(short type) Set the type of the comment.

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

Constructor Detail

XMLComment

public XMLComment()

Method Detail

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

setType

public void setType(short type)

Set the type of the comment.

Parameters:

type - the type

getType

public short getType()

Return the type of the comment.

Returns:

the type

setComment

public void setComment(java.lang.String comment)

Set the comment.

Parameters:

comment - the comment

getComment

public java.lang.String getComment()

Return the comment.

Returns:

the comment

setAuthor

public void setAuthor(java.lang.String author)

Set the author.

Parameters:

author - the author

getAuthor

public java.lang.String getAuthor()

Return the author.

Returns:

the author

hasAuthor

public boolean hasAuthor()

Return true if the comment has an author.

Returns:

true if the comment has an author

setDate

public void setDate(java.lang.String date)

Set the date.

Parameters:

date - the date

getDate

public java.lang.String getDate()

Return the date.

Returns:

the date

hasDate

public boolean hasDate()

Return true if the comment has a date.

Returns:

true if the comment has a date

setIndex

public void setIndex(int index)

Set the comment index.

Parameters:

index - the comment index

getIndex

public int getIndex()

Return the comment index.

Specified by:

getIndex in interface ReviewElement

Returns:

the comment index

getTODOText

public java.lang.String getTODOText()

Return the text of the comment. Defer to getComment().

Specified by:

getTODOText in interface ReviewElement

Returns:

the text of the comment

getRef

public java.lang.String getRef()

Return the comment reference composed using the comment index.

Specified by:

getRef in interface ReviewElement

Returns:

the comment reference