root/trunk/cdmlib/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/media/MediaRepresentationPart.java

/**
 * 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.media;

import java.net.URI;

import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlIDREF;
import javax.xml.bind.annotation.XmlSchemaType;
import javax.xml.bind.annotation.XmlType;

import org.apache.log4j.Logger;
import org.hibernate.annotations.Cascade;
import org.hibernate.annotations.CascadeType;
import org.hibernate.annotations.Type;
import org.hibernate.envers.Audited;

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

/**
 * A media representation part is a resource that can be referenced by an URI.
 * It represents a part of or the entire media. <br>
 * E.g. a jpg file or a website
 * 
 * @author a.mueller
 * @created 09.06.2008
 * @version 1.0
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "MediaRepresentationPart", propOrder = { 
                "uri", 
        "size",
        "mediaRepresentation"
  })
@Entity
@Audited
public class MediaRepresentationPart extends VersionableEntity implements Cloneable{
        private static final long serialVersionUID = -1674422508643785796L;
        @SuppressWarnings("unused")
        private static final Logger logger = Logger.getLogger(MediaRepresentationPart.class);

        // where the media file is stored
        @XmlElement(name = "URI")
        @Type(type="uriUserType")
        private URI uri;

        // in bytes
        @XmlElement(name = "Size")
        private Integer size;

        // the MediaRepresentation of this MediaRepresentationPart
        @XmlElement(name = "MediaRepresentation")
        @XmlIDREF
        @XmlSchemaType(name = "IDREF")
        @ManyToOne(fetch = FetchType.LAZY)
        @JoinColumn(name = "representation_id", nullable = false, updatable = false, insertable = false)
        @Cascade(CascadeType.SAVE_UPDATE)
        private MediaRepresentation mediaRepresentation;

        /**
         * Factory method
         * 
         * @return
         */
        public static MediaRepresentationPart NewInstance(URI uri, Integer size) {
                MediaRepresentationPart result = new MediaRepresentationPart(uri, size);
                return result;
        }

        /**
         * 
         */
        protected MediaRepresentationPart() {
                super();
        }

        /**
         * 
         */
        protected MediaRepresentationPart(URI uri, Integer size) {
                this();
                this.setUri(uri);
                this.setSize(size);
        }

        /*************** getter /setter *************************************/

        public MediaRepresentation getMediaRepresentation() {
                return this.mediaRepresentation;
        }

        /**
         *  @deprecated for internal (bidirectional) use only
         */
        @Deprecated
        protected void setMediaRepresentation(MediaRepresentation mediaRepresentation) {
                this.mediaRepresentation = mediaRepresentation;
        }

        public URI getUri() {
                return this.uri;
        }

        /**
         * 
         * @param uri
         *            uri
         */
        public void setUri(URI uri) {
                this.uri = uri;
        }

        /**
         * @return
         */
        public Integer getSize() {
                return this.size;
        }

        /**
         * @param size
         *            size
         */
        public void setSize(Integer size) {
                this.size = size;
        }
        
//************************* CLONE **************************/
                /* (non-Javadoc)
         * @see java.lang.Object#clone()
         */
        @Override
        public Object clone() throws CloneNotSupportedException{
                MediaRepresentationPart result = (MediaRepresentationPart)super.clone();

                //media representation
                result.setMediaRepresentation(null);
                
                //no changes to: size, ure
                return result;
        }

        
}