org.docgene.model

Class XMLRawHTMLArticle

java.lang.Object

org.docgene.model.XMLRawHTMLArticle

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

public class XMLRawHTMLArticle
extends java.lang.Object
implements XMLParentArticle, java.lang.Comparable<org.docgene.model.Article>

The element for a raw html 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

Constructor Summary

Constructors

Constructor and Description
XMLRawHTMLArticle(java.lang.String id, java.lang.String desc, boolean keepCase)
XMLRawHTMLArticle(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	addArticleParent(XMLParentArticle article) Add an article which include this article.
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(org.docgene.model.AbstractParagraph par) Add a paragraph.
void	addTitle(XMLTitle title) Add a resolved title to the article.
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)
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.
XMLRawHTMLArticle	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	getDescription() Return the article description.
org.jsoup.nodes.Document	getDocument() Return the document.
java.io.File	getFrameFile() Return the article frame HTML file.
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<org.docgene.model.AbstractParagraph>	getParagraphs() Return the element children paragraphs.
XMLParent	getParent() Return the element parent.
java.io.File	getRawHTMLFile() Return the article raw HTML file.
java.util.Set<ArticleRef>	getReferences() Return the references used in the article.
org.docgene.model.globals.RootDirectory	getRoot() Return the root directory.
java.util.Map<java.lang.String,org.docgene.model.TitledElement>	getSearchableTitles() Return the map of Searchable titles.
java.net.URL	getURL() Return the URL.
boolean	hasID() Return true if the article has a separate ID.
boolean	hasPackage() Return true if the article has a package.
boolean	hasSearchableTitles() Return true if the article has searchable titles.
boolean	isDirect() Return true.
boolean	isInFrame() Return true if the article content is in a frame.
boolean	isKeepingCase() Return true if the article title should keep the title description case.
boolean	isRawHTMLArticle() Return true.
boolean	isRemovingH1Titles() Return true if H1 titles must be skipped.
boolean	isRemovingNav() Return true if if the article nav content must be removed.
boolean	isValid() Return true if the article is valid.
void	removeH1Titles(boolean removeH1Titles) Set if H1 titles must be skipped.
void	removeNav(boolean removeNav) Set if the article nav content must be removed.
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	setDocument(org.jsoup.nodes.Document doc) Set the document.
void	setID(java.lang.String id) Set the article ID.
void	setInFrame(boolean inFrame) Set if the article content is in a frame.
void	setInputFile(java.io.File file) Set the article input XML file.
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	setOutputFile(java.io.File file, java.io.File frameFile) Set the article output XML file.
void	setPackage(java.lang.String pack) Set the package ID of the article.
void	setRoot(org.docgene.model.globals.RootDirectory root) Set the root directory.
void	setURL(java.net.URL url) Set the URL.

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, getMessageBoxes, getNotes, getReviewElements, getSeeAlso, getSeeAlsoHeading, getTitledElementsList, hasAnchor, hasAnchors, hasIncludes, hasInfoboxes, hasMessageBoxes, hasNotes, hasTitledElementsList, incrementSortableTables, isGlobalIndex, isNotesTwoColumns, isXMLArticle

Methods inherited from interface org.docgene.model.Article

addReference, getMaps, getNormalizedAlternateTitles, getRef, getRootElementType, getSuffix, getTitle, hasAlternateTitles, hasCondition, hasImageMaps, hasImages, hasMaps, hasSuffix, hasTOC, isDirectXMLArticle, isIndex, isTemplate, setImages, setSuffix

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

isEmpty

Methods inherited from interface org.docgene.model.HTMLOutput

hasOutputFile

Constructor Detail

XMLRawHTMLArticle

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

XMLRawHTMLArticle

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

Constructor.

Parameters:

id - the article id

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

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

setDocument

public void setDocument(org.jsoup.nodes.Document doc)

Set the document.

Parameters:

doc - the document

getDocument

public org.jsoup.nodes.Document getDocument()

Return the document.

Returns:

the document

isValid

public boolean isValid()

Return true if the article is valid. In this case it means that the associated URL was found and was a valid html document.

Specified by:

isValid in interface org.docgene.model.Article

Returns:

true if the article is valid.

isDirect

public boolean isDirect()

Return true.

Specified by:

isDirect in interface org.docgene.model.Article

Returns:

true

isRawHTMLArticle

public boolean isRawHTMLArticle()

Return true.

Specified by:

isRawHTMLArticle in interface org.docgene.model.Article

Returns:

true

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

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

setInFrame

public void setInFrame(boolean inFrame)

Set if the article content is in a frame.

Parameters:

inFrame - true if the article content is in a frame

isInFrame

public boolean isInFrame()

Return true if the article content is in a frame.

Returns:

true if the article content is in a frame

removeNav

public void removeNav(boolean removeNav)

Set if the article nav content must be removed.

Parameters:

removeNav - true if the article nav content must be removed

isRemovingNav

public boolean isRemovingNav()

Return true if if the article nav content must be removed.

Returns:

true if the article nav content must be removed

removeH1Titles

public void removeH1Titles(boolean removeH1Titles)

Set if H1 titles must be skipped.

Parameters:

removeH1Titles - true if H1 titles must be skipped

isRemovingH1Titles

public boolean isRemovingH1Titles()

Return true if H1 titles must be skipped.

Returns:

true if H1 titles must be skipped

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

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

setURL

public void setURL(java.net.URL url)

Set the URL.

Parameters:

url - the URL

getURL

public java.net.URL getURL()

Return the URL.

Returns:

the URL

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

getArticle

public XMLRawHTMLArticle getArticle()

Return itself.

Specified by:

getArticle in interface org.docgene.model.Article

Returns:

this article

addTitle

public void addTitle(XMLTitle title)

Add a resolved title to the article.

Parameters:

title - the title

getSearchableTitles

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

Return the map of Searchable titles.

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

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 final 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

getDescription

public java.lang.String getDescription()

Return the article description.

Specified by:

getDescription in interface org.docgene.model.Article

Returns:

the article description

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

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

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

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

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

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

setRoot

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

Set the root directory.

Specified by:

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

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

Returns:

the references

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

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

setOutputFile

public void setOutputFile(java.io.File file,
                          java.io.File frameFile)

Set the article output XML file.

Parameters:

file - the article output XML file

frameFile - the frame 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

getFrameFile

public java.io.File getFrameFile()

Return the article frame HTML file.

Returns:

the article frame HTML file

getRawHTMLFile

public java.io.File getRawHTMLFile()

Return the article raw HTML file.

Returns:

the article raw HTML file

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

getParent

public XMLParent getParent()

Description copied from interface: XMLParent

Return the element parent.

Specified by:

getParent in interface XMLParent

Returns:

the element parent

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<org.docgene.model.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(org.docgene.model.AbstractParagraph par)

Description copied from interface: XMLParent

Add a paragraph.

Specified by:

addParagraph in interface XMLParent

Parameters:

par - the paragraph

compareTo

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

Specified by:

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