org.docgene.model

Class XMLArticle

java.lang.Object

org.docgene.model.AbstractXMLParent

org.docgene.model.AbstractXMLParentArticle

org.docgene.model.XMLArticle

All Implemented Interfaces:

java.lang.Comparable<org.docgene.model.Article>, org.docgene.model.Article, org.docgene.model.globals.PackagedElement, org.docgene.model.globals.RootElement, org.docgene.model.globals.XMLRootElement, org.docgene.model.HTMLOutput, XMLParent, XMLParentArticle

Direct Known Subclasses:

XMLIndex

public class XMLArticle
extends org.docgene.model.AbstractXMLParentArticle
implements java.lang.Comparable<org.docgene.model.Article>

Represents an XML article.

Article reference

If no article ID is defined the article description will be used for the ID. If an article ID is defined the article can be both retrieved via its description or its ID.

Examples

 <article id="articleID" desc="article description">
 <par>
 This is a paragraph.
 </par>
 <cat id="category" />
 </article>
 

This article can be referenced by its ID or its description. These references are all valid:

• <ref id="articleID" desc="the description" />
• <ref id="article description" desc="the description" />
• <ref id="article_description" desc="the description" />

 <article desc="article description">
 <par>
 This is a paragraph.
 </par>
 <cat id="category" />
 </article>
 

This article can be referenced by its description only because it has no ID. These two references are valid:

• <ref id="article description" desc="the description" />
• <ref id="article_description" desc="the description" />

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	desc The article description.
protected java.lang.String	id The article ID.

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
XMLArticle(java.lang.String desc, boolean keepCase) Constructor.
XMLArticle(java.lang.String desc, boolean keepCase, boolean isConcurrent) Constructor.
XMLArticle(java.lang.String id, java.lang.String desc, boolean keepCase) Constructor.
XMLArticle(java.lang.String id, java.lang.String desc, boolean keepCase, boolean isConcurrent) 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	addAnchor(org.docgene.model.AnchorElement anchor) Add an Anchor to the article.
void	addCategory(java.lang.String category) Add a category on which this article belongs.
void	addChapter(XMLChapter chapter) Add a chapter to the article.
void	addChapter(XMLChapter chapter, boolean includeInSearch, boolean allowIdenticalTitles) Add a resolved chapter to the article.
void	addComment(XMLComment comment) Add a comment.
void	addInclude(XMLInclude include) Add an included article or template.
void	addInfobox(XMLInfobox infobox) Add an infobox.
void	addMap(XMLMap map) Add a Map.
void	addMessageBox(XMLMessageBox messageBox) Add a message box.
void	addNote(org.docgene.model.NoteContent note) Add a note.
void	addResolvedChapter(XMLChapter chapter, boolean allowIdenticalTitles) Add a resolved chapter to the article.
void	addResolvedTitle(XMLTitle title, boolean allowIdenticalTitles) Add a resolved title to the article.
void	addSeeAlsoReference(XMLSeeAlso ref) Add a SeeAlso reference.
void	addTitle(org.docgene.model.TitledElement title, boolean allowIdenticalTitles) Add a title to the article.
void	addTitle(XMLTitle title, boolean includeInSearch, boolean allowIdenticalTitles) Add a resolved title to the article.
void	addTodo(org.docgene.model.TodoElement todo) Add a todo.
boolean	articleNameAlreadyTaken() Return true if the article name was already taken, and the article was not added in the model.
int	compareTo(org.docgene.model.Article article)
int	countSortableTables() Return the number of sortable tables in the article.
int	countTitles() Return the number of titles and chapters currently defined in the Article.
boolean	equals(java.lang.Object obj)
java.util.Set<java.lang.String>	getAlternateTitles() Return the article alternate titles.
java.util.Map<java.lang.String,org.docgene.model.AlternateTitle>	getAlternateTitlesMap() Return the article alternate titles to the raw titles Map.
org.docgene.model.AnchorElement	getAnchor(java.lang.String id) Return the AnchorElement of a specified id (including the included articles or templates).
java.util.Map<java.lang.String,org.docgene.model.AnchorElement>	getAnchorElements() Return all the anchor elements of the articles sorted by their title.
java.util.Map<java.lang.String,XMLAnchor>	getAnchors() Return all the "anchor" elements of the articles sorted by their title.
XMLArticle	getArticle() Return itself.
ArticleRef	getArticleRef() Return the article ref.
short	getArticleType() Return the article type.
java.util.Set<java.lang.String>	getCategories() Return the categories on which this article belongs.
java.lang.String	getDescription() Return the article description.
java.lang.String	getHeader() Construct the header text for the article.
java.lang.String	getHeader(boolean escaping) Construct the header text for the article.
java.lang.String	getID() Return the article ID.
java.util.List<XMLInclude>	getIncludes() Return the list of included articles or templates.
java.util.List<XMLInfobox>	getInfoboxes() Return the list of infoboxes.
java.io.File	getInputFile() Return the article input XML file.
char	getJustification() Return the justification of the article.
java.io.File	getLinksFromFile() Return the article links from HTML file.
java.util.List<XMLMap>	getMaps() Return the list of maps in the article.
java.util.Collection<XMLMessageBox>	getMessageBoxes() Return the message boxes.
java.lang.String	getMeta() Return the meta description to be used for the article for the dictionnary or categories.
org.docgene.model.NoteContent	getNote(java.lang.String id) Return the note of a specified ID.
java.util.List<org.docgene.model.NoteContent>	getNotes() Return the notes.
java.util.Map<java.lang.String,org.docgene.model.NoteContent>	getNotesByID() Return the notes sorted by their ID.
java.io.File	getOutputFile() Return the article output HTML file.
java.lang.String	getPackage() Return the article package.
XMLParent	getParent() Return null.
java.lang.String	getRelativePath() Return the relative path of the article XML file, from the associated root.
java.util.List<org.docgene.model.ReviewElement>	getReviewElements() Return the review elements.
java.util.Map<java.lang.String,org.docgene.model.TitledElement>	getSearchableTitles() Return the map of Searchable titles.
java.util.List<XMLSeeAlso>	getSeeAlso() Return the list of SeeAlso references.
XMLSeeAlsoHeading	getSeeAlsoHeading() Return the SeeAlso in the heading if its exists.
int	getSuffix() Return the article name suffix (used for articles which have the name of an already existing article).
short	getSyntaxType() Return the article syntax type.
java.util.List<org.docgene.model.TitledElement>	getTitledElementsList() Return the ordered list of titled elements (chapters or titles).
java.util.List<org.docgene.model.TitleOrIncludeElement>	getTitlesOrIncludes() Return the list of titles and XMLInclude elements.
boolean	hasAnchor(java.lang.String id) Return true if the article has an Anchor of a specified title (including the included articles or templates).
boolean	hasAnchorElement(java.lang.String id) Return true if the article has a titled element of a specified ID.
boolean	hasAnchors() Return true if the article has anchors.
int	hashCode()
boolean	hasID() Return true if the article has a separate ID.
boolean	hasImageMaps() Return true if the article has image maps.
boolean	hasIncludes() Return true if the list of included articles or templates is not empty.
boolean	hasInfoboxes() Return true if the article has infoboxes.
boolean	hasMaps() Return true if the article has Maps.
boolean	hasMessageBoxes() Return true if there are message boxes.
boolean	hasNote(java.lang.String id) Return true if there is a note for a specified id.
boolean	hasPackage() Return true if the article has a package.
boolean	hasReviewElements() Return true if there are review elements.
boolean	hasSearchableTitles() Return true if the article has searchable titles.
boolean	hasTitledElementsList() Return true if there is a list of titled elements (chapters or titles).
boolean	hasTitles() Return true if the article has at least one title.
boolean	hasTOC() Return true if the article should have a Table of content (true by default).
void	incrementSortableTables(int inc) Increment the number of sortable tables in the article.
boolean	isDirect() Return true.
boolean	isIndex() Return false.
boolean	isKeepingCase() Return true if the article title should keep the title description case.
boolean	isNotesTwoColumns() Return true if the notes layout is on two columns.
boolean	isTemplate() Return true if this article is a template.
boolean	isTitlesResolved() Return true if the titles has been resolved.
boolean	isXMLArticle() Return true.
void	resolveTitles() Tag the titles as resolved.
void	setArticleNameAlreadyTaken(boolean articleNameAlreadyTaken) Set if the article name was already taken, and the article was not added in the model.
void	setCategories(java.util.Set<java.lang.String> categories) Set the categories on which this article belongs.
void	setDescription(java.lang.String id, java.lang.String desc, boolean keepCase) Set the article description.
void	setHasImageMaps(boolean hasImageMaps) Set if the article has image maps.
void	setID(java.lang.String id) Set the article ID.
void	setInputFile(java.io.File file) Set the article input XML file.
void	setJustification(char justification) Set the justification of the article.
void	setKeepCase(boolean keepCase) Set if the article title should keep the title description case.
void	setLinksFromFile(java.io.File file) Set the article links from XML file.
void	setMeta(java.lang.String meta) Set the meta description to be used for the article for the dictionnary or categories.
void	setNotesTwoColumns(boolean notesTwoColumns) Set if the notes layout is on two columns.
void	setOutputFile(java.io.File file) Set the article output XML file.
void	setPackage(java.lang.String pack) Set the package ID of the article.
void	setRelativePath(java.lang.String path) Set the relative path of the article XML file, from the associated root.
void	setSeeAlsoHeading(XMLSeeAlsoHeading seeAlsoHeading) Set the "seeAlso" element in the heading.
void	setSuffix(int suffix) Set the article name suffix.
void	setSyntaxType(short syntaxType) Set the article syntax type.
void	setTemplate(boolean isTemplate) Set if this article is a template.
void	setTitledElementsList(java.util.List<org.docgene.model.TitledElement> titledEltsList) Set the ordered list of titled elements (chapters or titles).
void	setTOC(boolean hasTOC) Set if the article should have a Table of content.
java.lang.String	toString()

Methods inherited from class org.docgene.model.AbstractXMLParentArticle

addArticleParent, addLinkFromArticle, addReference, addReference, getArticleParents, getCondition, getLinksFrom, getReferences, getRoot, hasCondition, hasImages, isPresent, setCondition, setImages, setLinkFromArticles, setRoot

Methods inherited from class org.docgene.model.AbstractXMLParent

addParagraph, getChapters, getParagraphs, isEmpty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.docgene.model.XMLParentArticle

hasNotes, isGlobalIndex

Methods inherited from interface org.docgene.model.Article

getNormalizedAlternateTitles, getRef, getRootElementType, getTitle, hasAlternateTitles, hasSuffix, isDirectXMLArticle, isRawHTMLArticle, isValid

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

getAbsolutePath, hasInputFile, isParsable

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

hasRoot, isArticle, isFallback, notExistingInputFile

Methods inherited from interface org.docgene.model.XMLParent

addParagraph, getChapters, getParagraphs, isEmpty

Methods inherited from interface org.docgene.model.HTMLOutput

hasOutputFile

Field Detail

id

protected java.lang.String id

The article ID.

desc

protected java.lang.String desc

The article description.

Constructor Detail

XMLArticle

public XMLArticle(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

XMLArticle

public XMLArticle(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

XMLArticle

public XMLArticle(java.lang.String desc,
                  boolean keepCase,
                  boolean isConcurrent)

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

isConcurrent - true for concurrent parsing

XMLArticle

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

Constructor.

Parameters:

id - the article id

desc - the article description

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

isConcurrent - true for a concurrent parsing

Method Detail

setArticleNameAlreadyTaken

public void setArticleNameAlreadyTaken(boolean articleNameAlreadyTaken)

Set if the article name was already taken, and the article was not added in the model.

Specified by:

setArticleNameAlreadyTaken in interface org.docgene.model.Article

Parameters:

articleNameAlreadyTaken - true if the article name was already taken

articleNameAlreadyTaken

public boolean articleNameAlreadyTaken()

Return true if the article name was already taken, and the article was not added in the model.

Specified by:

articleNameAlreadyTaken in interface org.docgene.model.Article

Returns:

true if the article name was already taken

getArticleType

public short getArticleType()

Return the article type.

Specified by:

getArticleType in interface org.docgene.model.Article

Returns:

the article type

isXMLArticle

public boolean isXMLArticle()

Return true.

Specified by:

isXMLArticle in interface XMLParentArticle

Returns:

true

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 org.docgene.model.Article

Returns:

the article name suffix

setSuffix

public void setSuffix(int suffix)

Set the article name suffix.

Specified by:

setSuffix in interface org.docgene.model.Article

Parameters:

suffix - the article name suffix

setID

public void setID(java.lang.String id)

Set the article ID.

Specified by:

setID in interface org.docgene.model.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 org.docgene.model.Article

Parameters:

id - the article id

desc - the article description

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

setSyntaxType

public void setSyntaxType(short syntaxType)

Set the article syntax type.

Parameters:

syntaxType - the article syntax type

See Also:

SyntaxType

getSyntaxType

public short getSyntaxType()

Return the article syntax type. By default the syntax type is the same to the syntax defined for the whole wiki.

Returns:

the article syntax type

See Also:

SyntaxType

setNotesTwoColumns

public void setNotesTwoColumns(boolean notesTwoColumns)

Set if the notes layout is on two columns.

Parameters:

notesTwoColumns - true if the notes layout is on two columns

isNotesTwoColumns

public boolean isNotesTwoColumns()

Return true if the notes layout is on two columns.

Specified by:

isNotesTwoColumns in interface XMLParentArticle

Returns:

true if the notes layout is on two columns

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

countSortableTables

public int countSortableTables()

Return the number of sortable tables in the article.

Specified by:

countSortableTables in interface XMLParentArticle

Returns:

the number of sortable tables

incrementSortableTables

public void incrementSortableTables(int inc)

Increment the number of sortable tables in the article.

Specified by:

incrementSortableTables in interface XMLParentArticle

Parameters:

inc - the increment value

getPackage

public java.lang.String getPackage()

Return the article package.

Specified by:

getPackage in interface org.docgene.model.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

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 org.docgene.model.Article

Returns:

true if the article title should keep the title description case

setTOC

public void setTOC(boolean hasTOC)

Set if the article should have a Table of content.

Parameters:

hasTOC - true if the article should have a Table of content

hasTOC

public boolean hasTOC()

Return true if the article should have a Table of content (true by default).

Specified by:

hasTOC in interface org.docgene.model.Article

Returns:

true if the article should have a Table of content

getHeader

public java.lang.String getHeader(boolean escaping)

Construct the header text for the article.

Specified by:

getHeader in interface org.docgene.model.Article

Parameters:

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

Returns:

the header text for the article

getHeader

public java.lang.String getHeader()

Construct the header text for the article.

Specified by:

getHeader in interface org.docgene.model.Article

Returns:

the header text for the article

hasID

public boolean hasID()

Return true if the article has a separate ID.

Specified by:

hasID in interface org.docgene.model.Article

Returns:

true if the article has a separate ID

addAlternateTitle

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

Add an alternate title to the article.

Specified by:

addAlternateTitle in interface org.docgene.model.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 org.docgene.model.Article

Returns:

the article alternate titles

getAlternateTitlesMap

public java.util.Map<java.lang.String,org.docgene.model.AlternateTitle> getAlternateTitlesMap()

Return the article alternate titles to the raw titles Map. Return an empty Map by default.

Specified by:

getAlternateTitlesMap in interface org.docgene.model.Article

Returns:

the article alternate titles to the raw titles Map

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 org.docgene.model.Article

Returns:

the meta description

setTemplate

public void setTemplate(boolean isTemplate)

Set if this article is a template.

Parameters:

isTemplate - true if this article is a template

isTemplate

public boolean isTemplate()

Return true if this article is a template.

Specified by:

isTemplate in interface org.docgene.model.Article

Returns:

true if this article is a template

isIndex

public boolean isIndex()

Return false.

Specified by:

isIndex in interface org.docgene.model.Article

Returns:

false

getParent

public XMLParent getParent()

Return null.

Specified by:

getParent in interface XMLParent

Returns:

null

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

setRelativePath

public void setRelativePath(java.lang.String path)

Set the relative path of the article XML file, from the associated root.

Parameters:

path - the relative path

getRelativePath

public java.lang.String getRelativePath()

Return the relative path of the article XML file, from the associated root.

Specified by:

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

Returns:

the relative path

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

setOutputFile

public void setOutputFile(java.io.File file)

Set the article output XML file.

Specified by:

setOutputFile in interface XMLParentArticle

Parameters:

file - the article output XML file

getOutputFile

public java.io.File getOutputFile()

Return the article output HTML file.

Specified by:

getOutputFile in interface org.docgene.model.HTMLOutput

Returns:

the article output HTML file

setLinksFromFile

public void setLinksFromFile(java.io.File file)

Set the article links from XML file.

Specified by:

setLinksFromFile in interface XMLParentArticle

Parameters:

file - the article links from XML file

getLinksFromFile

public java.io.File getLinksFromFile()

Return the article links from HTML file.

Specified by:

getLinksFromFile in interface XMLParentArticle

Returns:

the article links from HTML file

getDescription

public java.lang.String getDescription()

Return the article description.

Specified by:

getDescription in interface org.docgene.model.Article

Returns:

the article description

getID

public java.lang.String getID()

Return the article ID.

Specified by:

getID in interface org.docgene.model.Article

Specified by:

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

Returns:

the article ID

getArticleRef

public ArticleRef getArticleRef()

Return the article ref.

Returns:

the article ref

setCategories

public void setCategories(java.util.Set<java.lang.String> categories)

Set the categories on which this article belongs.

Parameters:

categories - the categories on which this article belongs

addCategory

public void addCategory(java.lang.String category)

Add a category on which this article belongs.

Parameters:

category - the category

getCategories

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

Return the categories on which this article belongs.

Specified by:

getCategories in interface org.docgene.model.Article

Returns:

the categories on which this article belongs

addSeeAlsoReference

public void addSeeAlsoReference(XMLSeeAlso ref)

Add a SeeAlso reference.

Parameters:

ref - the SeeAlso reference

setSeeAlsoHeading

public void setSeeAlsoHeading(XMLSeeAlsoHeading seeAlsoHeading)

Set the "seeAlso" element in the heading.

Parameters:

seeAlsoHeading - the "seeAlso" element in the heading

getSeeAlso

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

Return the list of SeeAlso references.

Specified by:

getSeeAlso in interface XMLParentArticle

Returns:

the list of SeeAlso references

getSeeAlsoHeading

public XMLSeeAlsoHeading getSeeAlsoHeading()

Return the SeeAlso in the heading if its exists.

Specified by:

getSeeAlsoHeading in interface XMLParentArticle

Returns:

the SeeAlso in the heading if its exists

setJustification

public void setJustification(char justification)

Set the justification of the article.

Parameters:

justification - the justification

getJustification

public char getJustification()

Return the justification of the article.

Returns:

the justification

addComment

public void addComment(XMLComment comment)

Add a comment.

Parameters:

comment - the comment

addTodo

public void addTodo(org.docgene.model.TodoElement todo)

Add a todo.

Parameters:

todo - the todo

addNote

public void addNote(org.docgene.model.NoteContent note)

Add a note.

Parameters:

note - the note

hasNote

public boolean hasNote(java.lang.String id)

Return true if there is a note for a specified id.

Parameters:

id - the note id

Returns:

true if there is a note for the specified id

getNote

public org.docgene.model.NoteContent getNote(java.lang.String id)

Return the note of a specified ID.

Parameters:

id - the note ID

Returns:

the note

getNotesByID

public java.util.Map<java.lang.String,org.docgene.model.NoteContent> getNotesByID()

Return the notes sorted by their ID.

Returns:

the notes

getNotes

public java.util.List<org.docgene.model.NoteContent> getNotes()

Return the notes.

Specified by:

getNotes in interface org.docgene.model.Article

Specified by:

getNotes in interface XMLParentArticle

Returns:

the notes

getReviewElements

public java.util.List<org.docgene.model.ReviewElement> getReviewElements()

Return the review elements.

Specified by:

getReviewElements in interface XMLParentArticle

Returns:

the review elements

hasReviewElements

public boolean hasReviewElements()

Return true if there are review elements.

Returns:

true if there are review elements

addMessageBox

public void addMessageBox(XMLMessageBox messageBox)

Add a message box.

Parameters:

messageBox - the message box

getMessageBoxes

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

Return the message boxes.

Specified by:

getMessageBoxes in interface XMLParentArticle

Returns:

the message boxes

hasMessageBoxes

public boolean hasMessageBoxes()

Return true if there are message boxes.

Specified by:

hasMessageBoxes in interface XMLParentArticle

Returns:

true if there are message boxes

addInfobox

public void addInfobox(XMLInfobox infobox)

Add an infobox.

Parameters:

infobox - the infobox

getInfoboxes

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

Return the list of infoboxes.

Specified by:

getInfoboxes in interface XMLParentArticle

Returns:

the list infoboxes

hasInfoboxes

public boolean hasInfoboxes()

Return true if the article has infoboxes.

Specified by:

hasInfoboxes in interface XMLParentArticle

Returns:

true if the article has infoboxes

addInclude

public void addInclude(XMLInclude include)

Add an included article or template.

Parameters:

include - the included article or template

getIncludes

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

Return the list of included articles or templates.

Specified by:

getIncludes in interface XMLParentArticle

Returns:

the list of included articles or templates

hasIncludes

public boolean hasIncludes()

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

Specified by:

hasIncludes in interface XMLParentArticle

Returns:

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

addChapter

public void addChapter(XMLChapter chapter)

Add a chapter to the article.

Specified by:

addChapter in interface XMLParent

Overrides:

addChapter in class org.docgene.model.AbstractXMLParent

Parameters:

chapter - the chapter

countTitles

public int countTitles()

Return the number of titles and chapters currently defined in the Article.

Returns:

the number of titles and chapters currently defined in the Article

isDirect

public boolean isDirect()

Return true.

Specified by:

isDirect in interface org.docgene.model.Article

Returns:

true

getArticle

public XMLArticle getArticle()

Return itself.

Specified by:

getArticle in interface org.docgene.model.Article

Returns:

this article

getSearchableTitles

public java.util.Map<java.lang.String,org.docgene.model.TitledElement> getSearchableTitles()

Return the map of Searchable titles. Note that for these titles:

• "Notes" titles are not taken into account
• "SeeAlso" titles are not taken into account
• Duplicate titles are not taken into account

Specified by:

getSearchableTitles in interface XMLParentArticle

Returns:

the map of Searchable titles

hasSearchableTitles

public boolean hasSearchableTitles()

Return true if the article has searchable titles.

Specified by:

hasSearchableTitles in interface org.docgene.model.Article

Returns:

true if the article has searchable titles

hasAnchors

public boolean hasAnchors()

Return true if the article has anchors.

Specified by:

hasAnchors in interface XMLParentArticle

Returns:

true if the article has anchors

addMap

public void addMap(XMLMap map)

Add a Map.

Parameters:

map - the Map

getMaps

public java.util.List<XMLMap> getMaps()

Return the list of maps in the article.

Specified by:

getMaps in interface org.docgene.model.Article

Returns:

the list of maps

hasMaps

public boolean hasMaps()

Return true if the article has Maps.

Specified by:

hasMaps in interface org.docgene.model.Article

Returns:

true if the article has Maps

hasImageMaps

public boolean hasImageMaps()

Return true if the article has image maps.

Specified by:

hasImageMaps in interface org.docgene.model.Article

Returns:

true if the article has image maps

setHasImageMaps

public void setHasImageMaps(boolean hasImageMaps)

Set if the article has image maps.

Parameters:

hasImageMaps - true if the article has image maps

addTitle

public void addTitle(org.docgene.model.TitledElement title,
                     boolean allowIdenticalTitles)

Add a title to the article.

Parameters:

title - the title element

allowIdenticalTitles - true if two titles with the same title are allowed

addResolvedTitle

public void addResolvedTitle(XMLTitle title,
                             boolean allowIdenticalTitles)

Add a resolved title to the article. This title may be directly defined in the article, or it can result from another included article.

Parameters:

title - the title

allowIdenticalTitles - true if two titles with the same title are allowed

addResolvedChapter

public void addResolvedChapter(XMLChapter chapter,
                               boolean allowIdenticalTitles)

Add a resolved chapter to the article. This title may be directly defined in the article, or it can result from another included article.

Parameters:

chapter - the chapter

allowIdenticalTitles - true if two titles with the same title are allowed

addTitle

public void addTitle(XMLTitle title,
                     boolean includeInSearch,
                     boolean allowIdenticalTitles)

Add a resolved title to the article. This title may be directly defined in the article, or it can result from another included article.

Parameters:

title - the title

includeInSearch - true if the title must be included in the Search box

allowIdenticalTitles - true if two titles with the same title are allowed

addChapter

public void addChapter(XMLChapter chapter,
                       boolean includeInSearch,
                       boolean allowIdenticalTitles)

Add a resolved chapter to the article. This title may be directly defined in the article, or it can result from another included article.

Parameters:

chapter - the chapter

includeInSearch - true if the title must be included in the Search box

allowIdenticalTitles - true if two titles with the same title are allowed

hasTitles

public boolean hasTitles()

Return true if the article has at least one title.

Returns:

true if the article has at least one title

addAnchor

public void addAnchor(org.docgene.model.AnchorElement anchor)

Add an Anchor to the article.

Parameters:

anchor - the Anchor

hasAnchorElement

public boolean hasAnchorElement(java.lang.String id)

Return true if the article has a titled element of a specified ID.

Parameters:

id - the titledelement ID

Returns:

true if the article has a titled element of the specified ID

setTitledElementsList

public void setTitledElementsList(java.util.List<org.docgene.model.TitledElement> titledEltsList)

Set the ordered list of titled elements (chapters or titles).

Parameters:

titledEltsList - the ordered list of titled elements (chapters or titles)

getTitledElementsList

public java.util.List<org.docgene.model.TitledElement> getTitledElementsList()

Return the ordered list of titled elements (chapters or titles).

Specified by:

getTitledElementsList in interface XMLParentArticle

Returns:

the ordered list of titled elements

isTitlesResolved

public boolean isTitlesResolved()

Return true if the titles has been resolved. Titles resolution is performed when titles coming from included articles has been takne into account.

Returns:

true if the titles has been resolved

resolveTitles

public void resolveTitles()

Tag the titles as resolved.

getTitlesOrIncludes

public java.util.List<org.docgene.model.TitleOrIncludeElement> getTitlesOrIncludes()

Return the list of titles and XMLInclude elements.

Returns:

the list of titles and XMLInclude elements

hasTitledElementsList

public boolean hasTitledElementsList()

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

Specified by:

hasTitledElementsList in interface XMLParentArticle

Returns:

true if there is a list of titled elements (chapters or titles)

getAnchorElements

public java.util.Map<java.lang.String,org.docgene.model.AnchorElement> getAnchorElements()

Return all the anchor elements of the articles sorted by their title. It contains the xml "anchor" elements, but also the titles.

Specified by:

getAnchorElements in interface XMLParentArticle

Returns:

the anchor elements

getAnchors

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

Return all the "anchor" elements of the articles sorted by their title.

Specified by:

getAnchors in interface XMLParentArticle

Returns:

the "anchor" elements

getAnchor

public org.docgene.model.AnchorElement getAnchor(java.lang.String id)

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

Specified by:

getAnchor in interface XMLParentArticle

Parameters:

id - the anchor ID

Returns:

the AnchorElement

hasAnchor

public boolean hasAnchor(java.lang.String id)

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

Specified by:

hasAnchor in interface XMLParentArticle

Parameters:

id - the anchor ID

Returns:

true if the article has an Anchor of the specified title

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(org.docgene.model.Article article)

Specified by:

compareTo in interface java.lang.Comparable<org.docgene.model.Article>