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.Transient;

import eu.etaxonomy.cdm.model.name.HomotypicalGroup;

import eu.etaxonomy.cdm.model.name.Rank;

/**

 * particular {@link StrictReferenceBase reference} subclass. Therefore attributes which are

 * characteristic for a unique reference subclass are not necessary here.

 * <P>

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

 * terms (from PublicationTypeTerm): <ul>

 * <li> "Generic"

 * <li> "Artwork"

 * <li> "AudiovisualMaterial"

 * <li> "ComputerProgram"

 * <li> "Determination"

 * <li> "Commentary"

 * <li> "SubReference"

 * </ul>

 * 

 * @version 1.0

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

 */

@Entity

	private String publisher;

	private String placePublished;

	private String editor;

	private String series;

	private String volume;

	private String pages;

	 * Class constructor: creates a new empty generic reference instance

	 * only containing the {@link strategy.cache.reference.GenericDefaultCacheStrategy default cache strategy}.

	 * 

	 * @see strategy.cache.reference.GenericDefaultCacheStrategy

	 */

		super();

	 * Creates a new empty generic reference instance

	 * only containing the {@link eu.etaxonomy.cdm.strategy.cache.reference.GenericDefaultCacheStrategy default cache strategy}.

	 * 

	 * @see #Generic()

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

	 */

	public static Generic NewInstance(){

		return new Generic();

	}

	/**

	 * Returns the string representing the name of the publisher of <i>this</i>

	 * generic reference. A publisher is mostly an institution or a private

	 * company which assumed the global responsibility for the publication

	 * process.<BR>

	 * If there is a publisher then the generic reference must be some kind of

	 * {@link PublicationBase publication}.

	 * 

	 * @return  the string identifying the publisher of <i>this</i>

	 * 			generic reference

	 * @see 	#getEditor()

	 */

		return this.publisher;

	}

	/**

	public void setPublisher(String publisher){

		this.publisher = publisher;

	}

	 * Returns the string representing the name of the place (mostly the city)

	 * where <i>this</i> generic reference has been published.<BR>

	 * If there is a published place then the generic reference must be some

	 * kind of {@link PublicationBase publication}.

	 * 

	 * @return  the string identifying the publication place of <i>this</i>

	 * 			generic reference

	 */

		return this.placePublished;

	}

	/**

	public void setPlacePublished(String placePublished){

		this.placePublished = placePublished;

	}

	 * Returns the string representing the name of the editor of <i>this</i>

	 * generic reference. An editor is mostly a person (team) who assumed the

	 * responsibility for the content of the publication as a whole without

	 * being the author of this content.<BR>

	 * If there is an editor then the generic reference must be some

	 * kind of {@link PrintedUnitBase physical printed unit}.

	 * 

	 * @return  the string identifying the editor of <i>this</i>

	 * 			generic reference

	 * @see 	#getPublisher()

	 */

		return this.editor;

	}

	/**

	public void setEditor(String editor){

		this.editor = editor;

	}

	 * Returns the string representing the series (for instance for books or

	 * was published.<BR>

	 * kind of {@link PrintedUnitBase physical printed unit} or an {@link Article article}.

	 * 

	 * @return  the string identifying the series for <i>this</i>

	 * 			generic reference

	 */

		return this.series;

	}

	/**

	public void setSeries(String series){

		this.series = series;

	}

	 * Returns the string representing the volume (for instance for books or

	 * within journals) in which <i>this</i> generic reference was published.<BR>

	 * If there is a volume then the generic reference must be some

	 * kind of {@link PrintedUnitBase physical printed unit} or an {@link Article article}.

	 * 

	 * @return  the string identifying the volume for <i>this</i>

	 * 			generic reference

	 */

		return this.volume;

	}

	/**

	public void setVolume(String volume){

		this.volume = volume;

	}

	 * Returns the string representing the page(s) where the content of

	 * <i>this</i> generic reference is located.<BR>

	 * If there is a pages information then the generic reference must be some

	 * kind of {@link PrintedUnitBase physical printed unit} or an {@link Article article}.

	 * 

	 * @return  the string containing the pages corresponding to <i>this</i>

	 * 			generic reference

	 */

		return this.pages;

	}

	/**

	public void setPages(String pages){

		this.pages = pages;

	}

	 * Returns a formatted string containing the entire reference citation,

	 * This method overrides the generic and inherited

	 * StrictReferenceBase#getCitation() method.

	 * @see  NomenclaturalReferenceHelper#getCitation()

	@Transient

	public String getCitation(){

	 * Returns a formatted string containing the entire citation used for

	 * nomenclatural purposes based on <i>this</i> generic reference - including

	 * 

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

	 * 							nomenclatural citation

	 * @see  					NomenclaturalReferenceHelper#getNomenclaturalCitation(String)

	@Transient

	/* (non-Javadoc)

	 * @see eu.etaxonomy.cdm.model.reference.ReferenceBase#generateTitle()

	 */

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

	 * assigned to <i>this</i> generic reference, a string that identifies <i>this</i>

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

	 * ReferenceBase#generateTitle() method.

	 *

	 * @return  the string identifying <i>this</i> generic reference

	 * @see  	#getCitation()

	 * @see  	NomenclaturalReferenceHelper#generateTitle()

	 * @see  	common.IdentifiableEntity#getTitleCache()

	 * @see  	common.IdentifiableEntity#generateTitle()

	 */

	public String generateTitle(){

//*********** CLONE **********************************/	

	 * Clones <i>this</i> generic reference. This is a shortcut that enables to

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

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

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

	 * 

	 * @see StrictReferenceBase#clone()

	 * @see media.IdentifyableMediaEntity#clone()

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

	public Generic clone(){

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

		//no changes to: editor, pages, placePublished,publisher, series, volume

		return result;

	}

}