001/*
002 * #%L
003 * Netarchivesuite - harvester
004 * %%
005 * Copyright (C) 2005 - 2014 The Royal Danish Library, the Danish State and University Library,
006 *             the National Library of France and the Austrian National Library.
007 * %%
008 * This program is free software: you can redistribute it and/or modify
009 * it under the terms of the GNU Lesser General Public License as
010 * published by the Free Software Foundation, either version 2.1 of the
011 * License, or (at your option) any later version.
012 * 
013 * This program is distributed in the hope that it will be useful,
014 * but WITHOUT ANY WARRANTY; without even the implied warranty of
015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016 * GNU General Lesser Public License for more details.
017 * 
018 * You should have received a copy of the GNU General Lesser Public
019 * License along with this program.  If not, see
020 * <http://www.gnu.org/licenses/lgpl-2.1.html>.
021 * #L%
022 */
023package dk.netarkivet.harvester.indexserver;
024
025import java.util.concurrent.Future;
026
027import dk.netarkivet.common.exceptions.ArgumentNotValid;
028
029/** Stores the state of a indexing task. */
030public class IndexingState {
031
032    /** The Id of the job being indexed. */
033    private final Long jobIdentifier;
034    /** The full path to the index. */
035    private final String index;
036    /** The result object for the indexing task. */
037    private final Future<Boolean> resultObject;
038
039    /**
040     * Constructor for an IndexingState object.
041     *
042     * @param jobId The ID of the Job being indexing.
043     * @param indexingpath The full path to the index.
044     * @param result The result object for the indexing task
045     */
046    public IndexingState(Long jobId, String indexingpath, Future<Boolean> result) {
047        ArgumentNotValid.checkNotNull(jobId, "Long jobId");
048        ArgumentNotValid.checkNotNullOrEmpty(indexingpath, "String indexingpath");
049        ArgumentNotValid.checkNotNull(result, "Future<Boolean> result");
050        this.jobIdentifier = jobId;
051        this.index = indexingpath;
052        this.resultObject = result;
053    }
054
055    /**
056     * @return the Id of the job being indexed.
057     */
058    public Long getJobIdentifier() {
059        return jobIdentifier;
060    }
061
062    /**
063     * @return the full path to the index generated.
064     */
065    public String getIndex() {
066        return index;
067    }
068
069    /**
070     * @return the result of the indexing process.
071     */
072    public Future<Boolean> getResultObject() {
073        return resultObject;
074    }
075
076    public String toString() {
077        return "IndexingState for JobID #" + jobIdentifier + ": (index = " + index + ", IndexingDone = "
078                + resultObject.isDone() + ")";
079    }
080
081}