package fr.inria.jessy.vector;

import java.io.Externalizable;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;

import com.sleepycat.persist.model.Persistent;

@Persistent
public abstract class Vector<K> extends ValueVector<K, Integer> implements
		Externalizable {

	K selfKey;
	private final static Integer _bydefault = -1;

	public Vector() {
		super(_bydefault);
	}

	public Vector(K selfKey) {
		super(_bydefault);
		this.selfKey = selfKey;
	}

	/**
	 * This method is called inside {@code Consistency#certify} method.
	 * 
	 * @param other
	 * @return
	 * @throws NullPointerException
	 */
	public abstract boolean isCompatible(Vector<K> other)
			throws NullPointerException;

	/**
	 * This method is called in
	 * {@code DataStore#get(fr.inria.jessy.store.ReadRequest)} upon receiving a
	 * read request. An entity will be returned such that its {@code Vector} is
	 * compatible with the received {@code CompactVector}
	 * 
	 * @param other
	 *            the compactVector containing all previously read entities.
	 * @return true if the entity can be read, otherwise false.
	 * @throws NullPointerException
	 */
	public abstract boolean isCompatible(CompactVector<K> other)
			throws NullPointerException;

	public abstract void update(CompactVector<K> readSet,
			CompactVector<K> writeSet);
	
	public K getSelfKey() {
		return selfKey;
	}

	public Integer getSelfValue() {
		return super.getValue(selfKey);
	}

	@SuppressWarnings("unchecked")
	public Vector<K> clone() {
		Vector<K> result = (Vector<K>) super.clone();
		result.selfKey = selfKey;

		return result;
	}

	/**
	 * Increament the value of selfKey;
	 */
	public void increament() {
		setValue(selfKey, (getSelfValue() + 1));
	}

	@SuppressWarnings("unchecked")
	public void readExternal(ObjectInput in) throws IOException,
			ClassNotFoundException {
		super.readExternal(in);
		super.setBydefault(_bydefault);
		selfKey = (K) in.readObject();
	}

	public void writeExternal(ObjectOutput out) throws IOException {
		super.writeExternal(out);
		out.writeObject(selfKey);
	}
}

@@ -357,16 +357,64 @@
  = -1;%0A%0A
+%09/**%0A%09 * needed by BerkleyDB %0A%09 */%0A%09@Deprecated%0A
 %09public 

comment on Vector empty constructor