ArticlesModel (DocJGenerator API)

java.lang.Object
- org.docgene.model.globals.ArticlesModel

public class ArticlesModel
extends java.lang.Object

Represents the root for the model.

Constructor Summary

Constructors
Constructor and Description
`ArticlesModel()` Constructor.
`ArticlesModel(boolean isConcurrent)` Constructor.
`ArticlesModel(boolean isConcurrent, boolean storeResources)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`short`	`acceptDependency(java.lang.String origPack, java.lang.String destPack)` Return true if dependencies betwen two packages are accepted.
`Article`	`addArticle(Article article, java.lang.String pack)` Add an article.
`Article`	`addArticle(Article article, java.lang.String pack, boolean checkName, boolean resolve)` Add an article.
`Article`	`addArticleToDictionnary(Article article)` Add an article to the dictionnary and categories.
`Article`	`addArticleToDictionnary(java.lang.String title, Article article)` Add an article to the dictionnary.
`void`	`addCategoriesFile(org.docgene.model.unparsable.CategoriesFile catFile)` Add one categories File.
`void`	`addCategory(ArticleCategory cat)` Add a category to the model.
`void`	`addComment(XMLArticle article, XMLComment comment)` Add a comment to the comment list.
`void`	`addDirectResource(XMLResource resource)` Add a resource directy specified in a "doc-files" directory.
`void`	`addDisambArticle(XMLDisambArticle article)` Add a disambiguation article.
`void`	`addElementDefinitionFile(org.docgene.model.unparsable.ElementDefinitionsFile eltFile)` Add one elements definition File.
`void`	`addImage(org.docgene.model.globals.ImageDefinition image)` Add an image resource.
`void`	`addImageFromHRef()` Add an image from a path on the model.
`void`	`addInfobox(org.docgene.model.globals.InfoboxDefinition infobox)` Add an infobox definition.
`void`	`addLinksFrom()` Set if the articles must have a "What Links Here" link.
`org.docgene.model.globals.PackageModel`	`addPackage(org.docgene.model.globals.PackageModel packModel)` Add a package.
`org.docgene.model.globals.PackageModel`	`addPackage(org.docgene.model.globals.RootDirectory root, java.lang.String pack)` Add a package.
`void`	`addParsedArticle(Article article)` Add a parsed article.
`void`	`addReferenceToDisambArticle(ArticleRef articleRef, XMLDisambArticle article)` Add an article reference to the associated disambiguation article.
`void`	`addResource(org.docgene.model.globals.ResourceDefinition resource)` Add a resource.
`org.docgene.model.globals.RootDirectory`	`addRoot(java.io.File rootDir)` Add a root directory.
`void`	`addTodo(XMLArticle article, TodoElement todo)` Add a TODO to the TODO list.
`void`	`addUnparsableArticle(org.docgene.model.unparsable.UnparsableArticle article, java.lang.String pack)` Add an unparsable article.
`void`	`addUnparsableFile(org.docgene.model.unparsable.UnparsableUndefinedFile unparsableFile)` Add one unparsable file.
`void`	`allowIdenticalTitleIDs(boolean value)` Set if if the parser accept identical title IDs(default is true).
`int`	`countArticles()` Return the count of all articles, excluding the `XMLRedirect` and template articles.
`void`	`forceAbsoluteLinks(boolean value)` Set if relative links to files on the file system outside of the wiki will be converted to absolute links (default is false).
`java.util.List<Article>`	`getAllArticles()` Return all the articles including those from the packages.
`java.util.List<org.docgene.model.globals.ImageDefinition>`	`getAllImages()` Return all the images including those from the packages.
`java.util.List<org.docgene.model.globals.InfoboxDefinition>`	`getAllInfoboxes()` Return all the infobox definitions including those from the packages.
`java.util.List<org.docgene.model.globals.ResourceDefinition>`	`getAllResources()` Return all the resources including those from the packages.
`XMLParentArticle`	`getArticle(ArticleRef articleRef)` Return an article specified by its reference.
`Article`	`getArticle(java.io.File file)` Return the article coresponding to a specified input file.
`XMLParentArticle`	`getArticle(java.lang.String refID)` Return an article specified by its reference.
`XMLParentArticle`	`getArticle(java.lang.String refID, java.lang.String pack)` Return an article specified by its reference.
`XMLParentArticle`	`getArticle(java.lang.String refID, java.lang.String origPack, java.lang.String pack)` Return an article specified by its reference.
`java.util.Map<java.lang.String,Article>`	`getArticles()` Return the articles without packages.
`java.util.Map<java.io.File,Article>`	`getArticlesForFiles()` Return the map from input file to article.
`java.util.Iterator<Article>`	`getArticlesIterator()` Return an iterator on all the articles, including packages.
`java.util.Map<java.lang.String,java.util.List<Article>>`	`getArticlesMap()` Return the Map of articles for each name, for all packages.
`java.util.Map<ArticleRef,Article>`	`getArticlesMapByRef()` Return the Map of articles for each article reference, for all packages.
`java.util.Map<java.lang.String,Article>`	`getArticlesPerAllNames()` Return the articles without packages.
`ArticlesCategories`	`getCategories()` Return the categories.
`java.util.Map<java.io.File,org.docgene.model.unparsable.CategoriesFile>`	`getCategoriesFiles()` Return the categories Files.
`ArticleCategory`	`getCategory(java.lang.String catID)` Return the category with a specified ID.
`XMLCommentList`	`getCommentList()` Return the comment list.
`ArticleCategory`	`getDefaultCategory()` The default category is the category of articles which belong to no category.
`ArticlesDictionary`	`getDictionary()` Return the articles glossary.
`org.docgene.model.unparsable.DictionaryFile`	`getDictionaryFile()` Return the dictionary File.
`XMLDisambArticle`	`getDisambArticle(ArticleRef ref)` Return the disambiguation article corresponding to an article reference.
`XMLDisambArticle`	`getDisambArticle(java.lang.String desc)` Return the disambiguation article for a specified description.
`java.util.Map<java.lang.String,XMLDisambArticle>`	`getDisambArticles()` Add the Map of disambiguation articles.
`java.util.Map<java.io.File,org.docgene.model.unparsable.ElementDefinitionsFile>`	`getElementDefinitionFiles()` Return the elements definition Files.
`XMLFallbackArticle`	`getFallbackArticle(char type)` Return a fallback article.
`XMLParentArticle`	`getFirstArticle(java.lang.String refID)` Return the first article specified by its reference, regardless of the package in which the article is defined.
`XMLParentArticle`	`getFirstArticle(java.lang.String refID, boolean includePackages)` Return the first article specified by its reference, regardless of the package in which the article is defined.
`XMLFooter`	`getFooter()` Return the articles footer.
`org.docgene.model.globals.FullTextSearch`	`getFullTextSearch()` Return the articles full text search.
`ArticlesGlossary`	`getGlossary()` Return the articles glossary.
`XMLHeader`	`getHeader()` Return the articles header.
`org.docgene.model.globals.ImageDefinition`	`getImage(java.lang.String id)` Return the image of a specified id.
`org.docgene.model.globals.ImageDefinition`	`getImage(java.lang.String id, java.lang.String origPack, java.lang.String pack)` Return the image of a specified id and package.
`org.docgene.model.globals.ImageDefinition`	`getImageForAllPackages(java.lang.String id)` Return the image of a specified id (for all packages).
`java.util.Map<java.lang.String,org.docgene.model.globals.ImageDefinition>`	`getImages()` Return the image resources.
`XMLIndex`	`getIndex()` Return the index article.
`org.docgene.model.globals.InfoboxDefinition`	`getInfobox(java.lang.String id)` Return the infobox definition of a specified id and package.
`org.docgene.model.globals.InfoboxDefinition`	`getInfobox(java.lang.String id, java.lang.String origPack, java.lang.String pack)` Return the infobox definition of a specified id and package.
`java.util.Map<java.lang.String,org.docgene.model.globals.InfoboxDefinition>`	`getInfoboxes()` Return the infobox definitions.
`org.docgene.model.globals.ArticlesMenus`	`getMenus()` Return the articles menus.
`java.lang.String`	`getNonExistingDesc(Article article)` Return a description which is not used for an article.
`org.docgene.model.globals.PackageModel`	`getPackage(java.lang.String pack)` Return the package of a specified name.
`java.util.Map<java.lang.String,org.docgene.model.globals.PackageModel>`	`getPackages()` Return the packages.
`org.docgene.model.globals.PackagesDependencies`	`getPackagesDependencies()` Return the Packages Dependencies.
`org.docgene.model.globals.PageRanks`	`getPageRanks()` Return the computed PageRanks.
`java.util.Collection<Article>`	`getParsedArticles()` Return the parsed articles.
`java.util.List<Article>`	`getRankedArticles()` Return all the articles including those from the packages, possibly takning the page ranks into accounts.
`java.util.Map<ArticleRef,XMLDisambArticle>`	`getReferenceToDisambArticles()` Return the map from article reference to the associated disambiguation article.
`org.docgene.model.globals.ResourceDefinition`	`getResource(java.lang.String id, java.lang.String origPack, java.lang.String pack)` Return the resource of a specified id and package.
`java.util.Map<java.lang.String,org.docgene.model.globals.ResourceDefinition>`	`getResources()` Return the resources.
`java.io.File`	`getStyleSheet()` Return the output StyleSheet file.
`java.io.File`	`getStyleSheetTheme()` Return the output StyleSheet theme file..
`XMLTodoList`	`getTodoList()` Return the TODO list.
`XMLParentArticle`	`getTransitiveArticle(java.lang.String refID, java.lang.String origPack, java.lang.String pack)` Return the concrete article for a specified id and package.
`java.util.Map<java.io.File,org.docgene.model.unparsable.UnparsableUndefinedFile>`	`getUnparsableFiles()` Return the unparsable files.
`org.docgene.model.incremental.IncrementalGenerationState`	`getWikiState()` Return the object which hold the current state of the wiki
`boolean`	`hasArticle(java.lang.String refID)` Return true if the model contains an article with no package which can be reached through a specified reference.
`boolean`	`hasArticle(java.lang.String refID, java.lang.String origPack, java.lang.String pack)` Return true if the model contains an article which can be reached through a specified reference.
`boolean`	`hasArticleFromAnyPackage(java.lang.String refID)` Return true if the model contains an article with no package which can be reached through a specified reference, from any package.
`boolean`	`hasCategory(java.lang.String catID)` Return true if the model has a category with a specified ID.
`boolean`	`hasComments()` Return true if there are comments.
`boolean`	`hasCustomGlossaryMenuItem(boolean isIndex)` Return true if there is a custom glossary menu item.
`boolean`	`hasDictionaryFile()` Return true if there is a dictionary File.
`boolean`	`hasDisambArticle(ArticleRef ref)` Return true if there is a disambiguation article corresponding to an article reference.
`boolean`	`hasDisambArticle(java.lang.String desc)` Return true if the model has a disambiguation article for a specified description.
`boolean`	`hasFallbackArticle(char type)` Return a fallback article.
`boolean`	`hasFullTextSearch()` Return true if the model has full text Search.
`boolean`	`hasGenerationByDelta()` Return the generation mode.
`boolean`	`hasGlobalIndex()` Return true if there is a global index.
`boolean`	`hasGlossary()` Return true if the articles have a glossary.
`boolean`	`hasImage(java.lang.String id)` Return true if the model has an image with no package of a specified ID.
`boolean`	`hasImage(java.lang.String id, java.lang.String origPack, java.lang.String pack)` Return true if the model has an image for a specified id and package.
`boolean`	`hasImageForAllPackages(java.lang.String id)` Return true if the model has an image for a specified id (for all packages).
`boolean`	`hasImages()` Return true if the model has images.
`boolean`	`hasIndex()` Return true if the model has already an index article.
`boolean`	`hasInfobox(java.lang.String id)` Return true if there is an infobox definition of a specified ID.
`boolean`	`hasInfobox(java.lang.String id, java.lang.String origPack, java.lang.String pack)` Return true if the model has an infobox definition for a specified id and package.
`boolean`	`hasLinksFrom()` Return true if the articles must have a "What Links Here" link.
`boolean`	`hasPackage(java.lang.String pack)` Return true if a package exists.
`boolean`	`hasPackages()` Return true if there are packages.
`boolean`	`hasPageRanks()` Return true if there are computed PageRanks.
`boolean`	`hasRawArticles()` Return true if this model has at least one raw HTML file.
`boolean`	`hasResource(java.lang.String id)` Return true if the model has a resource with no package of a specified ID.
`boolean`	`hasResource(java.lang.String id, java.lang.String origPack, java.lang.String pack)` Return true if the model has a resource for a specified id and package.
`boolean`	`hasTitles()` Return true if at least one article has a searchable title.
`boolean`	`hasTransitiveArticle(java.lang.String refID, java.lang.String origPack, java.lang.String pack)` Return true if the model has a concrete article for a specified id and package.
`boolean`	`hasTransitiveArticle(java.lang.String refID, java.lang.String origPack, java.lang.String pack, boolean acceptInclude)` Return true if the model has a concrete article for a specified id and package.
`boolean`	`isAllowingIdenticalTitleIDs()` Return true if if the parser accept identical title IDs (default is true).
`boolean`	`isConcurrent()` Return true for concurrent parsing.
`boolean`	`isForcingAbsoluteLinks()` Return if relative links to files on the file system outside of the wiki will be converted to absolute links (default is false).
`boolean`	`isIncludingElement(org.docgene.model.globals.PackagedElement element)` Return true if an element must be included in the wiki output.
`boolean`	`isIncludingPackage(java.lang.String pack)` Return true if a package must be included in the wiki output.
`boolean`	`isStoringResources()` Return true if resources must be stored.
`boolean`	`isSupportingThemes()` Return true if the model writer support themes.
`boolean`	`isWritingAnyScripts()` Return true if allowing to write any scripts.
`boolean`	`isWritingArticlesHeaderFrame()` Return true if articles header frame must be written (default is true).
`boolean`	`isWritingArticlesTOC()` Return true if articles Table of content must be written (default is true)
`boolean`	`isWritingResources()` Return true if allowing to write resources files.
`boolean`	`isWritingScripts()` Return true if allowing to write scripts.
`boolean`	`isWritingSeeAlso()` Return true if allowing to write the seeAlso elements(default is true).
`boolean`	`isWritingSubDirectories()` Return true if allowing to write articles, resources and images in sub-directories (default is true).
`protected void`	`refreshCategories(Article article, boolean resolve)` Integrate the categories of an article in the list of categories.
`boolean`	`removeArticle(Article article)` Remove an article.
`void`	`removeCategoriesFile(org.docgene.model.unparsable.CategoriesFile catFile)` Remove one categories File.
`void`	`removeElementDefinitionFile(org.docgene.model.unparsable.ElementDefinitionsFile eltFile)` Remove one elements definition File.
`boolean`	`removeImage(org.docgene.model.globals.ImageDefinition image)` Removes an image.
`boolean`	`removeInfobox(org.docgene.model.globals.InfoboxDefinition infobox)` Removes an infobox definition.
`boolean`	`removeResource(org.docgene.model.globals.ResourceDefinition resource)` Removes a resource.
`void`	`renameArticle(Article article, XMLDisambArticle disamb, java.lang.String newDesc)` Rename an article, making sure it will not use an existing name.
`void`	`replaceArticle(Article article)` Replace an article by anotehr version.
`void`	`setDictionaryFile(org.docgene.model.unparsable.DictionaryFile dictionaryFile)`
`void`	`setFallbackArticle(XMLFallbackArticle fallbackArticle)` Set a fallback article.
`void`	`setFooter(XMLFooter footer)` Set the articles footer.
`void`	`setFulltextSearch(org.docgene.model.globals.FullTextSearch fullTextSearch)` Set the full text search manager.
`void`	`setGlossary(ArticlesGlossary glossary)` Set the articles glossary.
`void`	`setHasTitles()` Set that the model has titles.
`void`	`setHeader(XMLHeader header)` Set the articles header.
`void`	`setIndex(XMLIndex article, java.lang.String pack)` Set the model index.
`void`	`setIndex(XMLIndex article, java.lang.String pack, boolean isGlobalIndex)` Set the model index.
`void`	`setPackagesDependencies(org.docgene.model.globals.PackagesDependencies dependencies)` Set the Packages Dependencies.
`void`	`setPageRanks(org.docgene.model.globals.PageRanks pageRanks)` Set the computed PageRanks.
`void`	`setStyleSheet(java.io.File styleSheet)` Set the output StyleSheet file.
`void`	`setStyleSheetTheme(java.io.File styleSheetTheme)` Set the StyleSheet theme file.
`void`	`setupElementDefinitions()` Setup element definitions to be sure that we don't have more than once the same path name.
`void`	`setWikiState(org.docgene.model.incremental.IncrementalGenerationState wikiState)` Set the object which hold the current state of the wiki
`boolean`	`showElementErrors(org.docgene.model.globals.PackagedElement element)` Return true if errors on an element must be emitted.
`boolean`	`showPackageErrors(java.lang.String pack)` Return true if a package must be included in the wiki output.
`boolean`	`showUnresolvedImages(java.lang.String origPack, java.lang.String destPack)` Return true if unresolved images between between two packages must emit an error.
`boolean`	`showUnresolvedInfoboxes(java.lang.String origPack, java.lang.String destPack)` Return true if unresolved infoboxes between between two packages must emit an error.
`boolean`	`showUnresolvedReferences(java.lang.String origPack, java.lang.String destPack)` Return true if unresolved references between between two packages must emit an error.
`void`	`supportThemes(boolean supportThemes)` Set if the model writer support themes.
`void`	`writeAnyScripts(boolean isWriting)` Set if allowing to write any scripts (default is true).
`void`	`writeArticlesHeaderFrame(boolean value)` Set if articles header frame must be written (default is true).
`void`	`writeArticlesTOC(boolean value)` Set if articles Table of content must be written (default is true).
`void`	`writeResources(boolean value)` Set if allowing to write resources files (default is true).
`void`	`writeScripts(boolean isWriting)` Set if allowing to write scripts (default is true).
`void`	`writeSeeAlso(boolean value)` Set if allowing to write the seeAlso elements (default is true).
`void`	`writeSubDirectories(boolean value)` Set if allowing to write articles, resources and images in sub-directories (default is true).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ArticlesModel
```
public ArticlesModel()
```
    Constructor.
  - ArticlesModel
```
public ArticlesModel(boolean isConcurrent)
```
    Constructor.
    
    Parameters:
    
    isConcurrent - true for concurrent parsing
  - ArticlesModel
```
public ArticlesModel(boolean isConcurrent,
                     boolean storeResources)
```
    Constructor.
    
    Parameters:
    
    isConcurrent - true for concurrent parsing
    
    storeResources - true if resources should be stored in the model (this concerns images and resources definition files)
- Method Detail
  - isConcurrent
```
public boolean isConcurrent()
```
    Return true for concurrent parsing.
    
    Returns:
    
    true for concurrent parsing
  - addElementDefinitionFile
```
public void addElementDefinitionFile(org.docgene.model.unparsable.ElementDefinitionsFile eltFile)
```
    Add one elements definition File.
    
    Parameters:
    
    eltFile - the XML elements definition File
  - getElementDefinitionFiles
```
public java.util.Map<java.io.File,org.docgene.model.unparsable.ElementDefinitionsFile> getElementDefinitionFiles()
```
    Return the elements definition Files.
    
    Returns:
    
    the elements definition Files
  - removeElementDefinitionFile
```
public void removeElementDefinitionFile(org.docgene.model.unparsable.ElementDefinitionsFile eltFile)
```
    Remove one elements definition File.
    
    Parameters:
    
    eltFile - the XML elements definition File
  - addCategoriesFile
```
public void addCategoriesFile(org.docgene.model.unparsable.CategoriesFile catFile)
```
    Add one categories File.
    
    Parameters:
    
    catFile - the XML categories File
  - getCategoriesFiles
```
public java.util.Map<java.io.File,org.docgene.model.unparsable.CategoriesFile> getCategoriesFiles()
```
    Return the categories Files.
    
    Returns:
    
    the categories Files
  - removeCategoriesFile
```
public void removeCategoriesFile(org.docgene.model.unparsable.CategoriesFile catFile)
```
    Remove one categories File.
    
    Parameters:
    
    catFile - the categories File
  - setDictionaryFile
```
public void setDictionaryFile(org.docgene.model.unparsable.DictionaryFile dictionaryFile)
```
  - getDictionaryFile
```
public org.docgene.model.unparsable.DictionaryFile getDictionaryFile()
```
    Return the dictionary File.
    
    Returns:
    
    the dictionary File
  - hasDictionaryFile
```
public boolean hasDictionaryFile()
```
    Return true if there is a dictionary File.
    
    Returns:
    
    true if there is a dictionary File
  - addUnparsableFile
```
public void addUnparsableFile(org.docgene.model.unparsable.UnparsableUndefinedFile unparsableFile)
```
    Add one unparsable file.
    
    Parameters:
    
    unparsableFile - the unparsable file
  - getUnparsableFiles
```
public java.util.Map<java.io.File,org.docgene.model.unparsable.UnparsableUndefinedFile> getUnparsableFiles()
```
    Return the unparsable files.
    
    Returns:
    
    the unparsable files
  - isStoringResources
```
public boolean isStoringResources()
```
    Return true if resources must be stored.
    
    Returns:
    
    true if resources must be stored
  - setWikiState
```
public void setWikiState(org.docgene.model.incremental.IncrementalGenerationState wikiState)
```
    Set the object which hold the current state of the wiki
    
    Parameters:
    
    wikiState - the wiki state
  - getWikiState
```
public org.docgene.model.incremental.IncrementalGenerationState getWikiState()
```
    Return the object which hold the current state of the wiki
    
    Returns:
    
    the wiki state
  - hasGenerationByDelta
```
public boolean hasGenerationByDelta()
```
    Return the generation mode.
    
    Returns:
    
    true for the generation by delta (update mode)
  - hasPageRanks
```
public boolean hasPageRanks()
```
    Return true if there are computed PageRanks.
    
    Returns:
    
    true if there are computed PageRanks
  - setPageRanks
```
public void setPageRanks(org.docgene.model.globals.PageRanks pageRanks)
```
    Set the computed PageRanks.
    
    Parameters:
    
    pageRanks - the PageRanks
  - getPageRanks
```
public org.docgene.model.globals.PageRanks getPageRanks()
```
    Return the computed PageRanks.
    
    Returns:
    
    the PageRanks
  - getMenus
```
public org.docgene.model.globals.ArticlesMenus getMenus()
```
    Return the articles menus.
    
    Returns:
    
    the articles menus
  - hasCustomGlossaryMenuItem
```
public boolean hasCustomGlossaryMenuItem(boolean isIndex)
```
    Return true if there is a custom glossary menu item.
    
    Parameters:
    
    isIndex - true for the index page
    
    Returns:
    
    true if there is a custom glossary menu item
  - writeArticlesHeaderFrame
```
public void writeArticlesHeaderFrame(boolean value)
```
    Set if articles header frame must be written (default is true).
    
    Parameters:
    
    value - true if articles header frame must be written
  - isWritingArticlesHeaderFrame
```
public boolean isWritingArticlesHeaderFrame()
```
    Return true if articles header frame must be written (default is true).
    
    Returns:
    
    true if articles header frame must be written
  - writeArticlesTOC
```
public void writeArticlesTOC(boolean value)
```
    Set if articles Table of content must be written (default is true).
    
    Parameters:
    
    value - true if articles Table of content must be written
  - isWritingArticlesTOC
```
public boolean isWritingArticlesTOC()
```
    Return true if articles Table of content must be written (default is true)
    
    Returns:
    
    true if articles Table of content must be written.
  - writeSubDirectories
```
public void writeSubDirectories(boolean value)
```
    Set if allowing to write articles, resources and images in sub-directories (default is true).
    
    Parameters:
    
    value - true if allowing to write articles, resources and images in sub-directories
  - isWritingSubDirectories
```
public boolean isWritingSubDirectories()
```
    Return true if allowing to write articles, resources and images in sub-directories (default is true).
    
    Returns:
    
    true if allowing to write articles, resources and images in sub-directories
  - allowIdenticalTitleIDs
```
public void allowIdenticalTitleIDs(boolean value)
```
    Set if if the parser accept identical title IDs(default is true).
    
    Parameters:
    
    value - true if the parser accept identical title IDs
  - isAllowingIdenticalTitleIDs
```
public boolean isAllowingIdenticalTitleIDs()
```
    Return true if if the parser accept identical title IDs (default is true).
    
    Returns:
    
    true if the parser accept identical title IDs
  - writeSeeAlso
```
public void writeSeeAlso(boolean value)
```
    Set if allowing to write the seeAlso elements (default is true).
    
    Parameters:
    
    value - true if allowing to write the seeAlso elements
  - isWritingSeeAlso
```
public boolean isWritingSeeAlso()
```
    Return true if allowing to write the seeAlso elements(default is true).
    
    Returns:
    
    true if allowing to write the seeAlso elements
  - writeResources
```
public void writeResources(boolean value)
```
    Set if allowing to write resources files (default is true).
    
    Parameters:
    
    value - true if allowing to write resources files
  - isWritingResources
```
public boolean isWritingResources()
```
    Return true if allowing to write resources files.
    
    Returns:
    
    true if allowing to write resources files
  - writeScripts
```
public void writeScripts(boolean isWriting)
```
    Set if allowing to write scripts (default is true).
    
    Parameters:
    
    isWriting - true if allowing to write scripts
  - isWritingScripts
```
public boolean isWritingScripts()
```
    Return true if allowing to write scripts.
    
    Returns:
    
    true if allowing to write scripts
  - writeAnyScripts
```
public void writeAnyScripts(boolean isWriting)
```
    Set if allowing to write any scripts (default is true).
    
    Parameters:
    
    isWriting - true if allowing to write any scripts
  - isWritingAnyScripts
```
public boolean isWritingAnyScripts()
```
    Return true if allowing to write any scripts.
    
    Returns:
    
    true if allowing to write any scripts
  - forceAbsoluteLinks
```
public void forceAbsoluteLinks(boolean value)
```
    Set if relative links to files on the file system outside of the wiki will be converted to absolute links (default is false).
    
    Parameters:
    
    value - true if relative links to files on the file system outside of the wiki will be converted to absolute links
  - isForcingAbsoluteLinks
```
public boolean isForcingAbsoluteLinks()
```
    Return if relative links to files on the file system outside of the wiki will be converted to absolute links (default is false).
    
    Returns:
    
    true if relative links to files on the file system outside of the wiki will be converted to absolute links
  - supportThemes
```
public void supportThemes(boolean supportThemes)
```
    Set if the model writer support themes.
    
    Parameters:
    
    supportThemes - true if the model writer support themes
  - isSupportingThemes
```
public boolean isSupportingThemes()
```
    Return true if the model writer support themes.
    
    Returns:
    
    true if the model writer support themes
  - setFulltextSearch
```
public void setFulltextSearch(org.docgene.model.globals.FullTextSearch fullTextSearch)
```
    Set the full text search manager.
    
    Parameters:
    
    fullTextSearch - the full text search manager
  - addLinksFrom
```
public void addLinksFrom()
```
    Set if the articles must have a "What Links Here" link.
  - hasLinksFrom
```
public boolean hasLinksFrom()
```
    Return true if the articles must have a "What Links Here" link.
    
    Returns:
    
    true if the articles must have a "What Links Here" link
  - addTodo
```
public void addTodo(XMLArticle article,
                    TodoElement todo)
```
    Add a TODO to the TODO list.
    
    Parameters:
    
    article - the article
    
    todo - the TODO
  - getTodoList
```
public XMLTodoList getTodoList()
```
    Return the TODO list.
    
    Returns:
    
    the TODO list
  - addComment
```
public void addComment(XMLArticle article,
                       XMLComment comment)
```
    Add a comment to the comment list.
    
    Parameters:
    
    article - the article
    
    comment - the comment
  - getCommentList
```
public XMLCommentList getCommentList()
```
    Return the comment list.
    
    Returns:
    
    the comment list
  - hasComments
```
public boolean hasComments()
```
    Return true if there are comments.
    
    Returns:
    
    true if there are comments
  - getDictionary
```
public ArticlesDictionary getDictionary()
```
    Return the articles glossary.
    
    Returns:
    
    the dictionnary
  - getFullTextSearch
```
public org.docgene.model.globals.FullTextSearch getFullTextSearch()
```
    Return the articles full text search.
    
    Returns:
    
    the articles full text search
  - hasFullTextSearch
```
public boolean hasFullTextSearch()
```
    Return true if the model has full text Search.
    
    Returns:
    
    true if the model has full text Search
  - getGlossary
```
public ArticlesGlossary getGlossary()
```
    Return the articles glossary.
    
    Returns:
    
    the glossary
  - hasGlossary
```
public boolean hasGlossary()
```
    Return true if the articles have a glossary.
    
    Returns:
    
    true if the articles have a glossary
  - setGlossary
```
public void setGlossary(ArticlesGlossary glossary)
```
    Set the articles glossary.
    
    Parameters:
    
    glossary - the glossary
  - hasImage
```
public boolean hasImage(java.lang.String id,
                        java.lang.String origPack,
                        java.lang.String pack)
```
    Return true if the model has an image for a specified id and package.
    
    Parameters:
    
    id - the image ID
    
    origPack - the origin package (ie it is the package from which the reference is emitted)
    
    pack - the image package
    
    Returns:
    
    true if the model has an image for the specified id and package
  - hasImageForAllPackages
```
public boolean hasImageForAllPackages(java.lang.String id)
```
    Return true if the model has an image for a specified id (for all packages).
    
    Parameters:
    
    id - the image ID
    
    Returns:
    
    true if the model has an image for the specified id
  - getImageForAllPackages
```
public org.docgene.model.globals.ImageDefinition getImageForAllPackages(java.lang.String id)
```
    Return the image of a specified id (for all packages).
    
    Parameters:
    
    id - the image ID
    
    Returns:
    
    the image of the specified id
  - getImage
```
public org.docgene.model.globals.ImageDefinition getImage(java.lang.String id)
```
    Return the image of a specified id. The image in this case is not in any package.
    
    Parameters:
    
    id - the image ID
    
    Returns:
    
    the image
  - getImage
```
public org.docgene.model.globals.ImageDefinition getImage(java.lang.String id,
                                                          java.lang.String origPack,
                                                          java.lang.String pack)
```
    Return the image of a specified id and package.
    
    Parameters:
    
    id - the image ID
    
    origPack - the origin package (ie it is the package from which the reference is emitted)
    
    pack - the image package
    
    Returns:
    
    the image of the specified id and package
  - addImage
```
public void addImage(org.docgene.model.globals.ImageDefinition image)
```
    Add an image resource.
    
    Parameters:
    
    image - the image resource
  - removeImage
```
public boolean removeImage(org.docgene.model.globals.ImageDefinition image)
```
    Removes an image.
    
    Parameters:
    
    image - the image.
    
    Returns:
    
    true if an image was removed
  - getImages
```
public java.util.Map<java.lang.String,org.docgene.model.globals.ImageDefinition> getImages()
```
    Return the image resources.
    
    Returns:
    
    the image resources
  - getAllImages
```
public java.util.List<org.docgene.model.globals.ImageDefinition> getAllImages()
```
    Return all the images including those from the packages.
    
    Returns:
    
    all the images including those from the packages
  - hasImage
```
public boolean hasImage(java.lang.String id)
```
    Return true if the model has an image with no package of a specified ID.
    
    Parameters:
    
    id - the ID
    
    Returns:
    
    true if the model has an image with no package of the specified ID
  - addImageFromHRef
```
public final void addImageFromHRef()
```
    Add an image from a path on the model.
  - hasImages
```
public boolean hasImages()
```
    Return true if the model has images.
    
    Returns:
    
    true if the model has images.
  - addInfobox
```
public void addInfobox(org.docgene.model.globals.InfoboxDefinition infobox)
```
    Add an infobox definition.
    
    Parameters:
    
    infobox - the infobox
  - removeInfobox
```
public boolean removeInfobox(org.docgene.model.globals.InfoboxDefinition infobox)
```
    Removes an infobox definition.
    
    Parameters:
    
    infobox - infobox definition.
    
    Returns:
    
    true if an image was removed
  - hasInfobox
```
public boolean hasInfobox(java.lang.String id)
```
    Return true if there is an infobox definition of a specified ID.
    
    Parameters:
    
    id - the infobox definition ID
    
    Returns:
    
    true if there is an infobox definition of the specified ID
  - hasInfobox
```
public boolean hasInfobox(java.lang.String id,
                          java.lang.String origPack,
                          java.lang.String pack)
```
    Return true if the model has an infobox definition for a specified id and package.
    
    Parameters:
    
    id - the image ID
    
    origPack - the origin package (ie it is the package from which the reference is emitted)
    
    pack - the infobox definition package
    
    Returns:
    
    true if the model has an infobox definition for the specified id and package
  - getInfobox
```
public org.docgene.model.globals.InfoboxDefinition getInfobox(java.lang.String id)
```
    Return the infobox definition of a specified id and package. The infobox in this case is not in any package.
    
    Parameters:
    
    id - the infobox definition ID
    
    Returns:
    
    the infobox definition of the specified id and package
  - getInfobox
```
public org.docgene.model.globals.InfoboxDefinition getInfobox(java.lang.String id,
                                                              java.lang.String origPack,
                                                              java.lang.String pack)
```
    Return the infobox definition of a specified id and package.
    
    Parameters:
    
    id - the infobox definition ID
    
    origPack - the origin package (ie it is the package from which the reference is emitted)
    
    pack - the infobox definition package
    
    Returns:
    
    the infobox definition of the specified id and package
  - getInfoboxes
```
public java.util.Map<java.lang.String,org.docgene.model.globals.InfoboxDefinition> getInfoboxes()
```
    Return the infobox definitions.
    
    Returns:
    
    the infobox definitions
  - getAllInfoboxes
```
public java.util.List<org.docgene.model.globals.InfoboxDefinition> getAllInfoboxes()
```
    Return all the infobox definitions including those from the packages.
    
    Returns:
    
    all the infobox definitions including those from the packages
  - setStyleSheet
```
public void setStyleSheet(java.io.File styleSheet)
```
    Set the output StyleSheet file.
    
    Parameters:
    
    styleSheet - the StyleSheet file
  - getStyleSheet
```
public java.io.File getStyleSheet()
```
    Return the output StyleSheet file.
    
    Returns:
    
    the output StyleSheet file
  - setStyleSheetTheme
```
public void setStyleSheetTheme(java.io.File styleSheetTheme)
```
    Set the StyleSheet theme file.
    
    Parameters:
    
    styleSheetTheme - StyleSheet theme file.
  - getStyleSheetTheme
```
public java.io.File getStyleSheetTheme()
```
    Return the output StyleSheet theme file..
    
    Returns:
    
    the output StyleSheet theme file.
  - setupElementDefinitions
```
public void setupElementDefinitions()
```
    Setup element definitions to be sure that we don't have more than once the same path name.
  - hasResource
```
public boolean hasResource(java.lang.String id)
```
    Return true if the model has a resource with no package of a specified ID.
    
    Parameters:
    
    id - the ID
    
    Returns:
    
    true if the model has a resource with no package of the specified ID
  - addResource
```
public void addResource(org.docgene.model.globals.ResourceDefinition resource)
```
    Add a resource.
    Referencing the resource URL
    Note that the resource must be defined in a "doc-files" directory. The URL is relative to this directory. For example, if we have the following file structure:
```
 articles
 ==> resources.xml
 ==> doc-files
 ====> myResourceFile.xml
 ====> anotherResourceFile.html
 
```
    In that case, the "resources.xml" file can have the following content to reference both the resources:
```
 <resources>
   <resourceDefinition id="resource1" url="myresourceFile.xml" />
   <resourceDefinition id="resource2" url="anotherResourceFile.html" />
 </resources>
 
```
    Note that the "doc-files" directory is not part of the resource URL specification.
    Parameters:
    
    resource - the resource
    
    See Also:
    
    ResourceDefinition
  - removeResource
```
public boolean removeResource(org.docgene.model.globals.ResourceDefinition resource)
```
    Removes a resource.
    
    Parameters:
    
    resource - the resource.
    
    Returns:
    
    true if a resource was removed
  - addDirectResource
```
public void addDirectResource(XMLResource resource)
```
    Add a resource directy specified in a "doc-files" directory.
    
    Parameters:
    
    resource - the resource.
  - hasRawArticles
```
public boolean hasRawArticles()
```
    Return true if this model has at least one raw HTML file.
    
    Returns:
    
    true if this model has at least one raw HTML file
  - hasResource
```
public boolean hasResource(java.lang.String id,
                           java.lang.String origPack,
                           java.lang.String pack)
```
    Return true if the model has a resource for a specified id and package.
    
    Parameters:
    
    id - the resource ID
    
    origPack - the origin package (ie it is the package from which the reference is emitted)
    
    pack - the resource package
    
    Returns:
    
    true if the model has a resource for the specified id and package
  - getResource
```
public org.docgene.model.globals.ResourceDefinition getResource(java.lang.String id,
                                                                java.lang.String origPack,
                                                                java.lang.String pack)
```
    Return the resource of a specified id and package.
    
    Parameters:
    
    id - the resource ID
    
    origPack - the origin package (ie it is the package from which the reference is emitted)
    
    pack - the resource package
    
    Returns:
    
    the resource of the specified id and package
  - getResources
```
public java.util.Map<java.lang.String,org.docgene.model.globals.ResourceDefinition> getResources()
```
    Return the resources.
    
    Returns:
    
    the resources
    
    See Also:
    
    addResource(org.docgene.model.globals.ResourceDefinition), ResourceDefinition
  - getAllResources
```
public java.util.List<org.docgene.model.globals.ResourceDefinition> getAllResources()
```
    Return all the resources including those from the packages.
    
    Returns:
    
    all the resources including those from the packages
  - setIndex
```
public void setIndex(XMLIndex article,
                     java.lang.String pack,
                     boolean isGlobalIndex)
```
    Set the model index.
    
    Parameters:
    
    article - the index article
    
    pack - the article package
    
    isGlobalIndex - true for the global index
  - hasGlobalIndex
```
public boolean hasGlobalIndex()
```
    Return true if there is a global index.
    
    Returns:
    
    true if there is a global index
  - setIndex
```
public void setIndex(XMLIndex article,
                     java.lang.String pack)
```
    Set the model index.
    
    Parameters:
    
    article - the index article
    
    pack - the article package
  - setHeader
```
public void setHeader(XMLHeader header)
```
    Set the articles header.
    
    Parameters:
    
    header - the articles header
  - getHeader
```
public XMLHeader getHeader()
```
    Return the articles header.
    
    Returns:
    
    the articles header
  - setFooter
```
public void setFooter(XMLFooter footer)
```
    Set the articles footer.
    
    Parameters:
    
    footer - the articles footer
  - getFooter
```
public XMLFooter getFooter()
```
    Return the articles footer.
    
    Returns:
    
    the articles footer
  - setFallbackArticle
```
public void setFallbackArticle(XMLFallbackArticle fallbackArticle)
```
    Set a fallback article.
    
    Parameters:
    
    fallbackArticle - the fallback article
  - getFallbackArticle
```
public XMLFallbackArticle getFallbackArticle(char type)
```
    Return a fallback article.
    
    Parameters:
    
    type - the fallback article type
    
    Returns:
    
    the fallback article
  - hasFallbackArticle
```
public boolean hasFallbackArticle(char type)
```
    Return a fallback article.
    
    Parameters:
    
    type - the fallback article type
    
    Returns:
    
    true if the fallback article exists
  - hasIndex
```
public boolean hasIndex()
```
    Return true if the model has already an index article.
    
    Returns:
    
    true if the model has already an index article
  - getIndex
```
public XMLIndex getIndex()
```
    Return the index article.
    
    Returns:
    
    the index article
  - setPackagesDependencies
```
public void setPackagesDependencies(org.docgene.model.globals.PackagesDependencies dependencies)
```
    Set the Packages Dependencies.
    
    Parameters:
    
    dependencies - the Packages Dependencies
  - getPackagesDependencies
```
public org.docgene.model.globals.PackagesDependencies getPackagesDependencies()
```
    Return the Packages Dependencies.
    
    Returns:
    
    the Packages Dependencies
  - getPackages
```
public java.util.Map<java.lang.String,org.docgene.model.globals.PackageModel> getPackages()
```
    Return the packages.
    
    Returns:
    
    the packages
  - hasPackages
```
public boolean hasPackages()
```
    Return true if there are packages.
    
    Returns:
    
    true if there are packages
  - hasPackage
```
public boolean hasPackage(java.lang.String pack)
```
    Return true if a package exists.
    
    Parameters:
    
    pack - the package name
    
    Returns:
    
    true if the package exists
  - getArticlesIterator
```
public java.util.Iterator<Article> getArticlesIterator()
```
    Return an iterator on all the articles, including packages.
    
    Returns:
    
    the iterator
  - getArticles
```
public java.util.Map<java.lang.String,Article> getArticles()
```
    Return the articles without packages.
    
    Returns:
    
    the articles without packages
  - countArticles
```
public int countArticles()
```
    Return the count of all articles, excluding the XMLRedirect and template articles.
    
    Returns:
    
    the count of all articles, excluding the XMLRedirect and template articles
  - getArticlesPerAllNames
```
public java.util.Map<java.lang.String,Article> getArticlesPerAllNames()
```
    Return the articles without packages. Beware that this Map may contain the same article several times: an article is present through:
    - Its description: see XMLArticle.getDescription()
    - Its description where the white spaces have been replaced by undersocre characters
    - Its ID if it has an ID attribute: see XMLArticle.getID()
    Returns:
    
    the articles without packages
  - getFirstArticle
```
public XMLParentArticle getFirstArticle(java.lang.String refID,
                                        boolean includePackages)
```
    Return the first article specified by its reference, regardless of the package in which the article is defined.
    
    Parameters:
    
    refID - the article reference ID. It can be:
    
    includePackages - true if the packaegs are takne into account
    
    Returns:
    
    the article
  - getFirstArticle
```
public XMLParentArticle getFirstArticle(java.lang.String refID)
```
    Return the first article specified by its reference, regardless of the package in which the article is defined.
    
    Parameters:
    
    refID - the article reference ID. It can be:
    
    Returns:
    
    the article
  - acceptDependency
```
public short acceptDependency(java.lang.String origPack,
                              java.lang.String destPack)
```
    Return true if dependencies betwen two packages are accepted.
    
    Parameters:
    
    origPack - the origin package
    
    destPack - the destination package
    
    Returns:
    
    true if dependencies betwen the two packages are accepted
  - isIncludingPackage
```
public boolean isIncludingPackage(java.lang.String pack)
```
    Return true if a package must be included in the wiki output.
    
    Parameters:
    
    pack - the package
    
    Returns:
    
    true if the package must be included in the wiki output
  - showPackageErrors
```
public boolean showPackageErrors(java.lang.String pack)
```
    Return true if a package must be included in the wiki output.
    
    Parameters:
    
    pack - the package
    
    Returns:
    
    true if the package must be included in the wiki output
  - isIncludingElement
```
public boolean isIncludingElement(org.docgene.model.globals.PackagedElement element)
```
    Return true if an element must be included in the wiki output.
    
    Parameters:
    
    element - the element
    
    Returns:
    
    true if the element must be included in the wiki output
  - showElementErrors
```
public boolean showElementErrors(org.docgene.model.globals.PackagedElement element)
```
    Return true if errors on an element must be emitted.
    
    Parameters:
    
    element - the element
    
    Returns:
    
    true if errors on an element must be emitted
  - showUnresolvedReferences
```
public boolean showUnresolvedReferences(java.lang.String origPack,
                                        java.lang.String destPack)
```
    Return true if unresolved references between between two packages must emit an error.
    
    Parameters:
    
    origPack - the origin package
    
    destPack - the destination package
    
    Returns:
    
    true if unresolved references betwen the two packages must emit an error
  - showUnresolvedImages
```
public boolean showUnresolvedImages(java.lang.String origPack,
                                    java.lang.String destPack)
```
    Return true if unresolved images between between two packages must emit an error.
    
    Parameters:
    
    origPack - the origin package
    
    destPack - the destination package
    
    Returns:
    
    true if unresolved images betwen the two packages must emit an error
  - showUnresolvedInfoboxes
```
public boolean showUnresolvedInfoboxes(java.lang.String origPack,
                                       java.lang.String destPack)
```
    Return true if unresolved infoboxes between between two packages must emit an error.
    
    Parameters:
    
    origPack - the origin package
    
    destPack - the destination package
    
    Returns:
    
    true if unresolved infoboxes betwen the two packages must emit an error
  - getArticle
```
public XMLParentArticle getArticle(ArticleRef articleRef)
```
    Return an article specified by its reference.
    
    Parameters:
    
    articleRef - the article reference ID.
    
    Returns:
    
    the article
    
    See Also:
    
    getArticle(java.lang.String, java.lang.String)
  - getArticle
```
public XMLParentArticle getArticle(java.lang.String refID,
                                   java.lang.String pack)
```
    Return an article specified by its reference.
    Parameters:
    refID - the article reference ID. It can be:
    
    The article ID: see XMLArticle.getID()
    
    The article description: see XMLArticle.getDescription()
    
    The article description where the white spaces have been replaced by underscore characters
    pack - the article package
    
    Returns:
    
    the article
  - getArticle
```
public XMLParentArticle getArticle(java.lang.String refID)
```
    Return an article specified by its reference. The article in this case is not in any package.
    Parameters:
    refID - the article reference ID. It can be:
    
    The article ID: see XMLArticle.getID()
    
    The article description: see XMLArticle.getDescription()
    
    The article description where the white spaces have been replaced by underscore characters
    Returns:
    
    the article
  - getArticle
```
public XMLParentArticle getArticle(java.lang.String refID,
                                   java.lang.String origPack,
                                   java.lang.String pack)
```
    Return an article specified by its reference.
    Parameters:
    refID - the article reference ID. It can be:
    
    The article ID: see XMLArticle.getID()
    
    The article description: see XMLArticle.getDescription()
    
    The article description where the white spaces have been replaced by underscore characters
    origPack - the origin package (ie it is the package from which the reference is emitted)
    
    pack - the article package
    
    Returns:
    
    the article
  - removeArticle
```
public boolean removeArticle(Article article)
```
    Remove an article.
    
    Parameters:
    
    article - the article.
    
    Returns:
    
    true if an article was removed
  - getParsedArticles
```
public java.util.Collection<Article> getParsedArticles()
```
    Return the parsed articles.
    
    Returns:
    
    the parsed articles
  - getRankedArticles
```
public java.util.List<Article> getRankedArticles()
```
    Return all the articles including those from the packages, possibly takning the page ranks into accounts.
    
    Returns:
    
    all the articles including those from the packages
  - getAllArticles
```
public java.util.List<Article> getAllArticles()
```
    Return all the articles including those from the packages.
    
    Returns:
    
    all the articles including those from the packages
  - getArticlesMap
```
public java.util.Map<java.lang.String,java.util.List<Article>> getArticlesMap()
```
    Return the Map of articles for each name, for all packages. The case where there is more than one article per name for several packages is taken into account.
    
    Returns:
    
    the Map of articles for each name, for all packages
  - getArticlesMapByRef
```
public java.util.Map<ArticleRef,Article> getArticlesMapByRef()
```
    Return the Map of articles for each article reference, for all packages. The case where there is more than one article per name for several packages is taken into account.
    
    Returns:
    
    the Map of articles for each article reference, for all packages
  - hasArticle
```
public boolean hasArticle(java.lang.String refID)
```
    Return true if the model contains an article with no package which can be reached through a specified reference.
    
    Parameters:
    
    refID - the article reference ID
    
    Returns:
    
    true if the model contains an article with no package which can be reached trhough a specified reference
  - hasArticleFromAnyPackage
```
public boolean hasArticleFromAnyPackage(java.lang.String refID)
```
    Return true if the model contains an article with no package which can be reached through a specified reference, from any package.
    
    Parameters:
    
    refID - the article reference ID
    
    Returns:
    
    true if the model contains an article with no package which can be reached trhough a specified reference
  - hasTransitiveArticle
```
public boolean hasTransitiveArticle(java.lang.String refID,
                                    java.lang.String origPack,
                                    java.lang.String pack)
```
    Return true if the model has a concrete article for a specified id and package.
    
    Parameters:
    
    refID - the article ID
    
    origPack - the origin package
    
    pack - the article package
    
    Returns:
    
    true if if the model has a concrete article forthe id and package
  - hasTransitiveArticle
```
public boolean hasTransitiveArticle(java.lang.String refID,
                                    java.lang.String origPack,
                                    java.lang.String pack,
                                    boolean acceptInclude)
```
    Return true if the model has a concrete article for a specified id and package.
    
    Parameters:
    
    refID - the article ID
    
    origPack - the origin package
    
    pack - the article package
    
    acceptInclude - true if templates are accepted
    
    Returns:
    
    true if if the model has a concrete article forthe id and package
  - getTransitiveArticle
```
public XMLParentArticle getTransitiveArticle(java.lang.String refID,
                                             java.lang.String origPack,
                                             java.lang.String pack)
```
    Return the concrete article for a specified id and package.
    
    Parameters:
    
    refID - the article ID
    
    origPack - the origin package
    
    pack - the article package
    
    Returns:
    
    the concrete article for the specified id and package
  - hasArticle
```
public boolean hasArticle(java.lang.String refID,
                          java.lang.String origPack,
                          java.lang.String pack)
```
    Return true if the model contains an article which can be reached through a specified reference.
    
    Parameters:
    
    refID - the article reference ID
    
    origPack - the origin package (ie it is the package from which the reference is emitted)
    
    pack - the article package
    
    Returns:
    
    true if the model contains an article which can be reached trhough a specified reference
  - getCategories
```
public ArticlesCategories getCategories()
```
    Return the categories.
    
    Returns:
    
    the categories
  - hasCategory
```
public boolean hasCategory(java.lang.String catID)
```
    Return true if the model has a category with a specified ID.
    
    Parameters:
    
    catID - the category ID
    
    Returns:
    
    true if the model has a category with the specified ID
  - getCategory
```
public ArticleCategory getCategory(java.lang.String catID)
```
    Return the category with a specified ID.
    
    Parameters:
    
    catID - the category ID
    
    Returns:
    
    the category with the specified ID
  - getDefaultCategory
```
public ArticleCategory getDefaultCategory()
```
    The default category is the category of articles which belong to no category.
    
    Returns:
    
    the default category
  - addPackage
```
public org.docgene.model.globals.PackageModel addPackage(org.docgene.model.globals.PackageModel packModel)
```
    Add a package.
    
    Parameters:
    
    packModel - the package
    
    Returns:
    
    the package
  - addPackage
```
public org.docgene.model.globals.PackageModel addPackage(org.docgene.model.globals.RootDirectory root,
                                                         java.lang.String pack)
```
    Add a package.
    
    Parameters:
    
    root - the root directory
    
    pack - the package name
    
    Returns:
    
    the package
  - getPackage
```
public org.docgene.model.globals.PackageModel getPackage(java.lang.String pack)
```
    Return the package of a specified name.
    
    Parameters:
    
    pack - the package name
    
    Returns:
    
    the package
  - addArticleToDictionnary
```
public Article addArticleToDictionnary(java.lang.String title,
                                       Article article)
```
    Add an article to the dictionnary.
    
    Parameters:
    
    title - the title
    
    article - the article
    
    Returns:
    
    the article which has been effectively added
  - addArticleToDictionnary
```
public Article addArticleToDictionnary(Article article)
```
    Add an article to the dictionnary and categories.
    
    Parameters:
    
    article - the article
    
    Returns:
    
    the article which has been effectively added
  - refreshCategories
```
protected void refreshCategories(Article article,
                                 boolean resolve)
```
    Integrate the categories of an article in the list of categories.
    
    Parameters:
    
    article - the article
    
    resolve - true to perform the categories resolution
  - addCategory
```
public void addCategory(ArticleCategory cat)
```
    Add a category to the model.
    
    Parameters:
    
    cat - the category
  - hasTitles
```
public boolean hasTitles()
```
    Return true if at least one article has a searchable title.
    
    Returns:
    
    true if at least one article has a searchable title
  - addDisambArticle
```
public void addDisambArticle(XMLDisambArticle article)
```
    Add a disambiguation article.
    
    Parameters:
    
    article - the article
  - addReferenceToDisambArticle
```
public void addReferenceToDisambArticle(ArticleRef articleRef,
                                        XMLDisambArticle article)
```
    Add an article reference to the associated disambiguation article.
    
    Parameters:
    
    articleRef - the article reference
    
    article - the disambiguation article
  - hasDisambArticle
```
public boolean hasDisambArticle(ArticleRef ref)
```
    Return true if there is a disambiguation article corresponding to an article reference.
    
    Parameters:
    
    ref - the article reference
    
    Returns:
    
    true if there is a disambiguation article corresponding to an article reference
  - getDisambArticle
```
public XMLDisambArticle getDisambArticle(ArticleRef ref)
```
    Return the disambiguation article corresponding to an article reference.
    
    Parameters:
    
    ref - the article reference
    
    Returns:
    
    the disambiguation article
  - getReferenceToDisambArticles
```
public java.util.Map<ArticleRef,XMLDisambArticle> getReferenceToDisambArticles()
```
    Return the map from article reference to the associated disambiguation article.
    
    Returns:
    
    the map
  - getDisambArticles
```
public java.util.Map<java.lang.String,XMLDisambArticle> getDisambArticles()
```
    Add the Map of disambiguation articles.
    
    Returns:
    
    the Map of disambiguation articles
  - hasDisambArticle
```
public boolean hasDisambArticle(java.lang.String desc)
```
    Return true if the model has a disambiguation article for a specified description.
    
    Parameters:
    
    desc - the article description
    
    Returns:
    
    true if the model has a disambiguation article for the description
  - getDisambArticle
```
public XMLDisambArticle getDisambArticle(java.lang.String desc)
```
    Return the disambiguation article for a specified description.
    
    Parameters:
    
    desc - the article description
    
    Returns:
    
    the disambiguation article for the description
  - setHasTitles
```
public void setHasTitles()
```
    Set that the model has titles.
  - addRoot
```
public org.docgene.model.globals.RootDirectory addRoot(java.io.File rootDir)
```
    Add a root directory.
    
    Parameters:
    
    rootDir - the directory
    
    Returns:
    
    the root
  - getArticlesForFiles
```
public java.util.Map<java.io.File,Article> getArticlesForFiles()
```
    Return the map from input file to article.
    
    Returns:
    
    the map from input file to article
  - getArticle
```
public Article getArticle(java.io.File file)
```
    Return the article coresponding to a specified input file.
    
    Parameters:
    
    file - the input file
    
    Returns:
    
    the article
  - getNonExistingDesc
```
public java.lang.String getNonExistingDesc(Article article)
```
    Return a description which is not used for an article.
    
    Parameters:
    
    article - the article
    
    Returns:
    
    the new article description
  - renameArticle
```
public void renameArticle(Article article,
                          XMLDisambArticle disamb,
                          java.lang.String newDesc)
```
    Rename an article, making sure it will not use an existing name.
    
    Parameters:
    
    article - the article
    
    disamb - the disambiguation article
    
    newDesc - the new article description
  - addParsedArticle
```
public void addParsedArticle(Article article)
```
    Add a parsed article.
    
    Parameters:
    
    article - the article
  - replaceArticle
```
public void replaceArticle(Article article)
```
    Replace an article by anotehr version.
    
    Parameters:
    
    article - the article
  - addArticle
```
public Article addArticle(Article article,
                          java.lang.String pack)
```
    Add an article.
    
    Parameters:
    
    article - the article
    
    pack - the package name
    
    Returns:
    
    the article which has been effectively added
  - addUnparsableArticle
```
public void addUnparsableArticle(org.docgene.model.unparsable.UnparsableArticle article,
                                 java.lang.String pack)
```
    Add an unparsable article.
    
    Parameters:
    
    article - the article
    
    pack - the article package
  - addArticle
```
public Article addArticle(Article article,
                          java.lang.String pack,
                          boolean checkName,
                          boolean resolve)
```
    Add an article.
    
    Parameters:
    
    article - the article
    
    pack - the article package
    
    checkName - true if the name of the article must be checked
    
    resolve - if the article must be included in the categories
    
    Returns:
    
    the article which has been effectively added

Class ArticlesModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ArticlesModel

ArticlesModel

ArticlesModel

Method Detail

isConcurrent

addElementDefinitionFile

getElementDefinitionFiles

removeElementDefinitionFile

addCategoriesFile

getCategoriesFiles

removeCategoriesFile

setDictionaryFile

getDictionaryFile

hasDictionaryFile

addUnparsableFile

getUnparsableFiles

isStoringResources

setWikiState

getWikiState

hasGenerationByDelta

hasPageRanks

setPageRanks

getPageRanks

getMenus

hasCustomGlossaryMenuItem

writeArticlesHeaderFrame

isWritingArticlesHeaderFrame

writeArticlesTOC

isWritingArticlesTOC

writeSubDirectories

isWritingSubDirectories

allowIdenticalTitleIDs

isAllowingIdenticalTitleIDs

writeSeeAlso

isWritingSeeAlso

writeResources

isWritingResources

writeScripts

isWritingScripts

writeAnyScripts

isWritingAnyScripts

forceAbsoluteLinks

isForcingAbsoluteLinks

supportThemes

isSupportingThemes

setFulltextSearch

addLinksFrom

hasLinksFrom

addTodo

getTodoList

addComment

getCommentList

hasComments

getDictionary

getFullTextSearch

hasFullTextSearch

getGlossary

hasGlossary

setGlossary

hasImage

hasImageForAllPackages

getImageForAllPackages

getImage

getImage

addImage

removeImage

getImages

getAllImages

hasImage

addImageFromHRef

hasImages

addInfobox

removeInfobox

hasInfobox

hasInfobox