org.docgene.model

Class XMLCategoryReference

java.lang.Object

org.docgene.model.XMLCategoryReference

All Implemented Interfaces:

ElementReference, ParagraphElement, StyledElement

public class XMLCategoryReference
extends java.lang.Object
implements ParagraphElement, ElementReference

Represent an internal reference to a category description.

Example

 <catRef id="mycat" desc="the description" />
 

This links to the category which ID is "mycat".

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLCategoryReference(XMLArticle article, java.lang.String catID) Constructor.

Method Summary

Modifier and Type	Method and Description
void	bind(ArticleCategory refCat) Set the referenced category.
ArticleCategory	getCategory() Return the referenced article.
java.lang.String	getDesc() Return the reference text.
java.lang.String	getID() Return the referenced category ID.
int	getLineNumber() Return the line where the reference appear.
XMLArticle	getOriginArticle() Return the article which emit the reference.
void	setDesc(java.lang.String desc) Set the reference text.
void	setLineNumber(int lineNumber) Set the line number where the reference appear.

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, getDeclaration, getInlinedStyle, getStyle, hasInlinedStyle, setCustomStyles, setCustomStyles, setInlinedStyle

Methods inherited from interface org.docgene.model.ElementReference

hasLineNumber

Constructor Detail

XMLCategoryReference

public XMLCategoryReference(XMLArticle article,
                            java.lang.String catID)

Constructor.

Parameters:

article - the article which emit the reference

catID - the category ID

Method Detail

getOriginArticle

public XMLArticle getOriginArticle()

Return the article which emit the reference.

Returns:

the article

getCategory

public ArticleCategory getCategory()

Return the referenced article.

Returns:

the referenced article

setLineNumber

public void setLineNumber(int lineNumber)

Set the line number where the reference appear.

Parameters:

lineNumber - the line number

getLineNumber

public int getLineNumber()

Return the line where the reference appear.

Specified by:

getLineNumber in interface ElementReference

Returns:

the line number

setDesc

public void setDesc(java.lang.String desc)

Set the reference text.

Parameters:

desc - the reference text

getID

public java.lang.String getID()

Return the referenced category ID.

Returns:

the referenced category ID

getDesc

public java.lang.String getDesc()

Return the reference text.

Returns:

the reference text

bind

public void bind(ArticleCategory refCat)

Set the referenced category.

Parameters:

refCat - the referenced category