org.docgene.model

Class XMLInclude

java.lang.Object

org.docgene.model.XMLInclude

All Implemented Interfaces:

ArticleReference, ElementReference, ParagraphArticleReference, ParagraphElement, StyledElement, TitleOrIncludeElement

public class XMLInclude
extends java.lang.Object
implements ParagraphArticleReference, TitleOrIncludeElement

Represent an included internal reference (to another article). The reference can link to an article which be included in the origin article.

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLInclude(XMLArticle article, java.lang.String refID, java.lang.String pack) Constructor.

Method Summary

Modifier and Type	Method and Description
void	bind(XMLParentArticle article) Set the referenced article.
ArticleRef	getArticleRef() Return the associated reference.
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.lang.String	getDesc() Return the reference text.
int	getLineNumber() Return the line where the reference appear.
XMLArticle	getOriginArticle() Return the article which emit the reference.
java.lang.String	getPackage() Return the included article package.
int	getPreviousTitleIndex() Return the index of the title or chapter preceding the include element (0 means that there is no title or chapter before the include element).
XMLParentArticle	getReferencedArticle() Return the referenced article.
java.lang.String	getRefID() Return the other article reference ID.
boolean	isBound() Return true if the reference is bound.
boolean	isKeepingNumbering() Return true if the titles numbering levels is kept.
void	setKeepNumbering(boolean keepNumbering) Set if the titles numbering levels is kept.
void	setLineNumber(int lineNumber) Set the line number where the reference appear.
void	setPreviousTitleIndex(int previousTitleIndex) Set the index of the title or chapter preceding the include element (0 means that there is no title or chapter before the include element).
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.docgene.model.ArticleReference

bind, getAnchorElement, getRefPackage, isAutoDesc, isBareReference, setDesc

Methods inherited from interface org.docgene.model.StyledElement

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

Methods inherited from interface org.docgene.model.ElementReference

hasLineNumber

Constructor Detail

XMLInclude

public XMLInclude(XMLArticle article,
                  java.lang.String refID,
                  java.lang.String pack)

Constructor.

Parameters:

article - the article which emit the reference

refID - the included article ID

pack - the included article package

Method Detail

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

setKeepNumbering

public void setKeepNumbering(boolean keepNumbering)

Set if the titles numbering levels is kept. If false, the numbering will adapt to be under the last title before the included article.

Parameters:

keepNumbering - true if the titles numbering levels is kept

isKeepingNumbering

public boolean isKeepingNumbering()

Return true if the titles numbering levels is kept. If false, the numbering will adapt to be under the last title before the included article.

Returns:

true true if the titles numbering levels is kept

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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

getPackage

public java.lang.String getPackage()

Return the included article package.

Returns:

the included article package

setPreviousTitleIndex

public void setPreviousTitleIndex(int previousTitleIndex)

Set the index of the title or chapter preceding the include element (0 means that there is no title or chapter before the include element).

Parameters:

previousTitleIndex - the index of the title or chapter preceding the include element

getPreviousTitleIndex

public int getPreviousTitleIndex()

Return the index of the title or chapter preceding the include element (0 means that there is no title or chapter before the include element).

Returns:

the index of the title or chapter preceding the include element

getOriginArticle

public XMLArticle getOriginArticle()

Return the article which emit the reference.

Returns:

the article

getReferencedArticle

public XMLParentArticle getReferencedArticle()

Return the referenced article.

Specified by:

getReferencedArticle in interface ArticleReference

Returns:

the referenced article

getArticleRef

public ArticleRef getArticleRef()

Return the associated reference.

Specified by:

getArticleRef in interface ArticleReference

Returns:

the reference

isBound

public boolean isBound()

Return true if the reference is bound.

Specified by:

isBound in interface ArticleReference

Returns:

true if the reference is bound

getDesc

public java.lang.String getDesc()

Return the reference text.

Specified by:

getDesc in interface ArticleReference

Returns:

the reference text

getRefID

public java.lang.String getRefID()

Return the other article reference ID. It can be: through:

• Its description: see XMLArticle.getDescription()
• Its description where the white spaces have been replaced by underscore characters
• Its ID if it has an ID attribute: see XMLArticle.getID()

Specified by:

getRefID in interface ArticleReference

Returns:

the other article reference ID

bind

public void bind(XMLParentArticle article)

Set the referenced article.

Specified by:

bind in interface ArticleReference

Parameters:

article - the referenced article