org.docgene.model

Class XMLMoreInfo

java.lang.Object

org.docgene.model.XMLReference

org.docgene.model.AbstractMoreInfoRef

org.docgene.model.XMLMoreInfo

All Implemented Interfaces:

ArticleReference, ElementReference, ParagraphArticleReference, ParagraphElement, StyledElement

public class XMLMoreInfo
extends AbstractMoreInfoRef

Represent a "moreInfo" reference which is present in a "Main Article" tag.

See Also:

XMLSeeArticle

Field Summary

Fields inherited from class org.docgene.model.XMLReference

desc, id, idMayBeDesc, rawID

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLMoreInfo(Article article) Constructor.
XMLMoreInfo(Article article, java.lang.String refID, java.lang.String pack) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addInfo(XMLMoreInfoRef ref) Add a child reference.
int	countInfos() Return the number of children references.
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.util.List<XMLMoreInfoRef>	getInfos() Return the children references.
boolean	hasInfos() Return true if there are children references.
boolean	hasUniqueRef() Return true if this is a unique reference.
boolean	isValid() Return true if the moreInfo element is valid.

Methods inherited from class org.docgene.model.AbstractMoreInfoRef

getDescription

Methods inherited from class org.docgene.model.XMLReference

bind, bind, getAnchorElement, getArticleRef, getCustomStyles, getDesc, getInlinedStyle, getLineNumber, getOriginArticle, getReferencedArticle, getRefID, getRefPackage, getStyle, isAutoDesc, isBareReference, isBound, setCustomStyles, setDesc, setInlinedStyle, setLineNumber, setLowerCase, setStyle, 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.StyledElement

hasInlinedStyle, setCustomStyles

Methods inherited from interface org.docgene.model.ElementReference

hasLineNumber

Constructor Detail

XMLMoreInfo

public XMLMoreInfo(Article article)

Constructor.

Parameters:

article - the article which emit the reference

XMLMoreInfo

public XMLMoreInfo(Article article,
                   java.lang.String refID,
                   java.lang.String pack)

Constructor.

Parameters:

article - the article which emit the reference

refID - the other article ID

pack - the package

Method Detail

getDeclaration

public java.lang.String getDeclaration()

Return the declaration ID of the element.

Specified by:

getDeclaration in interface StyledElement

Overrides:

getDeclaration in class XMLReference

Returns:

the declaration ID of the element

addInfo

public void addInfo(XMLMoreInfoRef ref)

Add a child reference.

Parameters:

ref - the reference

hasUniqueRef

public boolean hasUniqueRef()

Return true if this is a unique reference.

Returns:

true if this is a unique reference

isValid

public boolean isValid()

Return true if the moreInfo element is valid.

Returns:

true if the moreInfo element is valid

hasInfos

public boolean hasInfos()

Return true if there are children references.

Returns:

true if there are children references

countInfos

public int countInfos()

Return the number of children references.

Returns:

the number of children references

getInfos

public java.util.List<XMLMoreInfoRef> getInfos()

Return the children references.

Returns:

the children references