org.docgene.model

Class XMLRedirect

java.lang.Object

org.docgene.model.XMLRedirect

All Implemented Interfaces:

Article, ArticleReference, ElementReference, org.docgene.model.globals.PackagedElement, org.docgene.model.globals.RootElement, org.docgene.model.globals.XMLRootElement, ParagraphElement, StyledElement

public class XMLRedirect
extends java.lang.Object
implements Article, ArticleReference

Represents an XML redirect article.

Field Summary

Fields inherited from interface org.docgene.model.Article

INDEX, INDEX_LC, TYPE_ARTICLE, TYPE_DISAMB, TYPE_FALLBACK, TYPE_INDEX, TYPE_RAW_HTML, TYPE_REDIRECT, TYPE_TEMPLATE

Fields inherited from interface org.docgene.model.globals.RootElement

ARTICLE, CATEGORIES, CATEGORY, DICTIONARY, FOOTER, FULL_TEXT_SEARCH, GLOSSARY, HEADER, IMAGE_DEFINITION, IMAGES_DEFINITION, INFOBOX_DEFINITION, INFOBOX_PROPERTY, MENUS, PACKAGE, RESOURCE_DEFINITION, RESOURCES_DEFINITION, UNDEFINED

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLRedirect(java.lang.String desc, boolean keepCase) Constructor.
XMLRedirect(java.lang.String id, java.lang.String desc, boolean keepCase) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	addAlternateTitle(java.lang.String title, boolean keepCase, boolean inDictionnary) Add an alternate title to the article.
void	bind(XMLParentArticle article) Set the referenced article.
void	bind(XMLParentArticle article, AnchorElement anchor) Set the referenced article and associated chapter or title.
java.util.Set<java.lang.String>	getAlternateTitles() Return the article alternate titles.
AnchorElement	getAnchorElement() Return the referenced anchor element.
XMLParentArticle	getArticle() Return the XMLArticle which is really accessed through this Article.
ArticleRef	getArticleRef() Return the associated reference.
short	getArticleType() Return the article type.
java.util.Set<java.lang.String>	getCategories() Return the categories on which this article belongs.
java.lang.String	getDesc() Return the reference text.
java.lang.String	getDescription() Return the article description.
java.lang.String	getHeader(boolean escaping) Construct the header text for the redirect article.
java.lang.String	getID() Return the article ID.
java.io.File	getInputFile() Return the article input XML file.
int	getLineNumber() Return the line where the reference appear.
java.lang.String	getMeta() Return the meta description to be used for the article for the dictionnary or categories.
java.lang.String	getPackage() Return the article package.
XMLParentArticle	getReferencedArticle() Return the XMLArticle which is really accessed through this Article.
java.util.Set<ArticleRef>	getReferences() Return the references used in the article.
java.lang.String	getRefID() Return the referenced article ID.
java.lang.String	getRefPackage() Return the referenced article package.
org.docgene.model.globals.RootDirectory	getRoot() Return the root directory.
int	getSuffix() Return the article name suffix (used for articles which have the name of an already existing article).
boolean	hasAlternateTitles() Return false.
boolean	hasID() Return true if the article has a separate ID.
boolean	hasPackage() Return true if the article has a package.
boolean	isBound() Return true if the reference is bound.
boolean	isKeepingCase() Return true if the article title should keep the title description case.
boolean	isValid() Return true if the redirect is valid.
void	setDescription(java.lang.String id, java.lang.String desc, boolean keepCase) Set the article description.
void	setID(java.lang.String id) Set the article ID.
void	setInputFile(java.io.File file) Set the article input XML file.
void	setKeepCase(boolean keepCase) Set if the article title should keep the title description case.
void	setLineNumber(int lineNumber) Set the line number where the reference appear.
void	setMeta(java.lang.String meta) Set the meta description to be used for the article for the dictionnary or categories.
void	setPackage(java.lang.String pack) Set the package ID of the article.
void	setRefID(java.lang.String refID) Set the referenced article ID.
void	setRoot(org.docgene.model.globals.RootDirectory root) Set the root directory.
void	setSuffix(int suffix) Set the article name suffix.
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.Article

acceptTOCLevel, acceptTOCLevel, addReference, articleNameAlreadyTaken, getAlternateTitlesMap, getHeader, getMaps, getMaximumTOCLevel, getNormalizedAlternateTitles, getNotes, getRef, getRootElementType, getTitle, hasCondition, hasImageMaps, hasImages, hasMaps, hasMaximumTOCLevel, hasNotes, hasSearchableTitles, hasSuffix, hasTOC, isDirect, isDirectXMLArticle, isIndex, isRawHTMLArticle, isTemplate, setArticleNameAlreadyTaken, setImages

Methods inherited from interface org.docgene.model.globals.XMLRootElement

getAbsolutePath, getRelativePath, hasInputFile, isParsable

Methods inherited from interface org.docgene.model.globals.RootElement

hasRoot, isArticle, isFallback, notExistingInputFile

Methods inherited from interface org.docgene.model.ArticleReference

isAutoDesc, isBareReference, setDesc

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

XMLRedirect

public XMLRedirect(java.lang.String desc,
                   boolean keepCase)

Constructor.

Parameters:

desc - the article description. The article getID() will be equal to its description

keepCase - true if the article description should keep the title description case

XMLRedirect

public XMLRedirect(java.lang.String id,
                   java.lang.String desc,
                   boolean keepCase)

Constructor.

Parameters:

id - the article id

desc - the article description

keepCase - true if the article description should keep the title description case

Method Detail

getArticleType

public short getArticleType()

Return the article type.

Specified by:

getArticleType in interface Article

Returns:

the article type

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

getSuffix

public int getSuffix()

Return the article name suffix (used for articles which have the name of an already existing article).

Specified by:

getSuffix in interface Article

Returns:

the article name suffix

setSuffix

public void setSuffix(int suffix)

Set the article name suffix.

Specified by:

setSuffix in interface Article

Parameters:

suffix - the article name suffix

setPackage

public void setPackage(java.lang.String pack)

Set the package ID of the article.

Specified by:

setPackage in interface org.docgene.model.globals.XMLRootElement

Parameters:

pack - the package ID of the article

getPackage

public java.lang.String getPackage()

Return the article package.

Specified by:

getPackage in interface Article

Specified by:

getPackage in interface org.docgene.model.globals.PackagedElement

Specified by:

getPackage in interface org.docgene.model.globals.XMLRootElement

Returns:

the article package

hasPackage

public boolean hasPackage()

Return true if the article has a package.

Specified by:

hasPackage in interface org.docgene.model.globals.PackagedElement

Specified by:

hasPackage in interface org.docgene.model.globals.XMLRootElement

Returns:

true if the article has a package

getRefPackage

public java.lang.String getRefPackage()

Return the referenced article package.

Specified by:

getRefPackage in interface ArticleReference

Returns:

the referenced article package

setKeepCase

public void setKeepCase(boolean keepCase)

Set if the article title should keep the title description case.

Parameters:

keepCase - true if the article title should keep the title description case

isKeepingCase

public boolean isKeepingCase()

Return true if the article title should keep the title description case.

Specified by:

isKeepingCase in interface Article

Returns:

true if the article title should keep the title description case

getHeader

public java.lang.String getHeader(boolean escaping)

Construct the header text for the redirect article.

Specified by:

getHeader in interface Article

Parameters:

escaping - true if the text must be escaped to html content

Returns:

the header text for the redirect article

hasID

public boolean hasID()

Return true if the article has a separate ID.

Specified by:

hasID in interface Article

Returns:

true if the article has a separate ID

hasAlternateTitles

public boolean hasAlternateTitles()

Return false.

Specified by:

hasAlternateTitles in interface Article

Returns:

false.

addAlternateTitle

public boolean addAlternateTitle(java.lang.String title,
                                 boolean keepCase,
                                 boolean inDictionnary)

Add an alternate title to the article.

Specified by:

addAlternateTitle in interface Article

Parameters:

title - the alternate title

keepCase - true if the title description should keep the title description case

inDictionnary - true if the alternate title must be included in the dictionnary and categories

Returns:

true if the alternate title can be added

getAlternateTitles

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

Return the article alternate titles.

Specified by:

getAlternateTitles in interface Article

Returns:

the article alternate titles

setMeta

public void setMeta(java.lang.String meta)

Set the meta description to be used for the article for the dictionnary or categories.

Parameters:

meta - the meta description

getMeta

public java.lang.String getMeta()

Return the meta description to be used for the article for the dictionnary or categories.

Specified by:

getMeta in interface Article

Returns:

the meta description

setInputFile

public void setInputFile(java.io.File file)

Set the article input XML file.

Specified by:

setInputFile in interface org.docgene.model.globals.XMLRootElement

Parameters:

file - the article input XML file

getInputFile

public java.io.File getInputFile()

Return the article input XML file.

Specified by:

getInputFile in interface org.docgene.model.globals.RootElement

Returns:

the article input XML file

setRoot

public void setRoot(org.docgene.model.globals.RootDirectory root)

Set the root directory.

Specified by:

setRoot in interface Article

Parameters:

root - the root

getRoot

public org.docgene.model.globals.RootDirectory getRoot()

Return the root directory.

Specified by:

getRoot in interface org.docgene.model.globals.RootElement

Returns:

the root

getDescription

public java.lang.String getDescription()

Return the article description.

Specified by:

getDescription in interface Article

Returns:

the article description

getID

public java.lang.String getID()

Return the article ID.

Specified by:

getID in interface Article

Specified by:

getID in interface org.docgene.model.globals.RootElement

Returns:

the article ID

setID

public void setID(java.lang.String id)

Set the article ID.

Specified by:

setID in interface Article

Parameters:

id - the article id

setDescription

public void setDescription(java.lang.String id,
                           java.lang.String desc,
                           boolean keepCase)

Set the article description.

Specified by:

setDescription in interface Article

Parameters:

id - the article id

desc - the article description

keepCase - true if the article description should keep the title description case

getDesc

public java.lang.String getDesc()

Return the reference text.

Specified by:

getDesc in interface ArticleReference

Returns:

the reference text

setRefID

public void setRefID(java.lang.String refID)

Set the referenced article ID.

Parameters:

refID - the referenced article ID

getRefID

public java.lang.String getRefID()

Return the referenced article ID.

Specified by:

getRefID in interface ArticleReference

Returns:

the referenced article ID

getAnchorElement

public AnchorElement getAnchorElement()

Return the referenced anchor element. May be null.

Specified by:

getAnchorElement in interface ArticleReference

Returns:

the referenced anchor element

getReferences

public java.util.Set<ArticleRef> getReferences()

Return the references used in the article. Return null.

Specified by:

getReferences in interface Article

Returns:

the references

getCategories

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

Return the categories on which this article belongs.

Specified by:

getCategories in interface Article

Returns:

the categories on which this article belongs

bind

public void bind(XMLParentArticle article)

Set the referenced article.

Specified by:

bind in interface ArticleReference

Parameters:

article - the referenced article

getArticleRef

public ArticleRef getArticleRef()

Return the associated reference.

Specified by:

getArticleRef in interface ArticleReference

Returns:

the reference

isValid

public boolean isValid()

Return true if the redirect is valid.

Specified by:

isValid in interface Article

Returns:

true if the redirect is valid.

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getArticle

public XMLParentArticle getArticle()

Return the XMLArticle which is really accessed through this Article.

Specified by:

getArticle in interface Article

Returns:

the XMLArticle

getReferencedArticle

public XMLParentArticle getReferencedArticle()

Return the XMLArticle which is really accessed through this Article.

Specified by:

getReferencedArticle in interface ArticleReference

Returns:

the XMLArticle

isBound

public boolean isBound()

Return true if the reference is bound.

Specified by:

isBound in interface ArticleReference

Returns:

true if the reference is bound