org.docgene.model

Interface NoteContent

All Known Implementing Classes:

XMLBasicNote, XMLCitation

public interface NoteContent

Represents the content of a "note" or "noteRef" element.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getID() Return the node ID.
int	getIndex() Return the node index.
java.util.List<XMLNoteRef>	getNoteReferences() Return the list of note references which refer to this note.
default java.lang.String	getRef() Return the node reference composed using the node index.
boolean	hasID() Return true if the node has an ID.
void	setIndex(int index) Set the node index.

Method Detail

hasID

boolean hasID()

Return true if the node has an ID.

Returns:

true if the node has an ID

getID

java.lang.String getID()

Return the node ID.

Returns:

the node ID

setIndex

void setIndex(int index)

Set the node index.

Parameters:

index - the node index

getIndex

int getIndex()

Return the node index.

Returns:

the node index

getRef

default java.lang.String getRef()

Return the node reference composed using the node index.

Returns:

the node reference

getNoteReferences

java.util.List<XMLNoteRef> getNoteReferences()

Return the list of note references which refer to this note.

Returns:

the list of note references