EDIT

/**

* Copyright (C) 2007 EDIT

* European Distributed Institute of Taxonomy 

* http://www.e-taxonomy.eu

* 

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.cdm.model.reference;

import javax.persistence.Entity;

import javax.persistence.Transient;

import javax.xml.bind.annotation.XmlAccessType;

import javax.xml.bind.annotation.XmlAccessorType;

import javax.xml.bind.annotation.XmlRootElement;

import javax.xml.bind.annotation.XmlType;

import org.apache.log4j.Logger;

import org.hibernate.envers.Audited;

import org.hibernate.search.annotations.Indexed;

import org.springframework.beans.factory.annotation.Configurable;

import eu.etaxonomy.cdm.model.agent.TeamOrPersonBase;

import eu.etaxonomy.cdm.model.common.CdmBase;

import eu.etaxonomy.cdm.model.common.TimePeriod;

import eu.etaxonomy.cdm.strategy.cache.reference.BookSectionDefaultCacheStrategy;

import eu.etaxonomy.cdm.strategy.cache.reference.INomenclaturalReferenceCacheStrategy;

/**

 * This class represents isolated sections (parts or chapters) within a {@link Book book}.

 * <P>

 * This class corresponds, according to the TDWG ontology, to the publication type

 * term (from PublicationTypeTerm): "BookSection".

 *   

 * @author m.doering

 * @version 1.0

 * @created 08-Nov-2007 13:06:14

 */

@XmlAccessorType(XmlAccessType.FIELD)

@XmlType(name = "BookSection", propOrder = {

//    "inBook"

})

@XmlRootElement(name = "BookSection")

@Entity

@Indexed(index = "eu.etaxonomy.cdm.model.reference.ReferenceBase")

@Audited

@Configurable

public class BookSection extends SectionBase<INomenclaturalReferenceCacheStrategy<BookSection>> implements INomenclaturalReference, Cloneable {

	private static final long serialVersionUID = -1066199749700092670L;

	private static final Logger logger = Logger.getLogger(BookSection.class);

//    @XmlElement(name = "InBook")

//    @XmlIDREF

//    @XmlSchemaType(name = "IDREF")

//    @ManyToOne(fetch = FetchType.LAZY)

//    @IndexedEmbedded

//    @Cascade(CascadeType.SAVE_UPDATE)

//	private Book inBook;

//    @XmlTransient

//    @Transient

//	private NomenclaturalReferenceHelper nomRefBase = NomenclaturalReferenceHelper.NewInstance(this);

	/** 

	 * Class constructor: creates a new empty book section instance only containing the

	 * {@link eu.etaxonomy.cdm.strategy.cache.reference.BookSectionDefaultCacheStrategy default cache strategy}.

	 * 

	 * @see eu.etaxonomy.cdm.strategy.cache.reference.BookSectionDefaultCacheStrategy

	 */

	protected BookSection(){

		super();

		this.type = ReferenceType.BookSection;

		this.cacheStrategy = BookSectionDefaultCacheStrategy.NewInstance();

	}

	/** 

	 * Creates a new empty book section instance only containing the

	 * {@link eu.etaxonomy.cdm.strategy.cache.reference.BookSectionDefaultCacheStrategy default cache strategy}.

	 * 

	 * @see #NewInstance(Book, TeamOrPersonBase, String, String)

	 * @see eu.etaxonomy.cdm.strategy.cache.reference.BookSectionDefaultCacheStrategy

	 */

	public static BookSection NewInstance(){

		BookSection result = new BookSection();

		return result;

	}

	/** 

	 * Creates a new book section instance with its given book, title, pages and

	 * author (team) and its {@link eu.etaxonomy.cdm.strategy.cache.reference.BookSectionDefaultCacheStrategy default cache strategy}.

	 * 

	 * @param	inBook			the book <i>this</i> book section belongs to

	 * @param	author			the team or person who wrote <i>this</i> book section

	 * @param	sectionTitle	the string representing the title of <i>this</i>

	 * 							book section

	 * @param	pages			the string representing the pages in the book

	 * 							where <i>this</i> book section can be found  

	 * @see 					#NewInstance()

	 * @see 					eu.etaxonomy.cdm.strategy.cache.reference.BookSectionDefaultCacheStrategy

	 */

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

		BookSection result = new BookSection();

		result.setInBook(inBook);

		result.setTitle(sectionTitle);

		result.setPages(pages);

		result.setAuthorTeam(author);

		return result;

	}

	/**

	 * Returns the {@link Book book} <i>this</i> book section belongs to.

	 * 

	 * @return  the book containing <i>this</i> book section

	 * @see 	Book

	 */

	@Transient

	public Book getInBook(){

		if (inReference == null){

			return null;

		}

		if (! this.inReference.isInstanceOf(Book.class)){

			throw new IllegalStateException("The in-reference of a BookSection may only be of type Book");

		}

		return CdmBase.deproxy(this.inReference,Book.class);

	}

	/**

	 * @see #getInBook()

	 */

	public void setInBook(Book inBook){

		this.inReference = inBook;

	}

	/**

	 * Returns a formatted string containing the entire reference citation,

	 * including authors, title, book authors, book title, pages, corresponding to <i>this</i>

	 * book section.<BR>

	 * This method overrides the generic and inherited getCitation method

	 * from {@link StrictReferenceBase StrictReferenceBase}.

	 * 

	 * @see  #getNomenclaturalCitation(String)

	 * @see  StrictReferenceBase#getCitation()

	 */

//	@Transient

//	@Override

//	public String getCitation(){

//		return nomRefBase.getCitation();

//	}

	/**

	 * Returns a formatted string containing the entire citation used for

	 * nomenclatural purposes based on <i>this</i> book section - including

	 * (abbreviated) book title, book authors, book section title but not its

	 * authors - and on the given details.

	 * 

	 * @param  microReference	the string with the details (generally pages)

	 * 							within t<i>this</i> book section

	 * @return					the formatted string representing the

	 * 							nomenclatural citation

	 * @see  					#getCitation()

	 */

	@Transient

	public String getNomenclaturalCitation(String microReference) {

		if (cacheStrategy == null){

			logger.warn("No CacheStrategy defined for "+ this.getClass() + ": " + this.getUuid());

			return null;

		}else{

			return cacheStrategy.getNomenclaturalCitation(this,microReference);

		}

	}

	 /** 

	  * 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.

	 * 

	 * @see 	StrictReferenceBase#getDatePublished()

	 **/

	 @Transient

	 @Override

	 // This method overrides StrictReferenceBase.getDatePublished() only to have 

	 // a specific Javadoc for BookSection.getDatePublished().

	public TimePeriod getDatePublished(){

		return super.getDatePublished();

	}

	/**

	 * Generates, according to the {@link strategy.cache.reference.BookSectionDefaultCacheStrategy default cache strategy}

	 * assigned to <i>this</i> book section, a string that identifies <i>this</i>

	 * book section and returns it. This string may be stored in the inherited

	 * {@link common.IdentifiableEntity#getTitleCache() titleCache} attribute.<BR>

	 * This method overrides the generic and inherited generateTitle method

	 * from {@link ReferenceBase ReferenceBase}.

	 *

	 * @return  the string identifying <i>this</i> book section

	 * @see  	#getCitation()

	 * @see  	eu.etaxonomy.cdm.model.common.IdentifiableEntity#getTitleCache()

	 * @see  	eu.etaxonomy.cdm.model.common.IdentifiableEntity#generateTitle()

	 */

//	@Override

//	public String generateTitle(){

//		return nomRefBase.generateTitle();

//	}

	/** 

	 * Clones <i>this</i> book section. This is a shortcut that enables to

	 * create a new instance that differs only slightly from <i>this</i> book

	 * section by modifying only some of the attributes.<BR>

	 * This method overrides the clone method from {@link StrictReferenceBase StrictReferenceBase}.

	 * 

	 * @see StrictReferenceBase#clone()

	 * @see eu.etaxonomy.cdm.model.media.IdentifiableMediaEntity#clone()

	 * @see java.lang.Object#clone()

	 */

	@Override

	public Object clone(){

		BookSection result = (BookSection)super.clone();

		result.cacheStrategy = BookSectionDefaultCacheStrategy.NewInstance();

		//no changes to: inBook

		return result;

	}

}