org.docgene.model

Class XMLReference

java.lang.Object

org.docgene.model.XMLReference

All Implemented Interfaces:

ArticleReference, ElementReference, ParagraphArticleReference, ParagraphElement, StyledElement

Direct Known Subclasses:

AbstractMoreInfoRef, XMLSeeAlso, XMLSeeAlsoHeading, XMLSeeArticle

public class XMLReference
extends java.lang.Object
implements ParagraphArticleReference, StyledElement

Represent an internal reference (to another article). The reference can link to the article itself, or to a chapter in the article.

Interwiki References IDs

Interwiki references to articles. can be:

• The article ID: see XMLArticle.getID()
• The article description: see XMLArticle.getDescription()
• The article description where the white spaces have been replaced by underscore characters

Additionnaly references to chapters can be:

• The chapter title
• The chapter title where the white spaces have been replaced by undersocre characters

Examples

 <ref id="refID" desc="the description" />
 

This links to the article which ID is "refID".

 <ref id="refID#the chapter" desc="the description" />
 

This links to the article which ID is "refID", and chapter with the title "the chapter".

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	desc The reference desctiption.
protected java.lang.String	id The reference ID.
protected boolean	idMayBeDesc True if the raw ID maybe a description.
protected java.lang.String	rawID The raw article title ID.

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLReference(Article article) Constructor.
XMLReference(Article article, java.lang.String rawID, java.lang.String pack) Constructor.
XMLReference(Article article, java.lang.String rawID, java.lang.String pack, boolean isBareReference) Constructor.
XMLReference(java.lang.String rawID, java.lang.String pack) Constructor without input article.

Method Summary

Modifier and Type	Method and Description
void	bind(XMLParentArticle article) Set the referenced article.
void	bind(XMLParentArticle article, AnchorElement anchor) Set the referenced article and associated chapter or title.
AnchorElement	getAnchorElement() Return the referenced anchor element.
ArticleRef	getArticleRef() Return the associated reference.
java.util.Set<java.lang.String>	getCustomStyles() Return the element custom classes.
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.lang.String	getDesc() Return the reference text.
protected java.lang.String	getDescription(XMLParentArticle article, java.lang.String refID) Return the description associated to an ID and an article.
java.lang.String	getInlinedStyle() Return the element custom inline style.
int	getLineNumber() Return the line where the reference appear.
Article	getOriginArticle() Return the article which emit the reference.
XMLParentArticle	getReferencedArticle() Return the referenced article.
java.lang.String	getRefID() Return the other article reference ID.
java.lang.String	getRefPackage() Return the article reference package.
java.lang.String	getStyle() Return the style class of the element.
boolean	isAutoDesc() Return true if the description has been set automatically.
boolean	isBareReference() Return true for a bare reference pointing directly to a File.
boolean	isBound() Return true if the reference is bound.
void	setCustomStyles(java.util.Set<java.lang.String> classes) Set the element custom classes.
void	setDesc(java.lang.String desc) Set the reference text.
void	setInlinedStyle(java.lang.String style) Set the element custom inline style.
void	setLineNumber(int lineNumber) Set the line number where the reference appear.
void	setLowerCase(boolean lowerCase) Set that the first character of the reference should be kept in lower case.
void	setStyle(java.lang.String style) Set the style class of the reference.
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.StyledElement

hasInlinedStyle, setCustomStyles

Methods inherited from interface org.docgene.model.ElementReference

hasLineNumber

Field Detail

id

protected java.lang.String id

The reference ID.

rawID

protected java.lang.String rawID

The raw article title ID.

idMayBeDesc

protected boolean idMayBeDesc

True if the raw ID maybe a description.

desc

protected java.lang.String desc

The reference desctiption.

Constructor Detail

XMLReference

public XMLReference(Article article)

Constructor.

Parameters:

article - the article which emit the reference

XMLReference

public XMLReference(Article article,
                    java.lang.String rawID,
                    java.lang.String pack,
                    boolean isBareReference)

Constructor.

Parameters:

article - the article which emit the reference

rawID - the raw reference ID

pack - the package

isBareReference - true for a bare reference pointing directly to a File

XMLReference

public XMLReference(Article article,
                    java.lang.String rawID,
                    java.lang.String pack)

Constructor.

Parameters:

article - the article which emit the reference

rawID - the raw reference ID

pack - the package

XMLReference

public XMLReference(java.lang.String rawID,
                    java.lang.String pack)

Constructor without input article.

Parameters:

rawID - the raw reference ID

pack - the 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

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

isAutoDesc

public boolean isAutoDesc()

Return true if the description has been set automatically.

Specified by:

isAutoDesc in interface ArticleReference

Returns:

true if the description has been set automatically

isBareReference

public boolean isBareReference()

Return true for a bare reference pointing directly to a File.

Specified by:

isBareReference in interface ArticleReference

Returns:

true for a bare reference

setStyle

public void setStyle(java.lang.String style)

Set the style class of the reference.

Parameters:

style - the style class

getStyle

public java.lang.String getStyle()

Return the style class of the element.

Specified by:

getStyle in interface StyledElement

Returns:

the style class

setInlinedStyle

public void setInlinedStyle(java.lang.String style)

Set the element custom inline style. It correspond to the html "style" attribute.

Specified by:

setInlinedStyle in interface StyledElement

Parameters:

style - the element custom inline style

getInlinedStyle

public java.lang.String getInlinedStyle()

Return the element custom inline style. It correspond to the html "style" attribute.

Specified by:

getInlinedStyle in interface StyledElement

Returns:

the element custom inline style

setCustomStyles

public void setCustomStyles(java.util.Set<java.lang.String> classes)

Set the element custom classes.

Specified by:

setCustomStyles in interface StyledElement

Parameters:

classes - the custom element classes

getCustomStyles

public java.util.Set<java.lang.String> getCustomStyles()

Return the element custom classes.

Specified by:

getCustomStyles in interface StyledElement

Returns:

the custom classes

setLowerCase

public void setLowerCase(boolean lowerCase)

Set that the first character of the reference should be kept in lower case.

Parameters:

lowerCase - true if the first character of the reference should be kept in lower case

getOriginArticle

public Article 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

isBound

public boolean isBound()

Return true if the reference is bound.

Specified by:

isBound in interface ArticleReference

Returns:

true if the reference is bound

setDesc

public void setDesc(java.lang.String desc)

Set the reference text.

Specified by:

setDesc in interface ArticleReference

Parameters:

desc - the reference text

getRefID

public java.lang.String getRefID()

Return the other article reference ID. It can be:

• 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

getRefPackage

public java.lang.String getRefPackage()

Return the article reference package.

Specified by:

getRefPackage in interface ArticleReference

Returns:

the article reference package

getDescription

protected java.lang.String getDescription(XMLParentArticle article,
                                          java.lang.String refID)

Return the description associated to an ID and an article.

Parameters:

article - the parent article

refID - the ID

Returns:

the description

getDesc

public java.lang.String getDesc()

Return the reference text.

Specified by:

getDesc in interface ArticleReference

Returns:

the reference text

getAnchorElement

public AnchorElement getAnchorElement()

Return the referenced anchor element. May be null.

Specified by:

getAnchorElement in interface ArticleReference

Returns:

the referenced anchor element

getArticleRef

public ArticleRef getArticleRef()

Return the associated reference.

Specified by:

getArticleRef in interface ArticleReference

Returns:

the reference

bind

public void bind(XMLParentArticle article)

Set the referenced article.

Specified by:

bind in interface ArticleReference

Parameters:

article - the referenced article

bind

public void bind(XMLParentArticle article,
                 AnchorElement anchor)

Set the referenced article and associated chapter or title.

Specified by:

bind in interface ArticleReference

Parameters:

article - the referenced article

anchor - the AnchorElement