org.docgene.model

Class XMLChapter

java.lang.Object

org.docgene.model.AbstractXMLParent

org.docgene.model.XMLChapter

All Implemented Interfaces:

AnchorElement, JustifiedElement, ParagraphElement, ParagraphElementParent, StyledElement, TitledElement, TitleOrIncludeElement, XMLParent

public class XMLChapter
extends AbstractXMLParent
implements ParagraphElementParent, ParagraphElement, TitledElement, JustifiedElement

Represents a chapter.

Field Summary

Fields inherited from class org.docgene.model.AbstractXMLParent

chapters, paragraphs

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Fields inherited from interface org.docgene.model.JustifiedElement

ALIGNMENT_CENTER, ALIGNMENT_INHERIT, ALIGNMENT_JUSTIFIED, ALIGNMENT_LEFT, ALIGNMENT_NONE, ALIGNMENT_RIGHT, JUSTIFIED_AUTO, JUSTIFIED_CHARACTER, JUSTIFIED_INHERIT, JUSTIFIED_NONE, JUSTIFIED_WORD

Constructor Summary

Constructors

Constructor and Description
XMLChapter(XMLParent parent, java.lang.String title, boolean keepCase) Constructor.
XMLChapter(XMLParent parent, java.lang.String title, java.lang.String id, boolean keepCase) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addElement(ParagraphElement element) Add an element.
void	addParagraph(AbstractParagraph par) Add a paragraph.
char	getAlignment() Return the alignment of the element.
java.util.Set<java.lang.String>	getCustomStyles() Return the element custom classes.
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.util.List<ParagraphElement>	getElements() Return the list of elements.
java.lang.String	getID() Return the chapter id.
char	getJustification() Return the justification of the element.
int	getLevel() Return the chapter level.
XMLParent	getParent() Return the chapter parent.
java.lang.String	getSeq() Return the title sequence id.
java.lang.String	getTitle() Return the chapter title.
boolean	hasSeq() Return true if the title has a forced sequence id.
boolean	isDuplicate() Return true if the chapter is a duplicate of another existing title.
boolean	isKeepingCase() Return trur if the chapter description should keep the title description case.
boolean	isResolved() Return true if the title element has having been already resolved.
boolean	isSearchable() Return true if the chapter title is searchable.
void	removeLastElement() Remove the last element.
void	setAlignment(char alignment) Set the alignment of the element.
void	setCustomStyles(java.util.Set<java.lang.String> classes) Set the element custom classes.
void	setDuplicate(boolean isDuplicate) Set if the chapter is a duplicate of another existing title.
void	setElements(java.util.List<ParagraphElement> elements) Set the list of elements.
void	setID(java.lang.String id) Set the chapter id.
void	setJustification(char justification) Set the justification of the element.
void	setKeepCase(boolean keepCase) Set if the chapter description should keep the title description case.
void	setResolved() Set the titled element as being resolved.
void	setSearchable(boolean isSearchable) Set if the chapter title is searchable
void	setSeq(java.lang.String seq) Set the title sequence id.
void	setTitle(java.lang.String title) Set the title.

Methods inherited from class org.docgene.model.AbstractXMLParent

addChapter, getChapters, getParagraphs, isEmpty

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.ParagraphElementParent

countElements, getElement, getFirstElement, getLastElement, hasElements, isEmpty

Methods inherited from interface org.docgene.model.StyledElement

getInlinedStyle, getStyle, hasInlinedStyle, setCustomStyles, setInlinedStyle

Methods inherited from interface org.docgene.model.TitledElement

getTitleWithSequence, isSeeAlso, setLevel

Constructor Detail

XMLChapter

public XMLChapter(XMLParent parent,
                  java.lang.String title,
                  boolean keepCase)

Constructor.

Parameters:

parent - the parent

title - the chapter title

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

XMLChapter

public XMLChapter(XMLParent parent,
                  java.lang.String title,
                  java.lang.String id,
                  boolean keepCase)

Constructor.

Parameters:

parent - the parent

title - the chapter title

id - the chapter id

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

Method Detail

setSearchable

public void setSearchable(boolean isSearchable)

Set if the chapter title is searchable

Parameters:

isSearchable - true if the chapter title is searchable

isSearchable

public boolean isSearchable()

Return true if the chapter title is searchable.

Specified by:

isSearchable in interface TitledElement

Returns:

true if the chapter title is searchable

setDuplicate

public void setDuplicate(boolean isDuplicate)

Set if the chapter is a duplicate of another existing title.

Parameters:

isDuplicate - true if the chapter is a duplicate of another existing title

isDuplicate

public boolean isDuplicate()

Return true if the chapter is a duplicate of another existing title.

Specified by:

isDuplicate in interface TitledElement

Returns:

true if the chapter is a duplicate of another existing title

setElements

public void setElements(java.util.List<ParagraphElement> elements)

Set the list of elements.

Specified by:

setElements in interface ParagraphElementParent

Parameters:

elements - the list of elements

addElement

public void addElement(ParagraphElement element)

Add an element.

Specified by:

addElement in interface ParagraphElementParent

Parameters:

element - the element

addParagraph

public void addParagraph(AbstractParagraph par)

Add a paragraph.

Specified by:

addParagraph in interface XMLParent

Overrides:

addParagraph in class AbstractXMLParent

Parameters:

par - the paragraph

getElements

public java.util.List<ParagraphElement> getElements()

Return the list of elements.

Specified by:

getElements in interface ParagraphElementParent

Returns:

the list of elements

removeLastElement

public void removeLastElement()

Remove the last element.

setTitle

public void setTitle(java.lang.String title)

Set the title.

Specified by:

setTitle in interface TitledElement

Parameters:

title - the title

setSeq

public void setSeq(java.lang.String seq)

Set the title sequence id.

Specified by:

setSeq in interface TitledElement

Parameters:

seq - the sequence id

hasSeq

public boolean hasSeq()

Return true if the title has a forced sequence id.

Specified by:

hasSeq in interface TitledElement

Returns:

true if the title has a forced sequence id

getSeq

public java.lang.String getSeq()

Return the title sequence id.

Specified by:

getSeq in interface TitledElement

Returns:

seq the sequence id

getDeclaration

public java.lang.String getDeclaration()

Return the declaration ID of the element.

Specified by:

getDeclaration in interface StyledElement

Returns:

the declaration ID of the element

setAlignment

public void setAlignment(char alignment)

Set the alignment of the element.

Specified by:

setAlignment in interface JustifiedElement

Parameters:

alignment - the alignment type

getAlignment

public char getAlignment()

Return the alignment of the element.

Specified by:

getAlignment in interface JustifiedElement

Returns:

the alignment type

getJustification

public char getJustification()

Return the justification of the element.

Specified by:

getJustification in interface JustifiedElement

Returns:

the justification type

setJustification

public void setJustification(char justification)

Set the justification of the element.

Specified by:

setJustification in interface JustifiedElement

Parameters:

justification - the justification type

setKeepCase

public void setKeepCase(boolean keepCase)

Set if the chapter description should keep the title description case.

Parameters:

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

isKeepingCase

public boolean isKeepingCase()

Return trur if the chapter description should keep the title description case.

Specified by:

isKeepingCase in interface TitledElement

Returns:

true if the chapter description should keep the title description case

setResolved

public void setResolved()

Set the titled element as being resolved.

Specified by:

setResolved in interface TitledElement

isResolved

public boolean isResolved()

Return true if the title element has having been already resolved.

Specified by:

isResolved in interface TitledElement

Returns:

true if the title element has having been already resolved

getParent

public XMLParent getParent()

Return the chapter parent. It can be a XMLArticle or a XMLChapter.

Specified by:

getParent in interface XMLParent

Returns:

the chapter parent

setCustomStyles

public void setCustomStyles(java.util.Set<java.lang.String> classes)

Set the element custom classes.

Specified by:

setCustomStyles in interface StyledElement

Parameters:

classes - the custom element classes

getCustomStyles

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

Return the element custom classes.

Specified by:

getCustomStyles in interface StyledElement

Returns:

the custom classes

getLevel

public int getLevel()

Return the chapter level. Note that the first level is 1.

Specified by:

getLevel in interface TitledElement

Returns:

the level.

setID

public void setID(java.lang.String id)

Set the chapter id.

Specified by:

setID in interface AnchorElement

Parameters:

id - the chapter id

getID

public java.lang.String getID()

Return the chapter id.

Specified by:

getID in interface AnchorElement

Returns:

the chapter id

getTitle

public java.lang.String getTitle()

Return the chapter title.

Specified by:

getTitle in interface AnchorElement

Specified by:

getTitle in interface TitledElement

Returns:

the chapter title