org.docgene.model

Class XMLFallbackArticle

java.lang.Object

org.docgene.model.AbstractXMLParent

org.docgene.model.AbstractXMLParentArticle

org.docgene.model.XMLFallbackArticle

All Implemented Interfaces:

Article, FallbackArticleType, org.docgene.model.globals.PackagedElement, org.docgene.model.globals.RootElement, org.docgene.model.globals.XMLRootElement, HTMLOutput, XMLParent, XMLParentArticle

public class XMLFallbackArticle
extends AbstractXMLParentArticle
implements FallbackArticleType

Represents a fallback article.

Field Summary

Fields inherited from class org.docgene.model.AbstractXMLParent

chapters, paragraphs

Fields inherited from interface org.docgene.model.FallbackArticleType

FALLBACK_INVALID, FALLBACK_NOTINCLUDED

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
XMLFallbackArticle(char type) Constructor.
XMLFallbackArticle(char type, java.lang.String title) Constructor.

Method Summary

Modifier and Type	Method and Description
XMLParentArticle	getArticle() Return this.
short	getArticleType() Return the article type.
java.util.Set<java.lang.String>	getCategories() Return null.
java.lang.String	getDescription() Return the article title.
java.lang.String	getHeader(boolean escaping) Construct the header text for the article.
java.lang.String	getID() Return the article ID.
java.io.File	getInputFile() Return the article input XML file.
java.io.File	getLinksFromFile() Return null.
java.io.File	getOutputFile() Return the article output HTML file.
java.lang.String	getPackage() Return the article package.
XMLParent	getParent() Return null.
char	getType() Return the fallback article type.
boolean	hasID() Return false.
boolean	hasPackage() Return true if the article has a package.
boolean	isFallback() Return true.
boolean	isKeepingCase() Return false.
void	setDescription(java.lang.String id, java.lang.String desc, boolean keepCase) Set the article description.
void	setID(java.lang.String id) Do nothing.
void	setInputFile(java.io.File file) Set the article input XML file.
void	setLinksFromFile(java.io.File file) Do nothing.
void	setOutputFile(java.io.File file) Set the article output XML file.
void	setPackage(java.lang.String pack) Set the package ID of the article.

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, toString, 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, getMeta, getNormalizedAlternateTitles, getRef, getRootElementType, getSuffix, getTitle, hasAlternateTitles, hasImageMaps, hasMaps, hasSearchableTitles, hasSuffix, hasTOC, isDirect, isDirectXMLArticle, isIndex, isRawHTMLArticle, isTemplate, isValid, setArticleNameAlreadyTaken, setSuffix

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

getAbsolutePath, getRelativePath, hasInputFile, isParsable

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

hasRoot, isArticle, notExistingInputFile

Methods inherited from interface org.docgene.model.XMLParent

addChapter, addParagraph, getChapters, getParagraphs

Methods inherited from interface org.docgene.model.HTMLOutput

hasOutputFile

Constructor Detail

XMLFallbackArticle

public XMLFallbackArticle(char type,
                          java.lang.String title)

Constructor.

Parameters:

type - the fallback article type

title - the title

XMLFallbackArticle

public XMLFallbackArticle(char type)

Constructor.

Parameters:

type - the fallback article type

Method Detail

getArticleType

public short getArticleType()

Return the article type.

Specified by:

getArticleType in interface Article

Returns:

the article type

getType

public char getType()

Return the fallback article type.

Returns:

the fallback article type

isFallback

public boolean isFallback()

Return true.

Specified by:

isFallback in interface org.docgene.model.globals.RootElement

Returns:

true

setPackage

public void setPackage(java.lang.String pack)

Set the package ID of the article.

Specified by:

setPackage in interface org.docgene.model.globals.XMLRootElement

Parameters:

pack - the package ID of the article

getPackage

public java.lang.String getPackage()

Return the article package.

Specified by:

getPackage in interface Article

Specified by:

getPackage in interface org.docgene.model.globals.PackagedElement

Specified by:

getPackage in interface org.docgene.model.globals.XMLRootElement

Returns:

the article package

hasPackage

public boolean hasPackage()

Return true if the article has a package.

Specified by:

hasPackage in interface org.docgene.model.globals.PackagedElement

Specified by:

hasPackage in interface org.docgene.model.globals.XMLRootElement

Returns:

true if the article has a package

getArticle

public XMLParentArticle getArticle()

Return this.

Specified by:

getArticle in interface Article

Returns:

this

getHeader

public java.lang.String getHeader(boolean escaping)

Construct the header text for the article.

Specified by:

getHeader in interface Article

Parameters:

escaping - true if the text must be escaped to html content

Returns:

the header text for the article

isKeepingCase

public boolean isKeepingCase()

Return false.

Specified by:

isKeepingCase in interface Article

Returns:

false

setDescription

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

Set the article description.

Specified by:

setDescription in interface Article

Parameters:

id - the article id

desc - the article description

keepCase - true if the article description should keep the title description case

getDescription

public java.lang.String getDescription()

Return the article title.

Specified by:

getDescription in interface Article

Returns:

the article title

setID

public void setID(java.lang.String id)

Do nothing.

Specified by:

setID in interface Article

Parameters:

id - the article id

hasID

public boolean hasID()

Return false.

Specified by:

hasID in interface Article

Returns:

false.

getParent

public XMLParent getParent()

Return null.

Specified by:

getParent in interface XMLParent

Returns:

null

setInputFile

public void setInputFile(java.io.File file)

Set the article input XML file.

Specified by:

setInputFile in interface org.docgene.model.globals.XMLRootElement

Parameters:

file - the article input XML file

getInputFile

public java.io.File getInputFile()

Return the article input XML file.

Specified by:

getInputFile in interface org.docgene.model.globals.RootElement

Returns:

the article input XML file

setOutputFile

public void setOutputFile(java.io.File file)

Set the article output XML file.

Specified by:

setOutputFile in interface XMLParentArticle

Parameters:

file - the article input XML file

getOutputFile

public java.io.File getOutputFile()

Return the article output HTML file.

Specified by:

getOutputFile in interface HTMLOutput

Returns:

the article output HTML file

setLinksFromFile

public void setLinksFromFile(java.io.File file)

Do nothing.

Specified by:

setLinksFromFile in interface XMLParentArticle

Parameters:

file - the article links from XML file

getLinksFromFile

public java.io.File getLinksFromFile()

Return null.

Specified by:

getLinksFromFile in interface XMLParentArticle

Returns:

null

getCategories

public java.util.Set<java.lang.String> getCategories()

Return null.

Specified by:

getCategories in interface Article

Returns:

null

getID

public java.lang.String getID()

Description copied from interface: Article

Return the article ID.

Specified by:

getID in interface Article

Specified by:

getID in interface org.docgene.model.globals.RootElement

Returns:

the article ID