org.docgene.model

Class XMLIndex

java.lang.Object

org.docgene.model.AbstractXMLParent

org.docgene.model.AbstractXMLParentArticle

org.docgene.model.XMLArticle

org.docgene.model.XMLIndex

All Implemented Interfaces:

java.lang.Comparable<org.docgene.model.Article>, org.docgene.model.Article, org.docgene.model.globals.PackagedElement, org.docgene.model.globals.RootElement, org.docgene.model.globals.XMLRootElement, org.docgene.model.HTMLOutput, XMLParent, XMLParentArticle

public class XMLIndex
extends XMLArticle

Represents an XML index article.

Since:

1.6.7

Field Summary

Fields inherited from class org.docgene.model.XMLArticle

desc, id

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
XMLIndex() Constructor.
XMLIndex(boolean isConcurrent) Constructor.

Method Summary

Modifier and Type	Method and Description
short	getArticleType() Return the article type.
java.lang.String	getReferTo() Return the article id on which the index is referring to.
XMLParentArticle	getReferToArticle() Set the article on which the index is referring to.
boolean	isGlobalIndex() Return true if the index is the global index.
boolean	isIndex() Return true.
boolean	isReferingTo() Return true if the index is refering to an article.
void	setDescription(java.lang.String id, java.lang.String desc, boolean keepCase) Do nothing.
void	setGlobalIndex(boolean isGlobalIndex) Set if the index is the global index.
void	setReferTo(java.lang.String referTo) Set the article id on which the index is referring to.
void	setReferTo(XMLParentArticle referToArticle) Set the article on which the index is referring to.

Methods inherited from class org.docgene.model.XMLArticle

addAlternateTitle, addAnchor, addCategory, addChapter, addChapter, addComment, addInclude, addInfobox, addMap, addMessageBox, addNote, addResolvedChapter, addResolvedTitle, addSeeAlsoReference, addTitle, addTitle, addTodo, articleNameAlreadyTaken, compareTo, countSortableTables, countTitles, equals, getAlternateTitles, getAlternateTitlesMap, getAnchor, getAnchorElements, getAnchors, getArticle, getArticleRef, getCategories, getDescription, getHeader, getHeader, getID, getIncludes, getInfoboxes, getInputFile, getJustification, getLinksFromFile, getMaps, getMessageBoxes, getMeta, getNote, getNotes, getNotesByID, getOutputFile, getPackage, getParent, getRelativePath, getReviewElements, getSearchableTitles, getSeeAlso, getSeeAlsoHeading, getSuffix, getSyntaxType, getTitledElementsList, getTitlesOrIncludes, hasAnchor, hasAnchorElement, hasAnchors, hashCode, hasID, hasImageMaps, hasIncludes, hasInfoboxes, hasMaps, hasMessageBoxes, hasNote, hasPackage, hasReviewElements, hasSearchableTitles, hasTitledElementsList, hasTitles, hasTOC, incrementSortableTables, isDirect, isKeepingCase, isNotesTwoColumns, isTemplate, isTitlesResolved, isXMLArticle, resolveTitles, setArticleNameAlreadyTaken, setCategories, setHasImageMaps, setID, setInputFile, setJustification, setKeepCase, setLinksFromFile, setMeta, setNotesTwoColumns, setOutputFile, setPackage, setRelativePath, setSeeAlsoHeading, setSuffix, setSyntaxType, setTemplate, setTitledElementsList, setTOC, 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

addParagraph, getChapters, getParagraphs, isEmpty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.docgene.model.XMLParentArticle

hasNotes

Methods inherited from interface org.docgene.model.Article

getNormalizedAlternateTitles, getRef, getRootElementType, getTitle, hasAlternateTitles, hasSuffix, isDirectXMLArticle, isRawHTMLArticle, isValid

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

getAbsolutePath, hasInputFile, isParsable

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

hasRoot, isArticle, isFallback, notExistingInputFile

Methods inherited from interface org.docgene.model.XMLParent

addParagraph, getChapters, getParagraphs, isEmpty

Methods inherited from interface org.docgene.model.HTMLOutput

hasOutputFile

Constructor Detail

XMLIndex

public XMLIndex()

Constructor.

XMLIndex

public XMLIndex(boolean isConcurrent)

Constructor.

Parameters:

isConcurrent - true for concurrent parsing

Method Detail

setGlobalIndex

public void setGlobalIndex(boolean isGlobalIndex)

Set if the index is the global index.

Parameters:

isGlobalIndex - true if the index is the global index

isGlobalIndex

public boolean isGlobalIndex()

Return true if the index is the global index.

Returns:

true if the index is the global index

getArticleType

public short getArticleType()

Return the article type.

Specified by:

getArticleType in interface org.docgene.model.Article

Overrides:

getArticleType in class XMLArticle

Returns:

the article type

setDescription

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

Do nothing.

Specified by:

setDescription in interface org.docgene.model.Article

Overrides:

setDescription in class XMLArticle

Parameters:

id - the article id

desc - the article description

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

isIndex

public boolean isIndex()

Return true.

Specified by:

isIndex in interface org.docgene.model.Article

Overrides:

isIndex in class XMLArticle

Returns:

true

setReferTo

public void setReferTo(java.lang.String referTo)

Set the article id on which the index is referring to.

Parameters:

referTo - the article id

getReferTo

public java.lang.String getReferTo()

Return the article id on which the index is referring to.

Returns:

referTo the article id

setReferTo

public void setReferTo(XMLParentArticle referToArticle)

Set the article on which the index is referring to.

Parameters:

referToArticle - the article

getReferToArticle

public XMLParentArticle getReferToArticle()

Set the article on which the index is referring to.

Returns:

referTo the article id

isReferingTo

public boolean isReferingTo()

Return true if the index is refering to an article.

Returns:

true if the index is refering to an article