maiolum
Interface BibleFragment

All Known Subinterfaces:

BibleModule

All Known Implementing Classes:

BibleModuleImpl, PXBibleFragment

public interface BibleFragment

This interface describes a fragment of Scripture text - be it a verse, chapter, book or other textual fragment. This textual fragment should remember its parent (which could be null if needed) and ID (this will be used e. g. as XML identifier)

Method Summary

FragmentData	getData() Returns actual fragment contents, be it normal String, XML Node or other user specified type.
DataSource	getDataSource()
Edition	getEdition() Returns the unit descriptive meta-information (e.g. language, year of issue etc) of this fragment.
FID	getID() Returns a String representing this fragment's identifier.
BibleFragment	getParent() Returns the parent text fragment - typically parent to verse is chapter, parent to chapter is book, which are actually BibleFragments, too.
FragmentType	getType() Returns this fragment“s type - whether it is chapter, book or other user-defined textual unit.
void	setData(FragmentData data)
void	setDataSource(DataSource dataSource)
void	setEdition(Edition edition) Allows to set the appropriate Edition for this fragment.
void	setID(FID id) Sets this fragment's ID to id.
void	setParent(BibleFragment parent) Sets the parent text fragment to parent.
void	setType(FragmentType type) Sets this fragment's type.

Method Detail

getParent

public BibleFragment getParent()

Returns the parent text fragment - typically parent to verse is chapter, parent to chapter is book, which are actually BibleFragments, too. Parent text fragment can be null

setParent

public void setParent(BibleFragment parent)

Sets the parent text fragment to parent.

getType

public FragmentType getType()

Returns this fragment“s type - whether it is chapter, book or other user-defined textual unit.

setType

public void setType(FragmentType type)

Sets this fragment's type.

getID

public FID getID()

Returns a String representing this fragment's identifier. This can be used e. g. as ID attribute in XML.

setID

public void setID(FID id)

Sets this fragment's ID to id. The ID should not be null.

setEdition

public void setEdition(Edition edition)

Allows to set the appropriate Edition for this fragment.

getEdition

public Edition getEdition()

Returns the unit descriptive meta-information (e.g. language, year of issue etc) of this fragment.

getData

public FragmentData getData()

Returns actual fragment contents, be it normal String, XML Node or other user specified type.

setData

public void setData(FragmentData data)

setDataSource

public void setDataSource(DataSource dataSource)

getDataSource

public DataSource getDataSource()