/**
 * Copyright © 2008-2009 DRIVER PROJECT (ICM UW)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package eu.dnetlib.resultset.impl;

import javax.persistence.Entity;
import javax.persistence.EnumType;
import javax.persistence.Enumerated;
import javax.persistence.Id;
import javax.persistence.Inheritance;
import javax.persistence.InheritanceType;
import javax.persistence.Transient;

import org.hibernate.annotations.Index;

/**
 * Abstract ResultSet class contains common pull and push result set properties.
 * @author Marek Horst
 * @version 0.01
 *
 */
//@MappedSuperclass - can't be used because it makes getting ResultSetObject parent class impossible.
@Entity
@Inheritance(strategy=InheritanceType.JOINED)
public abstract class ResultSetObject {

	/**
	 * Result Set type: pull_rs or push_rs
	 */
	public enum ResultSetType {
		PULL_RS,
		PUSH_RS
	}
	
	/**
	 * Result Set status: open or closed
	 */
	public enum ResultSetStatus {
		OPEN,
		CLOSED
	}
	
	/**
	 * Result Set identifier.
	 */
	private String resultSetId;
	
	/**
	 * Current Result Set status.
	 */
	private ResultSetStatus status;
	
	/**
	 * Result Set creation time.
	 */
	private long creationTime;

	/**
	 * Result Set expiry time (in seconds).
	 */
	private int expiryTime;
	
	/**
	 * Default constructor.
	 * @param resultSetId
	 * @param expiryTime
	 */
	public ResultSetObject(String resultSetId, int expiryTime) {
		this.resultSetId = resultSetId;
		this.creationTime = System.currentTimeMillis();
		this.expiryTime = expiryTime;
//		TODO when upgrading implementation level, change accordingly
		this.status = ResultSetStatus.CLOSED;
	}
	
	/**
	 * Returns ResultSet type.
	 * @return ResultSet type
	 */
	@Transient
	public abstract ResultSetType getResultSetType();
	
	/**
	 * Returns ResultSet size.
	 * @return ResultSet size
	 */
	@Transient
	abstract public int getSize();

	/**
	 * Returns current Result Set status.
	 * @return current Result Set status
	 */
	@Enumerated(value=EnumType.STRING)
	public ResultSetStatus getStatus() {
		return status;
	}

	/**
	 * Sets current Result Set status.
	 * @param status
	 */
	public void setStatus(ResultSetStatus status) {
		this.status = status;
	}

	/**
	 * Returns Result Set expiration time. 
	 * @return Result Set expiration time
	 */
	@Transient
	public abstract long getExpirationTime();

	/**
	 * Returns Result Set expiry time (in seconds).
	 * @return Result Set expiry time
	 */
	@Index(name="ExpiryTimeIndex")
	public synchronized int getExpiryTime() {
		return expiryTime;
	}

	/**
	 * Sets Result Set expiry time (in seconds).
	 * @param expiryTime
	 */
	public synchronized void setExpiryTime(int expiryTime) {
		this.expiryTime = expiryTime;
	}

	/**
	 * Returns Result Set identifier.
	 * @return Result Set identifier
	 */
	@Id
	public String getResultSetId() {
		return resultSetId;
	}

	/**
	 * Sets Result Set identifier.
	 * @param resultSetId
	 */
	public void setResultSetId(String resultSetId) {
		this.resultSetId = resultSetId;
	}

	/**
	 * creationTime getter for hibernate3 purposes.
	 * @return creationTime 
	 */
	@Index(name="CreationTimeIndex")
	public long getCreationTime() {
		return creationTime;
	}

	/**
	 * creationTime setter for hibernate3 purposes.
	 * @param creationTime
	 */
	public void setCreationTime(long creationTime) {
		this.creationTime = creationTime;
	}

}