Article (DocJGenerator API)

All Superinterfaces:

org.docgene.model.globals.PackagedElement, org.docgene.model.globals.RootElement, org.docgene.model.globals.XMLRootElement

All Known Subinterfaces:

XMLParentArticle

All Known Implementing Classes:

AbstractXMLParentArticle, ArticlesGlossary, OpaqueArticle, XMLArticle, XMLDisambArticle, XMLFallbackArticle, XMLIndex, XMLRawHTMLArticle, XMLRedirect
```
public interface Article
extends org.docgene.model.globals.XMLRootElement, org.docgene.model.globals.PackagedElement
```
Represents an article interface.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`INDEX` The ID of the index article.
`static java.lang.String`	`INDEX_LC` The ID of the index article in lower case.
`static short`	`TYPE_ARTICLE` The type for a regular article.
`static short`	`TYPE_DISAMB` The type for a disambiguation article.
`static short`	`TYPE_FALLBACK` The type for a fallback article.
`static short`	`TYPE_INDEX` The type for the index article.
`static short`	`TYPE_RAW_HTML` The type for a raw html article.
`static short`	`TYPE_REDIRECT` The type for a redirect article.
`static short`	`TYPE_TEMPLATE` The type for a template article.

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`addAlternateTitle(java.lang.String title, boolean keepCase, boolean inDictionnary)` Add an alternate title to the article.
`default void`	`addReference(ArticleRef ref)` Add an article reference.
`default boolean`	`articleNameAlreadyTaken()` Return true if the article name was already taken, and the article was not added in the model.
`default java.util.Set<java.lang.String>`	`getAlternateTitles()` Return the article alternate titles.
`default java.util.Map<java.lang.String,AlternateTitle>`	`getAlternateTitlesMap()` Return the article alternate titles to the raw titles Map.
`XMLParentArticle`	`getArticle()` Return the XMLArticle which is really accessed through this Article.
`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.
`default 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.
`default java.util.List<XMLMap>`	`getMaps()` Return the list of maps in the article.
`default java.lang.String`	`getMeta()` Return the meta description to be used for the article for the dictionnary or categories.
`default java.util.Set<java.lang.String>`	`getNormalizedAlternateTitles()` Return the normalized article alternate titles.
`default java.util.List<NoteContent>`	`getNotes()` Return the notes.
`java.lang.String`	`getPackage()` Return the article package.
`default ArticleRef`	`getRef()` Return the article ref.
`java.util.Set<ArticleRef>`	`getReferences()` Return the references used in the article.
`default short`	`getRootElementType()` Return the `RootElement.ARTICLE` type.
`default int`	`getSuffix()` Return the article name suffix (used for articles which have the name of an already existing article).
`default java.lang.String`	`getTitle()` Return the article description by default.
`default boolean`	`hasAlternateTitles()` Return true if the article alternate titles.
`default boolean`	`hasCondition()` Return true if the article has a condition.
`boolean`	`hasID()` Return true if the article has a separate ID.
`default boolean`	`hasImageMaps()` Return true if the article has image maps.
`default boolean`	`hasImages()` Return true if this article has at least one image.
`default boolean`	`hasMaps()` Return true if the article has Maps.
`default boolean`	`hasNotes()` Return true if the article has notes.
`default boolean`	`hasSearchableTitles()` Return true if the article has searchable titles.
`default boolean`	`hasSuffix()` Return true if the article has a name suffix (used for articles which have the name of an already existing article).
`default boolean`	`hasTOC()` Return true if the article should have a Table of content (true by default).
`default boolean`	`isDirect()` Return true if this article is direct.
`default boolean`	`isDirectXMLArticle()` Return true if this article is direct and is not a raw html article.
`default boolean`	`isIndex()` Return true if the article is an index.
`boolean`	`isKeepingCase()` Return true if the article title should keep the title description case.
`default boolean`	`isRawHTMLArticle()` Return true if this article represents a raw HTML file.
`default boolean`	`isTemplate()` Return true if this article is a template.
`default boolean`	`isValid()` Return true if the article is valid.
`default void`	`setArticleNameAlreadyTaken(boolean articleNameAlreadyTaken)` Set if the article name was already taken, and the article was not added in the model.
`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.
`default void`	`setImages()` Set that this article has at least one image.
`void`	`setRoot(org.docgene.model.globals.RootDirectory root)` Set the root directory.
`default void`	`setSuffix(int suffix)` Set the article name suffix.

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

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

- Field Detail
  - TYPE_INDEX
```
static final short TYPE_INDEX
```
    The type for the index article.
    
    See Also:
    
    Constant Field Values
  - TYPE_ARTICLE
```
static final short TYPE_ARTICLE
```
    The type for a regular article.
    
    See Also:
    
    Constant Field Values
  - TYPE_DISAMB
```
static final short TYPE_DISAMB
```
    The type for a disambiguation article.
    
    See Also:
    
    Constant Field Values
  - TYPE_REDIRECT
```
static final short TYPE_REDIRECT
```
    The type for a redirect article.
    
    See Also:
    
    Constant Field Values
  - TYPE_TEMPLATE
```
static final short TYPE_TEMPLATE
```
    The type for a template article.
    
    See Also:
    
    Constant Field Values
  - TYPE_RAW_HTML
```
static final short TYPE_RAW_HTML
```
    The type for a raw html article.
    
    See Also:
    
    Constant Field Values
  - TYPE_FALLBACK
```
static final short TYPE_FALLBACK
```
    The type for a fallback article.
    
    See Also:
    
    Constant Field Values
  - INDEX
```
static final java.lang.String INDEX
```
    The ID of the index article.
    
    See Also:
    
    Constant Field Values
  - INDEX_LC
```
static final java.lang.String INDEX_LC
```
    The ID of the index article in lower case.
- Method Detail
  - getArticleType
```
short getArticleType()
```
    Return the article type.
    
    Returns:
    
    the article type
  - setArticleNameAlreadyTaken
```
default void setArticleNameAlreadyTaken(boolean articleNameAlreadyTaken)
```
    Set if the article name was already taken, and the article was not added in the model. Do nothing by default.
    
    Parameters:
    
    articleNameAlreadyTaken - true if the article name was already taken
  - articleNameAlreadyTaken
```
default boolean articleNameAlreadyTaken()
```
    Return true if the article name was already taken, and the article was not added in the model. Return false by default.
    
    Returns:
    
    true if the article name was already taken
  - hasCondition
```
default boolean hasCondition()
```
    Return true if the article has a condition. Return false by default.
    
    Returns:
    
    true if the article has a condition
  - getPackage
```
java.lang.String getPackage()
```
    Return the article package.
    
    Specified by:
    
    getPackage in interface org.docgene.model.globals.PackagedElement
    
    Specified by:
    
    getPackage in interface org.docgene.model.globals.XMLRootElement
    
    Returns:
    
    the article package
  - isKeepingCase
```
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
  - getHeader
```
default java.lang.String getHeader()
```
    Construct the header text for the article.
    
    Returns:
    
    the header text for the article
  - getHeader
```
java.lang.String getHeader(boolean escaping)
```
    Construct the header text for the article.
    
    Parameters:
    
    escaping - true if the text must be escaped to html content
    
    Returns:
    
    the header text for the article
  - hasID
```
boolean hasID()
```
    Return true if the article has a separate ID.
    
    Returns:
    
    true if the article has a separate ID
  - getSuffix
```
default int getSuffix()
```
    Return the article name suffix (used for articles which have the name of an already existing article). Return -1 by default, meaning that the article has no name suffix.
    
    Returns:
    
    the article name suffix
  - hasSuffix
```
default boolean hasSuffix()
```
    Return true if the article has a name suffix (used for articles which have the name of an already existing article).
    
    Returns:
    
    true if the article has a name suffix
  - setSuffix
```
default void setSuffix(int suffix)
```
    Set the article name suffix. Do nothing by default.
    
    Parameters:
    
    suffix - the article name suffix
  - hasTOC
```
default boolean hasTOC()
```
    Return true if the article should have a Table of content (true by default).
    
    Returns:
    
    true if the article should have a Table of content
  - setImages
```
default void setImages()
```
    Set that this article has at least one image. Do nothing by default.
  - hasAlternateTitles
```
default boolean hasAlternateTitles()
```
    Return true if the article alternate titles.
    
    Returns:
    
    true if the article alternate titles
  - addAlternateTitle
```
default boolean addAlternateTitle(java.lang.String title,
                                  boolean keepCase,
                                  boolean inDictionnary)
```
    Add an alternate title to the article.
    
    Parameters:
    
    title - the alternate title
    
    keepCase - true if the title description should keep the title description case
    
    inDictionnary - true if the alternate title must be included in the dictionnary and categories
    
    Returns:
    
    true if the alternate title can be added
  - getAlternateTitles
```
default java.util.Set<java.lang.String> getAlternateTitles()
```
    Return the article alternate titles. Return an empty Set by default.
    
    Returns:
    
    the article alternate titles
  - getAlternateTitlesMap
```
default java.util.Map<java.lang.String,AlternateTitle> getAlternateTitlesMap()
```
    Return the article alternate titles to the raw titles Map. Return an empty Map by default.
    
    Returns:
    
    the article alternate titles to the raw titles Map
  - getNormalizedAlternateTitles
```
default java.util.Set<java.lang.String> getNormalizedAlternateTitles()
```
    Return the normalized article alternate titles.
    
    Returns:
    
    the normalized article alternate titles
  - hasSearchableTitles
```
default boolean hasSearchableTitles()
```
    Return true if the article has searchable titles. Return false by default.
    
    Returns:
    
    true if the article has searchable titles
  - getMaps
```
default java.util.List<XMLMap> getMaps()
```
    Return the list of maps in the article. Return null by default.
    
    Returns:
    
    null
  - isRawHTMLArticle
```
default boolean isRawHTMLArticle()
```
    Return true if this article represents a raw HTML file. Return false by default.
    
    Returns:
    
    true if this article represents a raw HTML file
  - hasMaps
```
default boolean hasMaps()
```
    Return true if the article has Maps. Return false by default.
    
    Returns:
    
    false
  - hasImageMaps
```
default boolean hasImageMaps()
```
    Return true if the article has image maps. Return false by default.
    
    Returns:
    
    false
  - hasImages
```
default boolean hasImages()
```
    Return true if this article has at least one image. Return false by default.
    
    Returns:
    
    true if this article has at least one image
  - getArticle
```
XMLParentArticle getArticle()
```
    Return the XMLArticle which is really accessed through this Article. It will return itself if isDirect() returns true.
    
    Returns:
    
    the XMLArticle
  - getMeta
```
default java.lang.String getMeta()
```
    Return the meta description to be used for the article for the dictionnary or categories.
    
    Returns:
    
    the meta description
  - isTemplate
```
default boolean isTemplate()
```
    Return true if this article is a template. Return false by default.
    
    Returns:
    
    false
  - isDirect
```
default boolean isDirect()
```
    Return true if this article is direct. Return false by default.
    
    Returns:
    
    false
  - isDirectXMLArticle
```
default boolean isDirectXMLArticle()
```
    Return true if this article is direct and is not a raw html article.
    
    Returns:
    
    true if this article is direct and is not a raw html article
  - isIndex
```
default boolean isIndex()
```
    Return true if the article is an index. Return false by default.
    
    Returns:
    
    false
  - setID
```
void setID(java.lang.String id)
```
    Set the article ID.
    
    Parameters:
    
    id - the article id
  - setRoot
```
void setRoot(org.docgene.model.globals.RootDirectory root)
```
    Set the root directory.
    
    Parameters:
    
    root - the root
  - setDescription
```
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
```
java.lang.String getDescription()
```
    Return the article description.
    
    Returns:
    
    the article description
  - getRef
```
default ArticleRef getRef()
```
    Return the article ref.
    
    Returns:
    
    the article ref
  - getReferences
```
java.util.Set<ArticleRef> getReferences()
```
    Return the references used in the article.
    
    Returns:
    
    the references
  - addReference
```
default void addReference(ArticleRef ref)
```
    Add an article reference. Do nothing by default.
    
    Parameters:
    
    ref - the article reference
  - getTitle
```
default java.lang.String getTitle()
```
    Return the article description by default.
    
    Returns:
    
    the article description by default
  - getID
```
java.lang.String getID()
```
    Return the article ID.
    
    Specified by:
    
    getID in interface org.docgene.model.globals.RootElement
    
    Returns:
    
    the article ID
  - getNotes
```
default java.util.List<NoteContent> getNotes()
```
    Return the notes. Return null by default.
    
    Returns:
    
    null
  - hasNotes
```
default boolean hasNotes()
```
    Return true if the article has notes.
    
    Returns:
    
    true if the article has notes
  - getCategories
```
java.util.Set<java.lang.String> getCategories()
```
    Return the categories on which this article belongs.
    
    Returns:
    
    the categories on which this article belongs
  - isValid
```
default boolean isValid()
```
    Return true if the article is valid. Return true by default.
    
    Returns:
    
    true.
  - getRootElementType
```
default short getRootElementType()
```
    Return the RootElement.ARTICLE type.
    
    Specified by:
    
    getRootElementType in interface org.docgene.model.globals.RootElement
    
    Returns:
    
    the element type

Interface Article

Field Summary

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

Method Summary

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

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

Field Detail

TYPE_INDEX

TYPE_ARTICLE

TYPE_DISAMB

TYPE_REDIRECT

TYPE_TEMPLATE

TYPE_RAW_HTML

TYPE_FALLBACK

INDEX

INDEX_LC

Method Detail

getArticleType

setArticleNameAlreadyTaken

articleNameAlreadyTaken

hasCondition

getPackage

isKeepingCase

getHeader

getHeader

hasID

getSuffix

hasSuffix

setSuffix

hasTOC

setImages

hasAlternateTitles

addAlternateTitle

getAlternateTitles

getAlternateTitlesMap

getNormalizedAlternateTitles

hasSearchableTitles

getMaps

isRawHTMLArticle

hasMaps

hasImageMaps

hasImages

getArticle

getMeta

isTemplate

isDirect

isDirectXMLArticle

isIndex

setID

setRoot

setDescription

getDescription

getRef

getReferences

addReference

getTitle

getID

getNotes

hasNotes

getCategories

isValid

getRootElementType