package com.trendmicro.grid.acl.ds.jpa.entities;
   
   import com.trendmicro.grid.acl.l0.datatypes.PackageDetails;
   import com.trendmicro.grid.acl.l0.datatypes.PackageInformation;
   import com.trendmicro.grid.acl.metadata.Metadata;
   import org.hibernate.annotations.Type;
   
   import javax.persistence.*;
   import java.io.Serializable;
  import java.util.Arrays;
  import java.util.Date;
  import java.util.List;
  
  import static com.trendmicro.grid.acl.Limits.MAX_SERIALIZED_METADATA_LENGTH;
  import static com.trendmicro.grid.acl.Limits.MAX_TAG_STRING_LENGTH;
  import static com.trendmicro.grid.acl.ds.jpa.util.JpaUtils.metadataDiffers;
  import static com.trendmicro.grid.acl.ds.jpa.util.JpaUtils.tagsDiffer;
  
  /**
   * Implements a read and writeable history entry for the FILE_CONTENT_HISTORY table.
   *
   * @author juergen_kellerer, 2010-06-07
   * @version 1.0
   */
  @NamedQueries({
  		@NamedQuery(name = "PackageHistory.SelectMaxRevisionForPackage",
  				query = "SELECT MAX(h.historyId.revision) " +
  						"FROM PACKAGE_HISTORY h WHERE historyId.parent = :parent"),
  		@NamedQuery(name = "PackageHistory.SelectPackageHistoryDetailsByPackageDetail",
  						query = "SELECT h " +
  								"FROM PACKAGE_HISTORY h WHERE historyId.parent = :parent")
  })
  @Entity(name = "PACKAGE_HISTORY")
  public class JpaPackageHistory implements Serializable {
  
  	private static final long serialVersionUID = -4911356794856270325L;
  
  	/**
  	 * Returns true if history relevant values differ.
  	 *
  	 * @param existingDetails the existing details.
  	 * @param details		 the updated details.
  	 * @param ignoreMetadata  whether metadata is compared or not.
  	 * @return true if history relevant values differ.
  	 */
  	public static boolean wasChanged(PackageDetails existingDetails, PackageDetails details, boolean ignoreMetadata) {
  		PackageInformation existingInfo = existingDetails.getPackageInformation(),
  				info = details.getPackageInformation();
  		return (!ignoreMetadata && metadataDiffers(existingDetails, details)) ||
  				!existingInfo.getDisplayName().equals(info.getDisplayName()) ||
  				tagsDiffer(existingInfo, info);
  	}
  
  	@EmbeddedId
  	private JpaPackageHistoryId historyId;
  
  	@Temporal(TemporalType.TIMESTAMP)
  	@Column(name = "CREATED", nullable = false)
  	private Date created = new Date();
  
  	@Type(type = "nstring")
  	@Column(name = "DISPLAY_NAME", nullable = false)
  	private String displayName;
  
  	@Type(type = "taglist")
  	@Column(name = "TAGS", length = MAX_TAG_STRING_LENGTH, nullable = true)
  	String[] tags;
  
  	@Type(type = "metadata")
  	@Basic(fetch = FetchType.LAZY)
  	@Column(name = "META_DATA", length = MAX_SERIALIZED_METADATA_LENGTH)
  	Metadata metadata;
  
  	public JpaPackageHistory() {
  	}
  
  	/**
  	 * Creates a new history entry for the given package entry.
  	 *
  	 * @param packageDetails the instance of packageDetails to create the history from.
  	 */
  	public JpaPackageHistory(JpaPackageDetails packageDetails) {
  		this.historyId = new JpaPackageHistoryId(packageDetails);
  
  		final JpaPackageInformation info = packageDetails.getPackageInformation();
  		displayName = info.getDisplayName();
  		tags = info.getTagsAsArray();
  		metadata = packageDetails.getMetadata();
  
  		// Clone all mutable types to avoid side effects.
  		if (tags != null)
  			tags = tags.clone();
  		if (metadata != null)
  			metadata = metadata.clone();
  	}
  
  	public JpaPackageHistoryId getHistoryId() {
  		return historyId;
  	}
 
 	public Date getCreated() {
 		return created;
 	}
 
 	public String getDisplayName() {
 		return displayName;
 	}
 
 	public String[] getTags() {
 		return tags;
 	}
 
 	public Metadata getMetadata() {
 		return metadata;
 	}
 
 	@Override
 	public boolean equals(Object o) {
 		if (this == o) return true;
 		if (!(o instanceof JpaPackageHistory)) return false;
 
 		JpaPackageHistory that = (JpaPackageHistory) o;
 		return !(historyId != null ? !historyId.equals(that.historyId) : that.historyId != null);
 	}
 
 	@Override
 	public int hashCode() {
 		return historyId != null ? historyId.hashCode() : 0;
 	}
 
 	@Override
 	public String toString() {
 		return "JpaPackageHistory{" +
 				"historyId=" + historyId +
 				", created=" + created +
 				", displayName='" + displayName + '\'' +
 				", tags=" + (tags == null ? null : Arrays.asList(tags)) +
 				", metadata=" + metadata +
 				'}';
 	}
 }