XMLDisambArticle (DocJGenerator Scripting API)

java.lang.Object
- org.docgene.model.AbstractXMLParent
- - org.docgene.model.AbstractXMLParentArticle
  - - org.docgene.model.XMLDisambArticle

All Implemented Interfaces:

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 XMLDisambArticle
extends org.docgene.model.AbstractXMLParentArticle
```
Represents an XML disambiguation article.

Field Summary
- Fields inherited from class org.docgene.model.AbstractXMLParent
  chapters, paragraphs
- Fields inherited from interface org.docgene.model.Article
  INDEX, INDEX_LC, TYPE_ARTICLE, TYPE_DISAMB, TYPE_FALLBACK, TYPE_INDEX, TYPE_RAW_HTML, TYPE_REDIRECT, TYPE_TEMPLATE
- Fields inherited from interface org.docgene.model.globals.RootElement
  ARTICLE, CATEGORIES, CATEGORY, DICTIONARY, FOOTER, FULL_TEXT_SEARCH, GLOSSARY, HEADER, IMAGE_DEFINITION, IMAGES_DEFINITION, INFOBOX_DEFINITION, INFOBOX_PROPERTY, MENUS, PACKAGE, RESOURCE_DEFINITION, RESOURCES_DEFINITION, UNDEFINED

Constructor Summary

Constructors
Constructor and Description

XMLDisambArticle(java.lang.String desc, boolean keepCase)
Constructor.

Constructors
Constructor and Description
`XMLDisambArticle(java.lang.String desc, boolean keepCase)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDisambArticle(org.docgene.model.Article article)` Add an article to the disambiguation list.
`void`	`addDisambElement(ArticleRef id)` Add a disambiguation element.
`XMLParentArticle`	`getArticle()` Return this.
`short`	`getArticleType()` Return the article type.
`java.util.Set<java.lang.String>`	`getCategories()` Return the categories on which this article belongs.
`java.lang.String`	`getDescription()` Return the article description.
`java.util.List<org.docgene.model.Article>`	`getDisambArticles()` Return the disambiguated articles.
`java.util.List<ArticleRef>`	`getDisambElements()` Return a disambiguation elements.
`java.lang.String`	`getHeader(boolean escaping)` Construct the header text for the redirect article.
`java.lang.String`	`getID()` Return the article ID.
`java.io.File`	`getInputFile()` Return the article input XML file.
`java.io.File`	`getLinksFromFile()` Return the article links from HTML file.
`int`	`getMaxIndex()` Return the maximum index of articles which have the name of this disambiguation article.
`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 null.
`XMLParent`	`getParent()` Return null.
`java.lang.String`	`getTitle()` Return the article title.
`boolean`	`hasAlternateTitles()` Return false.
`boolean`	`hasID()` Return false.
`boolean`	`hasPackage()` Return false.
`boolean`	`isDirect()` Return true.
`boolean`	`isKeepingCase()` Return true if the article title should keep the title description case.
`void`	`resolve()` Resolve the Disambiguation article.
`void`	`setDescription(java.lang.String id, java.lang.String desc, boolean keepCase)` Set the article description.
`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`	`setLinksFromFile(java.io.File file)` Set the article links from XML file.
`void`	`setOutputFile(java.io.File file)` Set the article output XML file.
`java.lang.String`	`toString()`

Methods inherited from class org.docgene.model.AbstractXMLParentArticle
addArticleParent, addLinkFromArticle, addReference, addReference, getArticleParents, getCondition, getLinksFrom, getReferences, getRoot, hasCondition, hasImages, isPresent, setCondition, setImages, setLinkFromArticles, setRoot

Methods inherited from class org.docgene.model.AbstractXMLParent
addChapter, addParagraph, getChapters, getParagraphs

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, 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
addAlternateTitle, articleNameAlreadyTaken, getAlternateTitles, getAlternateTitlesMap, getHeader, getMaps, getNormalizedAlternateTitles, getRef, getRootElementType, getSuffix, hasImageMaps, hasMaps, hasSearchableTitles, hasSuffix, hasTOC, isDirectXMLArticle, isIndex, isRawHTMLArticle, isTemplate, isValid, setArticleNameAlreadyTaken, setSuffix

Methods inherited from interface org.docgene.model.globals.XMLRootElement
getAbsolutePath, getRelativePath, hasInputFile, isParsable, setPackage

Methods inherited from interface org.docgene.model.globals.RootElement
hasRoot, isArticle, isFallback, notExistingInputFile

Methods inherited from interface org.docgene.model.XMLParent
addChapter, addParagraph, getChapters, getParagraphs

Methods inherited from interface org.docgene.model.HTMLOutput
hasOutputFile

- Constructor Detail
  - XMLDisambArticle
```
public XMLDisambArticle(java.lang.String desc,
                        boolean keepCase)
```
    Constructor.
    
    Parameters:
    
    desc - the article description. The article getID() will be equal to its description
    
    keepCase - true if the article description should keep the title description case
- Method Detail
  - getArticleType
```
public short getArticleType()
```
    Return the article type.
    
    Returns:
    
    the article type
  - isDirect
```
public boolean isDirect()
```
    Return true.
    
    Returns:
    
    true
  - getPackage
```
public java.lang.String getPackage()
```
    Return null.
    
    Returns:
    
    null
  - hasPackage
```
public boolean hasPackage()
```
    Return false.
    
    Returns:
    
    false
  - 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.
    
    Returns:
    
    true if the article title should keep the title description case
  - getMaxIndex
```
public int getMaxIndex()
```
    Return the maximum index of articles which have the name of this disambiguation article.
    
    Returns:
    
    the maximum index
  - getHeader
```
public java.lang.String getHeader(boolean escaping)
```
    Construct the header text for the redirect article.
    
    Parameters:
    
    escaping - true if the text must be escaped to html content
    
    Returns:
    
    the header text for the redirect article
  - hasID
```
public boolean hasID()
```
    Return false.
    
    Returns:
    
    false.
  - hasAlternateTitles
```
public boolean hasAlternateTitles()
```
    Return false.
    
    Returns:
    
    false.
  - getMeta
```
public java.lang.String getMeta()
```
    Return the meta description to be used for the article for the dictionnary or categories.
    
    Returns:
    
    the meta description
  - setInputFile
```
public void setInputFile(java.io.File file)
```
    Set the article input XML file.
    
    Parameters:
    
    file - the article input XML file
  - getInputFile
```
public java.io.File getInputFile()
```
    Return the article input XML file.
    
    Returns:
    
    the article input XML file
  - setOutputFile
```
public void setOutputFile(java.io.File file)
```
    Set the article output XML file.
    
    Parameters:
    
    file - the article input XML file
  - getOutputFile
```
public java.io.File getOutputFile()
```
    Return the article output HTML file.
    
    Returns:
    
    the article output HTML file
  - setLinksFromFile
```
public void setLinksFromFile(java.io.File file)
```
    Set the article links from XML file.
    
    Parameters:
    
    file - the article links from XML file
  - getLinksFromFile
```
public java.io.File getLinksFromFile()
```
    Return the article links from HTML file.
    
    Returns:
    
    the article links from HTML file
  - setID
```
public void setID(java.lang.String id)
```
    Set the article ID.
    
    Parameters:
    
    id - the article id
  - setDescription
```
public void setDescription(java.lang.String id,
                           java.lang.String desc,
                           boolean keepCase)
```
    Set the article description.
    
    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.
    
    Returns:
    
    the article description
  - getTitle
```
public java.lang.String getTitle()
```
    Return the article title.
    
    Returns:
    
    the article title
  - getID
```
public java.lang.String getID()
```
    Return the article ID.
    
    Returns:
    
    the article ID
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - addDisambElement
```
public void addDisambElement(ArticleRef id)
```
    Add a disambiguation element.
    
    Parameters:
    
    id - the disambiguation element
  - getDisambElements
```
public java.util.List<ArticleRef> getDisambElements()
```
    Return a disambiguation elements.
    
    Returns:
    
    the disambiguation elements
  - addDisambArticle
```
public void addDisambArticle(org.docgene.model.Article article)
```
    Add an article to the disambiguation list.
    
    Parameters:
    
    article - the article
  - getDisambArticles
```
public java.util.List<org.docgene.model.Article> getDisambArticles()
```
    Return the disambiguated articles.
    
    Returns:
    
    the disambiguated articles
  - resolve
```
public void resolve()
```
    Resolve the Disambiguation article. It will create the list of pagrapahs corresponding to the disambiguated articles in the list.
  - getArticle
```
public XMLParentArticle getArticle()
```
    Return this.
    
    Returns:
    
    this
  - getCategories
```
public java.util.Set<java.lang.String> getCategories()
```
    Return the categories on which this article belongs.
    
    Returns:
    
    the categories on which this article belongs
  - getParent
```
public XMLParent getParent()
```
    Return null.
    
    Returns:
    
    null

Class XMLDisambArticle

Field Summary

Fields inherited from class org.docgene.model.AbstractXMLParent

Fields inherited from interface org.docgene.model.Article

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

Constructor Summary

Method Summary

Methods inherited from class org.docgene.model.AbstractXMLParentArticle

Methods inherited from class org.docgene.model.AbstractXMLParent

Methods inherited from class java.lang.Object

Methods inherited from interface org.docgene.model.XMLParentArticle

Methods inherited from interface org.docgene.model.Article

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

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

Methods inherited from interface org.docgene.model.XMLParent

Methods inherited from interface org.docgene.model.HTMLOutput

Constructor Detail

XMLDisambArticle

Method Detail

getArticleType

isDirect

getPackage

hasPackage

setKeepCase

isKeepingCase

getMaxIndex

getHeader

hasID

hasAlternateTitles

getMeta

setInputFile

getInputFile

setOutputFile

getOutputFile

setLinksFromFile

getLinksFromFile

setID

setDescription

getDescription

getTitle

getID

toString

addDisambElement

getDisambElements

addDisambArticle

getDisambArticles

resolve

getArticle

getCategories

getParent