eu.etaxonomy.cdm.model.reference
Class BookSection

java.lang.Object
  eu.etaxonomy.cdm.model.common.CdmBase
      eu.etaxonomy.cdm.model.common.VersionableEntity
          eu.etaxonomy.cdm.model.common.AnnotatableEntity
              eu.etaxonomy.cdm.model.common.IdentifiableEntity<S>
                  eu.etaxonomy.cdm.model.media.IdentifiableMediaEntity<S>
                      eu.etaxonomy.cdm.model.reference.ReferenceBase<S>
                          eu.etaxonomy.cdm.model.reference.SectionBase<INomenclaturalReferenceCacheStrategy<BookSection>>
                              eu.etaxonomy.cdm.model.reference.BookSection

All Implemented Interfaces:

IAnnotatableEntity, ICdmBase, IIdentifiableEntity, IParsable, ISourceable<IdentifiableSource>, IVersionableEntity, IMediaDocumented, IMediaEntity, IArticle, IBook, IBookSection, ICdDvd, IDatabase, IGeneric, IInProceedings, IJournal, INomenclaturalReference, IPatent, IPersonalCommunication, IPrintedUnitBase, IPrintSeries, IProceedings, IPublicationBase, IReferenceBase, IReport, ISectionBase, IThesis, IVolumeReference, IWebPage, IMatchable, IMergable, Serializable, Cloneable

Deprecated.

@Indexed(index="eu.etaxonomy.cdm.model.reference.ReferenceBase")
@Configurable
@Deprecated
public class BookSection
extends SectionBase<INomenclaturalReferenceCacheStrategy<BookSection>>
implements INomenclaturalReference, Cloneable

This class represents isolated sections (parts or chapters) within a book.

This class corresponds, according to the TDWG ontology, to the publication type term (from PublicationTypeTerm): "BookSection".

Version:

1.0

Author:

m.doering

See Also:

Serialized Form

Field Summary

Fields inherited from class eu.etaxonomy.cdm.model.reference.ReferenceBase

edition, editor, inReference, institution, isbn, issn, organization, pages, placePublished, publisher, school, series, seriesPart, type, volume

Fields inherited from class eu.etaxonomy.cdm.model.common.IdentifiableEntity

cacheStrategy, NOT_PROTECTED, PROTECTED, protectedTitleCache, titleCache

Fields inherited from class eu.etaxonomy.cdm.model.common.AnnotatableEntity

annotations, markers

Fields inherited from class eu.etaxonomy.cdm.model.common.CdmBase

uuid

Fields inherited from interface eu.etaxonomy.cdm.model.reference.INomenclaturalReference

MICRO_REFERENCE_TOKEN

Constructor Summary

protected

BookSection() Deprecated. Class constructor: creates a new empty book section instance only containing the default cache strategy.

Method Summary

Object	clone() Deprecated. Clones this book section.
TimePeriod	getDatePublished() Deprecated. If the publication date of a book section and it's inBook do differ this is usually caused by the fact that a book has been published during a period, because originally it consisted of several parts that only later where put together to one book.
Book	getInBook() Deprecated. Returns the book this book section belongs to.
String	getNomenclaturalCitation(String microReference) Deprecated. Returns a formatted string containing the entire citation used for nomenclatural purposes based on this book section - including (abbreviated) book title, book authors, book section title but not its authors - and on the given details.
static BookSection	NewInstance() Deprecated. Creates a new empty book section instance only containing the default cache strategy.
static BookSection	NewInstance(Book inBook, TeamOrPersonBase author, String sectionTitle, String pages) Deprecated. Creates a new book section instance with its given book, title, pages and author (team) and its default cache strategy.
void	setInBook(Book inBook) Deprecated.

Methods inherited from class eu.etaxonomy.cdm.model.reference.SectionBase

getPages, setPages

Methods inherited from class eu.etaxonomy.cdm.model.reference.ReferenceBase

addParsingProblem, castReferenceToArticle, castReferenceToBook, castReferenceToBookSection, castReferenceToCdDvd, castReferenceToDatabase, castReferenceToGeneric, castReferenceToInProceedings, castReferenceToJournal, castReferenceToMap, castReferenceToPatent, castReferenceToPersonalCommunication, castReferenceToPrintSeries, castReferenceToProceedings, castReferenceToReport, castReferenceToThesis, castReferenceToWebPage, generateTitle, getAuthorTeam, getCitation, getEdition, getEditor, getInJournal, getInProceedings, getInReference, getInSeries, getInstitution, getIsbn, getIssn, getOrganization, getParsingProblem, getParsingProblems, getPlacePublished, getProblemEnds, getProblemStarts, getPublisher, getReferenceAbstract, getSchool, getSeries, getSeriesPart, getTitle, getType, getUri, getVolume, getYear, hasProblem, hasProblem, isNomenclaturallyRelevant, isOfType, removeParsingProblem, setAuthorTeam, setCacheStrategy, setCacheStrategy, setCacheStrategy, setCacheStrategy, setCacheStrategy, setCacheStrategy, setCacheStrategy, setDatePublished, setEdition, setEditor, setInBook, setInJournal, setInProceedings, setInReference, setInSeries, setInstitution, setIsbn, setIssn, setNomenclaturallyRelevant, setOrganization, setParsingProblem, setPlacePublished, setProblemEnds, setProblemStarts, setPublisher, setPublisher, setReferenceAbstract, setSchool, setSeries, setSeriesPart, setTitle, setType, setUri, setVolume

Methods inherited from class eu.etaxonomy.cdm.model.media.IdentifiableMediaEntity

addMedia, getMedia, removeMedia

Methods inherited from class eu.etaxonomy.cdm.model.common.IdentifiableEntity

addCredit, addCredit, addExtension, addExtension, addRights, addSource, addSource, compareTo, getCacheStrategy, getCredits, getCredits, getData, getExtensions, getLsid, getRights, getSources, getTitleCache, getTruncatedCache, initListener, isProtectedTitleCache, removeCredit, removeCredit, removeExtension, removeRights, removeSource, setLsid, setProtectedTitleCache, setTitleCache, setTitleCache, toString

Methods inherited from class eu.etaxonomy.cdm.model.common.AnnotatableEntity

addAnnotation, addMarker, getAnnotations, getMarkers, removeAnnotation, removeMarker

Methods inherited from class eu.etaxonomy.cdm.model.common.VersionableEntity

equals, getUpdated, getUpdatedBy, setUpdated, setUpdatedBy

Methods inherited from class eu.etaxonomy.cdm.model.common.CdmBase

addPropertyChangeListener, addPropertyChangeListener, clone, deproxy, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCreated, getCreatedBy, getId, getUuid, hashCode, hasListeners, invokeSetMethod, invokeSetMethodWithNull, isInstanceOf, removePropertyChangeListener, removePropertyChangeListener, setCreated, setCreatedBy, setId, setUuid

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.etaxonomy.cdm.model.reference.INomenclaturalReference

getYear, setDatePublished

Methods inherited from interface eu.etaxonomy.cdm.model.reference.IReferenceBase

getAuthorTeam, getReferenceAbstract, getTitle, getType, getUri, isOfType, setAuthorTeam, setCacheStrategy, setReferenceAbstract, setTitle, setType, setUri

Methods inherited from interface eu.etaxonomy.cdm.model.common.IIdentifiableEntity

addCredit, addCredit, addExtension, addRights, generateTitle, getCredits, getCredits, getData, getExtensions, getLsid, getRights, getTitleCache, isProtectedTitleCache, removeCredit, removeCredit, removeExtension, removeRights, setLsid, setProtectedTitleCache, setTitleCache, setTitleCache, toString

Methods inherited from interface eu.etaxonomy.cdm.model.common.ISourceable

addSource, addSource, getSources, removeSource

Methods inherited from interface eu.etaxonomy.cdm.model.common.IParsable

addParsingProblem, getParsingProblem, getParsingProblems, getProblemEnds, getProblemStarts, hasProblem, hasProblem, removeParsingProblem, setParsingProblem, setProblemEnds, setProblemStarts

Methods inherited from interface eu.etaxonomy.cdm.model.common.ICdmBase

getCreated, getCreatedBy, getId, getUuid, setCreated, setCreatedBy, setId, setUuid

Methods inherited from interface eu.etaxonomy.cdm.model.common.IVersionableEntity

getUpdated, getUpdatedBy, setUpdated, setUpdatedBy

Constructor Detail

BookSection

protected BookSection()

Deprecated.

Class constructor: creates a new empty book section instance only containing the default cache strategy.

See Also:

BookSectionDefaultCacheStrategy

Method Detail

NewInstance

public static BookSection NewInstance()

Deprecated.

Creates a new empty book section instance only containing the default cache strategy.

See Also:

NewInstance(Book, TeamOrPersonBase, String, String), BookSectionDefaultCacheStrategy

NewInstance

public static BookSection NewInstance(Book inBook,
                                      TeamOrPersonBase author,
                                      String sectionTitle,
                                      String pages)

Deprecated.

Creates a new book section instance with its given book, title, pages and author (team) and its default cache strategy.

Parameters:

inBook - the book this book section belongs to

author - the team or person who wrote this book section

sectionTitle - the string representing the title of this book section

pages - the string representing the pages in the book where this book section can be found

See Also:

NewInstance(), BookSectionDefaultCacheStrategy

getInBook

public Book getInBook()

Deprecated.

Returns the book this book section belongs to.

Specified by:

getInBook in interface IBookSection

Overrides:

getInBook in class ReferenceBase<INomenclaturalReferenceCacheStrategy<BookSection>>

Returns:

the book containing this book section

See Also:

Book

setInBook

public void setInBook(Book inBook)

Deprecated.

See Also:

getInBook()

getNomenclaturalCitation

public String getNomenclaturalCitation(String microReference)

Deprecated.

Returns a formatted string containing the entire citation used for nomenclatural purposes based on this book section - including (abbreviated) book title, book authors, book section title but not its authors - and on the given details.

Specified by:

getNomenclaturalCitation in interface INomenclaturalReference

Specified by:

getNomenclaturalCitation in interface IReferenceBase

Overrides:

getNomenclaturalCitation in class ReferenceBase<INomenclaturalReferenceCacheStrategy<BookSection>>

Parameters:

microReference - the string with the details (generally pages) within tthis book section

Returns:

the formatted string representing the nomenclatural citation

See Also:

ReferenceBase.getCitation()

getDatePublished

public TimePeriod getDatePublished()

Deprecated.

If the publication date of a book section and it's inBook do differ this is usually caused by the fact that a book has been published during a period, because originally it consisted of several parts that only later where put together to one book. If so, the book section's publication date may be a point in time (year or month of year) whereas the books publication date may be a period of several years. Therefore a valid nomenclatural reference string should use the book sections publication date rather then the book's publication date.

Specified by:

getDatePublished in interface IReferenceBase

Overrides:

getDatePublished in class ReferenceBase<INomenclaturalReferenceCacheStrategy<BookSection>>

See Also:

StrictReferenceBase#getDatePublished()

clone

public Object clone()

Deprecated.

Clones this book section. This is a shortcut that enables to create a new instance that differs only slightly from this book section by modifying only some of the attributes.
This method overrides the clone method from StrictReferenceBase.

Overrides:

clone in class SectionBase<INomenclaturalReferenceCacheStrategy<BookSection>>

See Also:

StrictReferenceBase#clone(), IdentifiableMediaEntity.clone(), Object.clone()