org.docgene.model

Interface XMLParentArticle

All Superinterfaces:

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

All Known Implementing Classes:

AbstractXMLParentArticle, ArticlesGlossary, OpaqueArticle, XMLArticle, XMLDisambArticle, XMLFallbackArticle, XMLIndex, XMLRawHTMLArticle

public interface XMLParentArticle
extends Article, XMLParent, HTMLOutput

Represents an article which can have children chapters and paragraphs.

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

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.
default int	countSortableTables() Return the number of sortable tables in the article.
default AnchorElement	getAnchor(java.lang.String id) Return the AnchorElement of a specified id (including the included articles or templates).
default java.util.Map<java.lang.String,AnchorElement>	getAnchorElements() Return all the anchor elements of the articles sorted by their title. return null by default.
default java.util.Map<java.lang.String,XMLAnchor>	getAnchors() Return all the "anchor" elements of the articles sorted by their title.
java.util.Map<java.lang.String,XMLParentArticle>	getArticleParents() Return the articles which include this article.
default java.util.List<XMLInclude>	getIncludes() Return the list of included articles or templates.
default java.util.List<XMLInfobox>	getInfoboxes() Return the list of infoboxes.
java.util.SortedMap<java.lang.String,XMLParentArticle>	getLinksFrom() Return the articles from which there is a reference to this article.
java.io.File	getLinksFromFile() Return the article links from HTML file.
default java.util.Collection<XMLMessageBox>	getMessageBoxes() Return the message boxes.
default java.util.List<NoteContent>	getNotes() Return the notes.
default java.util.List<ReviewElement>	getReviewElements() Return the review elements.
default java.util.Map<java.lang.String,TitledElement>	getSearchableTitles() Return the map of Searchable titles.
default java.util.List<XMLSeeAlso>	getSeeAlso() Return the list of SeeAlso references.
default XMLSeeAlsoHeading	getSeeAlsoHeading() Return the SeeAlso in the heading if its exists.
default java.util.List<TitledElement>	getTitledElementsList() Return the ordered list of titled elements (chapters or titles).
default boolean	hasAnchor(java.lang.String id) Return true if the article has an Anchor of a specified title (including the included articles or templates).
default boolean	hasAnchors() Return true if the article has anchors.
default boolean	hasIncludes() Return true if the list of included articles or templates is not empty.
default boolean	hasInfoboxes() Return true if the article has infoboxes.
default boolean	hasMessageBoxes() Return true if there are message boxes.
default boolean	hasNotes() Return true if the article has notes.
default boolean	hasTitledElementsList() Return true if there is a list of titled elements (chapters or titles).
default void	incrementSortableTables(int inc) Increment the number of sortable tables in the article.
default boolean	isGlobalIndex() Return true if the article is the global index.
default boolean	isNotesTwoColumns() Return true if the notes layout is on two columns.
default boolean	isXMLArticle() Return true if this is an XML article.
void	setLinkFromArticles(java.util.SortedMap<java.lang.String,XMLParentArticle> linksFrom) Set the articles from which there is a reference to this article.
void	setLinksFromFile(java.io.File file) Set the article links from XML file.
void	setOutputFile(java.io.File file) Set the article output XML file.

Methods inherited from interface org.docgene.model.Article

addAlternateTitle, addReference, articleNameAlreadyTaken, getAlternateTitles, getAlternateTitlesMap, getArticle, getArticleType, getCategories, getDescription, getHeader, getHeader, getID, getMaps, getMeta, getNormalizedAlternateTitles, getPackage, getRef, getReferences, getRootElementType, getSuffix, getTitle, hasAlternateTitles, hasCondition, hasID, hasImageMaps, hasImages, hasMaps, hasSearchableTitles, hasSuffix, hasTOC, isDirect, isDirectXMLArticle, isIndex, isKeepingCase, isRawHTMLArticle, isTemplate, isValid, setArticleNameAlreadyTaken, setDescription, setID, setImages, setRoot, 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, getRoot, 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

Method Detail

addArticleParent

void addArticleParent(XMLParentArticle article)

Add an article which include this article.

Parameters:

article - the article

getArticleParents

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

Return the articles which include this article.

Returns:

the articles which include this article

addLinkFromArticle

void addLinkFromArticle(XMLParentArticle article)

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

Parameters:

article - the article

setLinkFromArticles

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

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

Parameters:

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

getLinksFrom

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

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

Returns:

the articles from which there is a reference to this article

isXMLArticle

default boolean isXMLArticle()

Return true if this is an XML article. Return false by default.

Returns:

true if this is an XML article

hasAnchors

default boolean hasAnchors()

Return true if the article has anchors. Return false by default.

Returns:

true if the article has anchors

isNotesTwoColumns

default boolean isNotesTwoColumns()

Return true if the notes layout is on two columns. Return false by default.

Returns:

true if the notes layout is on two columns

getAnchors

default java.util.Map<java.lang.String,XMLAnchor> getAnchors()

Return all the "anchor" elements of the articles sorted by their title. Return an empty map by default.

Returns:

the "anchor" elements

getSeeAlsoHeading

default XMLSeeAlsoHeading getSeeAlsoHeading()

Return the SeeAlso in the heading if its exists. Return null by default.

Returns:

the SeeAlso in the heading if its exists

countSortableTables

default int countSortableTables()

Return the number of sortable tables in the article.

Returns:

the number of sortable tables

hasTitledElementsList

default boolean hasTitledElementsList()

Return true if there is a list of titled elements (chapters or titles). Return false by default.

Returns:

false

getSearchableTitles

default java.util.Map<java.lang.String,TitledElement> getSearchableTitles()

Return the map of Searchable titles. Return null by default.

Returns:

the map of Searchable titles

getInfoboxes

default java.util.List<XMLInfobox> getInfoboxes()

Return the list of infoboxes. Return null by default.

Returns:

the list infoboxes

hasInfoboxes

default boolean hasInfoboxes()

Return true if the article has infoboxes. Return false by default.

Returns:

true if the article has infoboxes

getMessageBoxes

default java.util.Collection<XMLMessageBox> getMessageBoxes()

Return the message boxes. Return null by default.

Returns:

the message boxes

hasMessageBoxes

default boolean hasMessageBoxes()

Return true if there are message boxes. Return false by default.

Returns:

true if there are message boxes

getIncludes

default java.util.List<XMLInclude> getIncludes()

Return the list of included articles or templates. Return null by default.

Returns:

the list of included articles or templates

hasIncludes

default boolean hasIncludes()

Return true if the list of included articles or templates is not empty. Return false by default.

Returns:

true if the list of included articles or templates is not empty

getTitledElementsList

default java.util.List<TitledElement> getTitledElementsList()

Return the ordered list of titled elements (chapters or titles). Return an empty list by default.

Returns:

the ordered list of titled elements

getNotes

default java.util.List<NoteContent> getNotes()

Return the notes. Return null by default.

Specified by:

getNotes in interface Article

Returns:

null

getReviewElements

default java.util.List<ReviewElement> getReviewElements()

Return the review elements.

Returns:

null

incrementSortableTables

default void incrementSortableTables(int inc)

Increment the number of sortable tables in the article. Do nothing by default.

Parameters:

inc - the increment value

hasNotes

default boolean hasNotes()

Return true if the article has notes.

Specified by:

hasNotes in interface Article

Returns:

true if the article has notes

getSeeAlso

default java.util.List<XMLSeeAlso> getSeeAlso()

Return the list of SeeAlso references. Return null by default.

Returns:

null

hasAnchor

default boolean hasAnchor(java.lang.String id)

Return true if the article has an Anchor of a specified title (including the included articles or templates). Return false by default.

Parameters:

id - the anchor ID

Returns:

true if the article has an Anchor of the specified title

getAnchorElements

default java.util.Map<java.lang.String,AnchorElement> getAnchorElements()

Return all the anchor elements of the articles sorted by their title. return null by default.

Returns:

the anchor elements

getAnchor

default AnchorElement getAnchor(java.lang.String id)

Return the AnchorElement of a specified id (including the included articles or templates). Return null by default.

Parameters:

id - the anchor ID

Returns:

the AnchorElement

isGlobalIndex

default boolean isGlobalIndex()

Return true if the article is the global index. Return false by default.

Returns:

false

setOutputFile

void setOutputFile(java.io.File file)

Set the article output XML file.

Parameters:

file - the article output XML file

setLinksFromFile

void setLinksFromFile(java.io.File file)

Set the article links from XML file.

Parameters:

file - the article links from XML file

getLinksFromFile

java.io.File getLinksFromFile()

Return the article links from HTML file.

Returns:

the article links from HTML file