Metacat

/**

 *  '$RCSfile$'

 *    Purpose: A class that gets Accession Number, check for uniqueness

 *             and register it into db

 *  Copyright: 2000 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Jivka Bojilova, Matt Jones

 *

 *   '$Author: leinfelder $'

 *     '$Date: 2011-11-02 20:40:12 -0700 (Wed, 02 Nov 2011) $'

 * '$Revision: 6595 $'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.index.event;

import java.util.Date;

import org.dataone.service.types.v1.Identifier;

/**

 * A class represents an event for solr index.

 * @author tao

 *

 */

public class IndexEvent {

    public static final int SUCCESSINSERT = 0;

    public static final int FAILUREINSERT = 6;

    public static final int SUCCESSDELETE = 12;

    public static final int FAILUREDELETE = 18;

    public static final int STARTTIMEDINDEX = 24;

    public static final int FINISHTIMEDINDEX = 30;

    private int type = -1;

    private Date date = null;

    private Identifier pid = null;

    private String description = null;

    /**

     * Get the type of the event.

     * @return the type of the event

     */

    public int getType() {

        return this.type;

    }

    /**

     * Set the type of the event

     * @param type

     */

    public void setType(int type) {

        this.type = type;

    }

    /**

     * Get the date when the event happened

     * @return

     */

    public Date getDate() {

        return date;

    }

    /**

     * Set the date when the event happened

     * @param date

     */

    public void setDate(Date date) {

        this.date = date;

    }

    /**

     * Get the identifier of the data object involving the event

     * @return

     */

    public Identifier getPid() {

        return pid;

    }

    /**

     * Set the identifier of the data object involving the event.

     * @param pid

     */

    public void setPid(Identifier pid) {

        this.pid = pid;

    }

    /**

     * Get the description of the event

     * @return

     */

    public String getDescription() {

        return description;

    }

    /**

     * Set the description of the event

     * @param description

     */

    public void setDescription(String description) {

        this.description = description;

    }

}

package edu.ucsb.nceas.metacat.index.event;

/**

 * A class represents the exception in the IndexEventLog process.

 * @author tao

 *

 */

public class IndexEventLogException extends Exception{

    /**

     * Constructor

     * @param message

     */

    public IndexEventLogException (String message) { 

        super(message); 

    }

    /**

     * Constructor

     * @param message

     * @param cause

     */

    public IndexEventLogException (String message, Exception cause) {

        super(message, cause); 

    }

}

package edu.ucsb.nceas.metacat.index.event;

import java.util.Date;

import java.util.List;

import org.dataone.service.types.v1.Identifier;

/**

 * An interface to store and query the IndexEvent.

 * @author tao

 *

 */

public interface IndexEventLog {

    /**

     * Write an IndexEvent into a storage

     * @param event

     * @throws IndexEventLogException

     */

    public void write(IndexEvent event) throws IndexEventLogException;

    /**

     * Gets the list of IndexEvent matching the specified set of filters. The filter parameters can be null

     * @param type  the type of the event

     * @param pid   the identifier of the data object in the event

     * @param start the start time of the time range for query

     * @param end   the end time of the time range for query

     * @return

     * @throws IndexEventLogException

     */

    public List<IndexEvent> getEvents(int type, Identifier pid, Date start, Date end) throws IndexEventLogException;

}