org.docgene.model

Class AbstractXMLParentArticle

java.lang.Object

org.docgene.model.AbstractXMLParent

org.docgene.model.AbstractXMLParentArticle

All Implemented Interfaces:

Article, org.docgene.model.globals.PackagedElement, org.docgene.model.globals.RootElement, org.docgene.model.globals.XMLRootElement, HTMLOutput, XMLParent, XMLParentArticle

Direct Known Subclasses:

XMLArticle, XMLDisambArticle, XMLFallbackArticle

public abstract class AbstractXMLParentArticle
extends AbstractXMLParent
implements XMLParentArticle

An abstract XMLParent article.

Field Summary

Fields inherited from class org.docgene.model.AbstractXMLParent

chapters, paragraphs

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

Constructor Summary

Constructors

Constructor and Description
AbstractXMLParentArticle()

Method Summary

Modifier and Type	Method and Description
void	addArticleParent(XMLParentArticle article) Add an article which include this article.
void	addLinkFromArticle(XMLParentArticle article) Add an article from which there is a reference to this article.
void	addReference(ArticleRef ref) Add an article reference.
void	addReference(XMLParentArticle article) Add an article reference.
java.util.Map<java.lang.String,XMLParentArticle>	getArticleParents() Return the articles which include this article.
org.docgene.model.conditions.DefaultCondition	getCondition() Return the condition for the article.
java.util.SortedMap<java.lang.String,XMLParentArticle>	getLinksFrom() Return the articles from which there is a reference to this article.
java.util.Set<ArticleRef>	getReferences() Return the references used in the article.
org.docgene.model.globals.RootDirectory	getRoot() Return the root directory.
boolean	hasCondition() Return true if the article has a condition.
boolean	hasImages() Return true if this article has at least one image.
boolean	isPresent() Return true if the article is present.
void	setCondition(org.docgene.model.conditions.DefaultCondition condition) Set the condition for the article.
void	setImages() Set that this article has at least one image.
void	setLinkFromArticles(java.util.SortedMap<java.lang.String,XMLParentArticle> linksFrom) Set the articles from which there is a reference to this article.
void	setRoot(org.docgene.model.globals.RootDirectory root) Set the root directory.

Methods inherited from class org.docgene.model.AbstractXMLParent

addChapter, addParagraph, getChapters, getParagraphs

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.XMLParentArticle

countSortableTables, getAnchor, getAnchorElements, getAnchors, getIncludes, getInfoboxes, getLinksFromFile, getMessageBoxes, getNotes, getReviewElements, getSearchableTitles, getSeeAlso, getSeeAlsoHeading, getTitledElementsList, hasAnchor, hasAnchors, hasIncludes, hasInfoboxes, hasMessageBoxes, hasNotes, hasTitledElementsList, incrementSortableTables, isGlobalIndex, isNotesTwoColumns, isXMLArticle, setLinksFromFile, setOutputFile

Methods inherited from interface org.docgene.model.Article

addAlternateTitle, articleNameAlreadyTaken, getAlternateTitles, getAlternateTitlesMap, getArticle, getArticleType, getCategories, getDescription, getHeader, getHeader, getID, getMaps, getMeta, getNormalizedAlternateTitles, getPackage, getRef, getRootElementType, getSuffix, getTitle, hasAlternateTitles, hasID, hasImageMaps, hasMaps, hasSearchableTitles, hasSuffix, hasTOC, isDirect, isDirectXMLArticle, isIndex, isKeepingCase, isRawHTMLArticle, isTemplate, isValid, setArticleNameAlreadyTaken, setDescription, setID, setSuffix

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

getAbsolutePath, getRelativePath, hasInputFile, hasPackage, isParsable, setInputFile, setPackage

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

getInputFile, hasRoot, isArticle, isFallback, notExistingInputFile

Methods inherited from interface org.docgene.model.XMLParent

addChapter, addParagraph, getChapters, getParagraphs, getParent

Methods inherited from interface org.docgene.model.HTMLOutput

getOutputFile, hasOutputFile

Constructor Detail

AbstractXMLParentArticle

public AbstractXMLParentArticle()

Method Detail

setCondition

public void setCondition(org.docgene.model.conditions.DefaultCondition condition)

Set the condition for the article.

Parameters:

condition - the condition

hasCondition

public boolean hasCondition()

Return true if the article has a condition.

Specified by:

hasCondition in interface Article

Returns:

true if the article has a condition

isPresent

public boolean isPresent()

Return true if the article is present.

Returns:

true if the article is present

getCondition

public org.docgene.model.conditions.DefaultCondition getCondition()

Return the condition for the article.

Returns:

the condition

setImages

public void setImages()

Set that this article has at least one image.

Specified by:

setImages in interface Article

hasImages

public boolean hasImages()

Return true if this article has at least one image.

Specified by:

hasImages in interface Article

Returns:

true if this article has at least one image

addLinkFromArticle

public void addLinkFromArticle(XMLParentArticle article)

Add an article from which there is a reference to this article.

Specified by:

addLinkFromArticle in interface XMLParentArticle

Parameters:

article - the article

setLinkFromArticles

public void setLinkFromArticles(java.util.SortedMap<java.lang.String,XMLParentArticle> linksFrom)

Set the articles from which there is a reference to this article.

Specified by:

setLinkFromArticles in interface XMLParentArticle

Parameters:

linksFrom - the articles from which there is a reference to this article

getLinksFrom

public java.util.SortedMap<java.lang.String,XMLParentArticle> getLinksFrom()

Return the articles from which there is a reference to this article.

Specified by:

getLinksFrom in interface XMLParentArticle

Returns:

the articles from which there is a reference to this article

addArticleParent

public void addArticleParent(XMLParentArticle article)

Add an article which include this article.

Specified by:

addArticleParent in interface XMLParentArticle

Parameters:

article - the article

getArticleParents

public java.util.Map<java.lang.String,XMLParentArticle> getArticleParents()

Return the articles which include this article.

Specified by:

getArticleParents in interface XMLParentArticle

Returns:

the articles which include this article

addReference

public void addReference(ArticleRef ref)

Add an article reference.

Specified by:

addReference in interface Article

Parameters:

ref - the article reference

addReference

public void addReference(XMLParentArticle article)

Add an article reference.

Parameters:

article - the article

getReferences

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

Return the references used in the article.

Specified by:

getReferences in interface Article

Returns:

the references

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