/*--
  This file is a part of ZetaGrid, a simple and secure Grid Computing
  kernel.

  Copyright (c) 2001-2004 Sebastian Wedeniwski.  All rights reserved.

  Use in source and binary forms, with or without modification,
  are permitted provided that the following conditions are met:

  1. The source code must retain the above copyright
     notice, this list of conditions and the following disclaimer.

  2. The origin of this software must not be misrepresented; you must 
     not claim that you wrote the original software.  If you plan to
     use this software in a product, please contact the author.

  3. Altered source versions must be plainly marked as such, and must
     not be misrepresented as being the original software. The author
     must be informed about these changes.

  4. The name of the author may not be used to endorse or promote 
     products derived from this software without specific prior written 
     permission.

  THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

  Version 1.9.0, February 8, 2004

  This program is based on the work of:
     S. Wedeniwski
     W. Westje
--*/

package zeta;

import java.io.BufferedReader;
import java.io.IOException;
import java.util.Comparator;
import java.util.List;

public abstract class WorkUnit implements Cloneable, Comparator, Comparable {
  public abstract boolean init(String logFilename);
  public abstract List parseWorkUnitFiles(BufferedReader in) throws IOException;
  public abstract String writeObject();
  public abstract boolean isCompleted();
  public abstract String getFilename();
  public abstract String getFilename(String logFilename);
  public abstract String getLogFilename();
  public abstract String getLogFilename(String filename);
  public abstract boolean isFilename(String filename);
  public abstract boolean isLogFilename(String filename);
  public abstract int compare(Object workUnit1, Object workUnit2);

  public WorkUnit() {
    taskId = -1;
    workUnitId = -1;
    size = -1;
  }

  public WorkUnit(int taskId, long workUnitId, int size) {
    this.taskId = taskId;
    this.workUnitId = workUnitId;
    this.size = size;
  }

  /**
   *  Creates and returns a copy of this object.
   *  Just call <code>super.clone</code>.
   *  @return a clone of this instance.
  **/
  public Object clone() throws CloneNotSupportedException {
    return super.clone();
  }

  public int getTaskId() {
    return taskId;
  }

  public long getWorkUnitId() {
    return workUnitId;
  }

  public int getSize() {
    return size;
  }

  public boolean isValid() {
    return (taskId > 0 && workUnitId >= 0 && size > 0);
  }

  public int compareTo(Object o) {
    return compare(this, o);
  }

  public boolean equals(Object workUnit) {  // ToDo: add taskId
    if (workUnit instanceof WorkUnit) {
      WorkUnit wu = (WorkUnit)workUnit;
      if (taskId == wu.taskId && workUnitId == wu.workUnitId && size == wu.size) {
        return true;
      }
    }
    return false;
  }

  public int hashCode() {
    return (int)(((workUnitId >> 16)&0xffff) + (workUnitId&0xffff));
  }

  public String toString() {
    return "taskId=" + taskId + ", workUnitId=" + workUnitId + ", size=" + size;
  }

  protected int taskId;
  protected long workUnitId;
  protected int size;
}