org.docgene.model

Class OpaqueArticle

java.lang.Object

org.docgene.model.OpaqueArticle

All Implemented Interfaces:

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

public class OpaqueArticle
extends java.lang.Object
implements XMLParentArticle, java.lang.Comparable<Article>

An article which is just an opaque reference.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	desc
protected java.lang.String	id
protected java.lang.String	pack

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
OpaqueArticle(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	addArticleParent(XMLParentArticle article) Add an article which include this article.
void	addCategory(java.lang.String category) Add a category on which this article belongs.
void	addChapter(XMLChapter chapter) Add a chapter.
void	addLinkFromArticle(XMLParentArticle article) Add an article from which there is a reference to this article.
void	addParagraph(AbstractParagraph par) Add a paragraph.
int	compareTo(Article article)
boolean	equals(java.lang.Object obj)
OpaqueArticle	getArticle() Return itself.
java.util.Map<java.lang.String,XMLParentArticle>	getArticleParents() Return the articles which include this article.
short	getArticleType() Return the article type.
java.util.Set<java.lang.String>	getCategories() Return the categories on which this article belongs.
java.util.List<XMLChapter>	getChapters() Return the element children chapters.
java.lang.String	getDefaultContent() Return the default content for the opaque article.
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.io.File	getInputFile() Return the article input XML file.
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.
java.lang.String	getMeta() Return the meta description to be used for the article for the dictionnary or categories.
java.io.File	getOutputFile() Return the article output HTML file.
java.lang.String	getPackage() Return the article package.
java.util.List<AbstractParagraph>	getParagraphs() Return the element children paragraphs.
XMLParent	getParent() Return null.
ArticleRef	getRef() Return the article ref.
java.util.Set<ArticleRef>	getReferences() Return the references used in the article.
java.lang.String	getRelativePath() Return the relative path of the article XML file, from the associated root.
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	hasDefaultContent() Return true if there is a default content for the opaque article. if there is a default content and the associated file does not exist, then the article will be created with only the default content.
int	hashCode()
boolean	hasID() Return true if the article has a separate ID.
boolean	hasPackage() Return true if the article has a package.
boolean	hasTOC() Return true if the article should have a Table of content (true by default).
boolean	isDirect() Return true.
boolean	isDirectXMLArticle() Return false.
boolean	isKeepingCase() Return true if the article title should keep the title description case.
void	setCategories(java.util.Set<java.lang.String> categories) Set the categories on which this article belongs.
void	setDefaultContent(java.lang.String defaultContent) Set a default content for the opaque article.
void	setDescription(java.lang.String id, java.lang.String desc, boolean keepCase) Set the article description.
void	setEmptyDefaultContent() Set an empty default content for the opaque article.
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	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	setMeta(java.lang.String meta) Set the meta description to be used for the article for the dictionnary or categories.
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	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, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.docgene.model.XMLParentArticle

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

Methods inherited from interface org.docgene.model.Article

addReference, articleNameAlreadyTaken, getAlternateTitles, getAlternateTitlesMap, getMaps, getNormalizedAlternateTitles, getRootElementType, getTitle, hasAlternateTitles, hasCondition, hasImageMaps, hasImages, hasMaps, hasSearchableTitles, hasSuffix, isIndex, isRawHTMLArticle, isTemplate, isValid, setArticleNameAlreadyTaken, setImages

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

hasOutputFile

Field Detail

pack

protected java.lang.String pack

id

protected java.lang.String id

desc

protected java.lang.String desc

Constructor Detail

OpaqueArticle

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

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

getArticleType

public short getArticleType()

Return the article type.

Specified by:

getArticleType in interface Article

Returns:

the article type

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

setEmptyDefaultContent

public void setEmptyDefaultContent()

Set an empty default content for the opaque article.

setDefaultContent

public void setDefaultContent(java.lang.String defaultContent)

Set a default content for the opaque article.

Parameters:

defaultContent - the default content

getDefaultContent

public java.lang.String getDefaultContent()

Return the default content for the opaque article.

Returns:

the default content

hasDefaultContent

public boolean hasDefaultContent()

Return true if there is a default content for the opaque article. if there is a default content and the associated file does not exist, then the article will be created with only the default content.

Returns:

true if there is the default content for the opaque article

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

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

hasTOC

public boolean hasTOC()

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

Specified by:

hasTOC in interface 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 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 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 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 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

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

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

isDirect

public boolean isDirect()

Return true.

Specified by:

isDirect in interface Article

Returns:

true

isDirectXMLArticle

public boolean isDirectXMLArticle()

Return false.

Specified by:

isDirectXMLArticle in interface Article

Returns:

false

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 HTMLOutput

Returns:

the article output HTML file

setLinksFromFile

public void setLinksFromFile(java.io.File file)

Set the article links from XML file. Do nothing.

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. Return null.

Specified by:

getLinksFromFile in interface XMLParentArticle

Returns:

the article links from HTML file

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

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

getRef

public ArticleRef getRef()

Return the article ref.

Specified by:

getRef in interface Article

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 Article

Returns:

the categories on which this article belongs

getArticle

public OpaqueArticle getArticle()

Return itself.

Specified by:

getArticle in interface Article

Returns:

this article

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(Article article)

Specified by:

compareTo in interface java.lang.Comparable<Article>

addArticleParent

public void addArticleParent(XMLParentArticle article)

Description copied from interface: XMLParentArticle

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()

Description copied from interface: XMLParentArticle

Return the articles which include this article.

Specified by:

getArticleParents in interface XMLParentArticle

Returns:

the articles which include this article

addLinkFromArticle

public void addLinkFromArticle(XMLParentArticle article)

Description copied from interface: XMLParentArticle

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)

Description copied from interface: XMLParentArticle

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()

Description copied from interface: XMLParentArticle

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

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

getChapters

public java.util.List<XMLChapter> getChapters()

Description copied from interface: XMLParent

Return the element children chapters.

Specified by:

getChapters in interface XMLParent

Returns:

the element children chapters

addChapter

public void addChapter(XMLChapter chapter)

Description copied from interface: XMLParent

Add a chapter.

Specified by:

addChapter in interface XMLParent

Parameters:

chapter - the chapter

getParagraphs

public java.util.List<AbstractParagraph> getParagraphs()

Description copied from interface: XMLParent

Return the element children paragraphs.

Specified by:

getParagraphs in interface XMLParent

Returns:

the element children paragraphs

addParagraph

public void addParagraph(AbstractParagraph par)

Description copied from interface: XMLParent

Add a paragraph.

Specified by:

addParagraph in interface XMLParent

Parameters:

par - the paragraph