org.paneris.bibliomania
Class Chapter

java.lang.Object
  org.melati.poem.transaction.Transactioned
      org.melati.poem.JdbcPersistent
          org.paneris.bibliomania.generated.UnitBase
              org.paneris.bibliomania.Unit
                  org.paneris.bibliomania.generated.ChapterBase
                      org.paneris.bibliomania.Chapter

All Implemented Interfaces:

java.lang.Cloneable, org.melati.admin.AdminSpecialised, org.melati.poem.Persistable, org.melati.poem.Persistent, org.melati.poem.Treeable, Text

public class Chapter
extends ChapterBase
implements Text, org.melati.admin.AdminSpecialised

Nested Class Summary

static class	Chapter.PageBody
class	Chapter.TooManyChaptersException

Nested classes/interfaces inherited from class org.paneris.bibliomania.Unit

Unit.NoSourceDirException

Field Summary

org.melati.poem.Treeable[]	children
static int	ftiTextID_author_limit
static long	ftiTextID_author_mask
static int	ftiTextID_author_shift
static int	ftiTextID_book_limit
static long	ftiTextID_book_mask
static int	ftiTextID_book_shift
static int	ftiTextID_chapter_limit
static int	ftiTextID_section_limit
static long	ftiTextID_section_mask
static int	ftiTextID_section_shift
static long	ftiTextID_sequence_mask
static int	ftiTextID_sequence_shift

Fields inherited from class org.paneris.bibliomania.generated.ChapterBase

book, filename, id, indexdate, longtitle, part, sequence, textid, title

Fields inherited from class org.paneris.bibliomania.generated.UnitBase

deleted, lastencached, layout, messageboard, path

Fields inherited from class org.melati.poem.transaction.Transactioned

valid

Constructor Summary

Chapter()

Method Summary

java.lang.String	adminHandle(org.melati.Melati melati, org.melati.template.MarkupLanguage markupLanguage)
java.lang.String	adminSpecialFacilities(org.melati.Melati melatiContext, org.melati.template.MarkupLanguage markupLanguage)
java.io.File	allPagedFile()
void	appendCacheSubpath(java.lang.StringBuffer buffer)
java.io.InputStream	body()
java.io.InputStream	bodyForFragment()
java.lang.String	bodyText()
Chapter.PageBody	bodyTextOfPage(java.lang.Integer pageP)
Chapter.PageBody	bodyTextOfPage(Pagination.PageSpan span)
java.io.InputStream	bodyUnsafe()
void	delete_unsafe_butCleanFTI()
void	delete(java.util.Map integrityFixOfColumn)
void	encache()
long	ftiTextID_limit()
long	ftiTextID_start()
long	ftiTextID()
static long	ftiTextID(int section, int author, int book, int seq)
Advert	getAdvert()
java.lang.String	getCachePath(int pageP)
org.melati.poem.Treeable[]	getChildren()
java.lang.String	getDisplayName()
java.lang.String	getFilepath()
Layout	getLayout() Retrieves the Layout object referred to.
java.lang.String	getLongTitle()
java.util.Enumeration	getMembersSlowly()
java.lang.String	getMetatag_description()
java.lang.String	getMetatag_keywords()
java.lang.String	getName()
Chapter	getNext()
int	getNextPageNumber()
int	getPageNumber()
java.lang.Boolean	getPaginated()
Unit	getParentUnit()
Chapter	getPrevious()
int	getPreviousPageNumber()
java.util.Enumeration	getProductAssociations()
SectionGroup	getReadArea()
void	index()
java.io.InputStream	originalBody()
java.io.File	originalBodyFile()
java.util.Enumeration	pageNumbers()
java.lang.Integer	pageOfAnchor(java.lang.String anchor)
void	paginate() Completely overrides Unit.encache
void	setBook(Book book) Set the Book.
void	setFilepath(java.lang.String path, java.lang.String filename)
void	setSequence(java.lang.Integer sequence) Sets the Sequence value, with checking, for this Chapter Persistent.
Pagination.PageSpan	spanOfPage(int pageP)
Pagination.PageSpan	spanOfPage(java.lang.Integer pageP)
void	splitOutPages()
int	totalPages()
void	unIndex()

Methods inherited from class org.paneris.bibliomania.generated.ChapterBase

getBibliomaniaDatabaseTables, getBook_unsafe, getBook, getBookField, getBookTroid, getChapterTable, getFilename_unsafe, getFilename, getFilenameField, getId_unsafe, getId, getIdField, getIndexdate_unsafe, getIndexdate, getIndexdateField, getLongtitle_unsafe, getLongtitle, getLongtitleField, getPart_unsafe, getPart, getPartField, getSequence_unsafe, getSequence, getSequenceField, getTextid_unsafe, getTextid, getTextidField, getTitle_unsafe, getTitle, getTitleField, setBook_unsafe, setBookTroid, setFilename_unsafe, setFilename, setId_unsafe, setId, setId, setIndexdate_unsafe, setIndexdate, setLongtitle_unsafe, setLongtitle, setPart_unsafe, setPart, setSequence_unsafe, setSequence, setTextid_unsafe, setTextid, setTextid, setTitle_unsafe, setTitle

Methods inherited from class org.paneris.bibliomania.Unit

appendCachePath, getAncestors, getBibliomaniaDatabase, getBoardName, getCachePath, getProductAssociations, getRelatedProducts, getURLSubpath, getURLSubpathReally, getWMTemplet, readKeyDotTxt, speciallyTreatedInCache, writeLock

Methods inherited from class org.paneris.bibliomania.generated.UnitBase

getDeleted_unsafe, getDeleted, getDeletedField, getLastencached_unsafe, getLastencached, getLastencachedField, getLayout_unsafe, getLayoutField, getLayoutTroid, getMessageboard_unsafe, getMessageboard, getMessageboardField, getMessageboardTroid, getPath_unsafe, getPath, getPathField, getUnitTable, setDeleted_unsafe, setDeleted, setDeleted, setLastencached_unsafe, setLastencached, setLayout_unsafe, setLayout, setLayoutTroid, setMessageboard_unsafe, setMessageboard, setMessageboardTroid, setPath_unsafe, setPath

Methods inherited from class org.melati.poem.JdbcPersistent

assertCanCreate, assertCanCreate, assertCanDelete, assertCanDelete, assertCanRead, assertCanRead, assertCanWrite, assertCanWrite, clone, commit, countMatchSQL, delete_unsafe, delete, deleteAndCommit, deleteAndCommit, deleteLock, displayString, displayString, displayString, dump, dump, duplicated, duplicatedFloating, equals, existenceLock, existenceLock, fieldsOfColumns, fromClause, getCanDelete, getCanRead, getCanSelect, getCanWrite, getCooked, getCookedString, getDatabase, getDetailDisplayFields, getField, getFields, getPrimaryDisplayField, getRaw, getRawString, getReadable, getRecordDisplayFields, getSearchCriterionFields, getSummaryDisplayFields, getTable, getTroid, hashCode, invalidate, isDirty, load, makePersistent, postEdit, postInsert, postModify, postWrite, preEdit, readLock, readLock, readLock, rollback, setCooked, setDirty, setRaw, setRawString, statusExistent, statusNonexistent, toString, troid, upToDate, writeDown, writeLock, writeLock

Methods inherited from class org.melati.poem.transaction.Transactioned

markValid, reset, setTransactionPool, transactionPool, unSee

Methods inherited from class java.lang.Object

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

Field Detail

ftiTextID_section_shift

public static final int ftiTextID_section_shift

See Also:

Constant Field Values

ftiTextID_section_limit

public static final int ftiTextID_section_limit

See Also:

Constant Field Values

ftiTextID_author_shift

public static final int ftiTextID_author_shift

See Also:

Constant Field Values

ftiTextID_author_limit

public static final int ftiTextID_author_limit

See Also:

Constant Field Values

ftiTextID_book_shift

public static final int ftiTextID_book_shift

See Also:

Constant Field Values

ftiTextID_book_limit

public static final int ftiTextID_book_limit

See Also:

Constant Field Values

ftiTextID_sequence_shift

public static final int ftiTextID_sequence_shift

See Also:

Constant Field Values

ftiTextID_chapter_limit

public static final int ftiTextID_chapter_limit

See Also:

Constant Field Values

ftiTextID_section_mask

public static final long ftiTextID_section_mask

See Also:

Constant Field Values

ftiTextID_author_mask

public static final long ftiTextID_author_mask

See Also:

Constant Field Values

ftiTextID_book_mask

public static final long ftiTextID_book_mask

See Also:

Constant Field Values

ftiTextID_sequence_mask

public static final long ftiTextID_sequence_mask

See Also:

Constant Field Values

children

public org.melati.poem.Treeable[] children

Constructor Detail

Chapter

public Chapter()

Method Detail

getPageNumber

public int getPageNumber()

getPreviousPageNumber

public int getPreviousPageNumber()

getNextPageNumber

public int getNextPageNumber()

getPrevious

public Chapter getPrevious()

getNext

public Chapter getNext()

getAdvert

public Advert getAdvert()

getLayout

public Layout getLayout()

Description copied from class: UnitBase

Retrieves the Layout object referred to.

Overrides:

getLayout in class UnitBase

Returns:

the Layout as a Layout

getPaginated

public java.lang.Boolean getPaginated()

getFilepath

public java.lang.String getFilepath()

setFilepath

public void setFilepath(java.lang.String path,
                        java.lang.String filename)

originalBodyFile

public java.io.File originalBodyFile()

originalBody

public java.io.InputStream originalBody()
                                 throws java.io.IOException

Throws:

java.io.IOException

appendCacheSubpath

public void appendCacheSubpath(java.lang.StringBuffer buffer)

Specified by:

appendCacheSubpath in class Unit

getCachePath

public java.lang.String getCachePath(int pageP)

allPagedFile

public java.io.File allPagedFile()

bodyUnsafe

public java.io.InputStream bodyUnsafe()
                               throws java.io.IOException

Throws:

java.io.IOException

body

public java.io.InputStream body()
                         throws java.io.IOException

Specified by:

body in interface Text

Throws:

java.io.IOException

bodyForFragment

public java.io.InputStream bodyForFragment()
                                    throws java.io.IOException

Specified by:

bodyForFragment in interface Text

Throws:

java.io.IOException

bodyText

public java.lang.String bodyText()
                          throws java.io.IOException

Throws:

java.io.IOException

ftiTextID

public static long ftiTextID(int section,
                             int author,
                             int book,
                             int seq)

ftiTextID

public long ftiTextID()

Specified by:

ftiTextID in interface Text

ftiTextID_start

public long ftiTextID_start()

Specified by:

ftiTextID_start in class Unit

ftiTextID_limit

public long ftiTextID_limit()

Specified by:

ftiTextID_limit in class Unit

getParentUnit

public Unit getParentUnit()

Specified by:

getParentUnit in class Unit

setBook

public void setBook(Book book)
             throws org.melati.poem.AccessPoemException

Description copied from class: ChapterBase

Set the Book.

Overrides:

setBook in class ChapterBase

Parameters:

book - a validated Book

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

setSequence

public void setSequence(java.lang.Integer sequence)
                 throws org.melati.poem.AccessPoemException

Description copied from class: ChapterBase

Sets the Sequence value, with checking, for this Chapter Persistent. Field description: The number of the chapter

Overrides:

setSequence in class ChapterBase

Parameters:

sequence - a validated int

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

bodyTextOfPage

public Chapter.PageBody bodyTextOfPage(Pagination.PageSpan span)
                                throws java.io.IOException

Throws:

java.io.IOException

spanOfPage

public Pagination.PageSpan spanOfPage(int pageP)

spanOfPage

public Pagination.PageSpan spanOfPage(java.lang.Integer pageP)

bodyTextOfPage

public Chapter.PageBody bodyTextOfPage(java.lang.Integer pageP)
                                throws java.io.IOException

Throws:

java.io.IOException

totalPages

public int totalPages()

pageNumbers

public java.util.Enumeration pageNumbers()

getMembersSlowly

public java.util.Enumeration getMembersSlowly()

Specified by:

getMembersSlowly in class Unit

getDisplayName

public java.lang.String getDisplayName()

Specified by:

getDisplayName in class Unit

index

public void index()
           throws java.io.IOException

Overrides:

index in class Unit

Throws:

java.io.IOException

unIndex

public void unIndex()

delete_unsafe_butCleanFTI

public void delete_unsafe_butCleanFTI()

delete

public void delete(java.util.Map integrityFixOfColumn)

Specified by:

delete in interface org.melati.poem.Persistent

Overrides:

delete in class org.melati.poem.JdbcPersistent

splitOutPages

public void splitOutPages()
                   throws org.webmacro.WebMacroException,
                          java.io.IOException

Throws:

org.webmacro.WebMacroException

java.io.IOException

paginate

public void paginate()
              throws java.lang.Exception

Completely overrides Unit.encache

Overrides:

paginate in class Unit

Throws:

java.lang.Exception

encache

public void encache()
             throws java.lang.Exception

Overrides:

encache in class Unit

Throws:

java.lang.Exception

getMetatag_description

public java.lang.String getMetatag_description()

Specified by:

getMetatag_description in class Unit

getMetatag_keywords

public java.lang.String getMetatag_keywords()

Specified by:

getMetatag_keywords in class Unit

getLongTitle

public java.lang.String getLongTitle()

pageOfAnchor

public java.lang.Integer pageOfAnchor(java.lang.String anchor)

adminHandle

public java.lang.String adminHandle(org.melati.Melati melati,
                                    org.melati.template.MarkupLanguage markupLanguage)
                             throws java.lang.Exception

Specified by:

adminHandle in interface org.melati.admin.AdminSpecialised

Throws:

java.lang.Exception

adminSpecialFacilities

public java.lang.String adminSpecialFacilities(org.melati.Melati melatiContext,
                                               org.melati.template.MarkupLanguage markupLanguage)
                                        throws java.lang.Exception

Specified by:

adminSpecialFacilities in interface org.melati.admin.AdminSpecialised

Throws:

java.lang.Exception

getReadArea

public SectionGroup getReadArea()

Specified by:

getReadArea in class Unit

getProductAssociations

public java.util.Enumeration getProductAssociations()

Specified by:

getProductAssociations in class Unit

getChildren

public org.melati.poem.Treeable[] getChildren()

Specified by:

getChildren in interface org.melati.poem.Treeable

Overrides:

getChildren in class org.melati.poem.JdbcPersistent

getName

public java.lang.String getName()

Specified by:

getName in interface org.melati.poem.Treeable

Specified by:

getName in class Unit