org.docgene.model

Interface TitledElement

All Superinterfaces:

AnchorElement, TitleOrIncludeElement

All Known Implementing Classes:

XMLChapter, XMLTitle

public interface TitledElement
extends AnchorElement, TitleOrIncludeElement

Represent a titled element (chapter of title).

Method Summary

Modifier and Type	Method and Description
int	getLevel() Return the titled element level.
java.lang.String	getSeq() Return the titled element sequence id.
java.lang.String	getTitle() Return the title.
default java.lang.String	getTitleWithSequence() Return the title, possibly associated with the title forced sequence.
boolean	hasSeq() Return true if the titled element has a forced sequence id.
boolean	isDuplicate() Return true if the title element is a duplicate of another existing titl e.
boolean	isKeepingCase() Return trur if the TitledElement 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 title element is searchable.
default boolean	isSeeAlso() Return true if the TitledElement correspond to a See Also title.
default void	setLevel(int level) Set the title level.
void	setResolved() Set the titled element as being resolved.
void	setSeq(java.lang.String seq) Set the titled element sequence id.
void	setTitle(java.lang.String title) Set the title.

Methods inherited from interface org.docgene.model.AnchorElement

getID, setID

Method Detail

setTitle

void setTitle(java.lang.String title)

Set the title.

Parameters:

title - the title

getTitle

java.lang.String getTitle()

Return the title.

Specified by:

getTitle in interface AnchorElement

Returns:

the title

getTitleWithSequence

default java.lang.String getTitleWithSequence()

Return the title, possibly associated with the title forced sequence.

Returns:

the title and possibly the sequence

setSeq

void setSeq(java.lang.String seq)

Set the titled element sequence id.

Parameters:

seq - the sequence id

hasSeq

boolean hasSeq()

Return true if the titled element has a forced sequence id.

Returns:

true if the titled element has a forced sequence id

getSeq

java.lang.String getSeq()

Return the titled element sequence id.

Returns:

seq the sequence id

getLevel

int getLevel()

Return the titled element level.

Returns:

the titled element level.

setLevel

default void setLevel(int level)

Set the title level. Do nothing by default

Parameters:

level - the title level

isSeeAlso

default boolean isSeeAlso()

Return true if the TitledElement correspond to a See Also title. Return false by default.

Returns:

true if the TitledElement correspond to a See Also title

isKeepingCase

boolean isKeepingCase()

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

Returns:

true if the TitledElement description should keep the title description case

setResolved

void setResolved()

Set the titled element as being resolved.

isResolved

boolean isResolved()

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

Returns:

true if the title element has having been already resolved

isDuplicate

boolean isDuplicate()

Return true if the title element is a duplicate of another existing titl e.

Returns:

true if the title element is a duplicate of another existing title

isSearchable

boolean isSearchable()

Return true if the title element is searchable.

Returns:

true if the title element is searchable