/*
 * Tag.java
 *
 * Version: $Revision: $
 *
 * Date: $Date: $
 *
 * Copyright (c) 2007, Hewlett-Packard Company and Massachusetts
 * Institute of Technology.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * - Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * - Neither the name of the Hewlett-Packard Company nor the name of the
 * Massachusetts Institute of Technology nor the names of their
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``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 COPYRIGHT
 * HOLDERS OR CONTRIBUTORS 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.
 */

package org.dspace.eperson;

import org.dspace.eperson.EPerson;
import org.dspace.content.Item;
import org.dspace.core.Context;
import java.sql.SQLException;

import org.apache.log4j.Logger;
import java.io.Serializable;

import org.apache.commons.lang.builder.ToStringBuilder;

public class Tag implements Serializable {

	private String tag = null;
	private int ePersonId = -1;
	private int freq = 0;
	private int personFreq = 0;

	/**
	 * Constructors for Tag.
	 */
	public Tag() {
		super();
	}

	public Tag(String aTag, int aPerson) {
		super();
		this.tag = aTag;
		this.ePersonId = aPerson;
	}

	public Tag(String aTag, EPerson aPerson) {
		super();
		this.tag = aTag;
		if (aPerson == null) this.ePersonId = -1;
		else this.ePersonId = aPerson.getID();
	}

	public Tag(String aTag, EPerson aPerson, int aFreq, int aPersonFreq) {
		super();
		this.tag = aTag;
		if (aPerson == null) this.ePersonId = -1;
		else this.ePersonId = aPerson.getID();
		this.freq = aFreq;
		this.personFreq = aPersonFreq;
	}

	public int getFreq() {
		return this.freq;
	}

	public int getPersonFreq() {
		return this.personFreq;
	}

	public int getEPersonID() {
		return this.ePersonId;
	}

	public String getTag() {
		return this.tag;
	}

	/**
	 * @param tag
	 *            The tag to set.
	 */
	public void setTag(String aTag) {
		this.tag = aTag;
	}

	/**
	 * @param aFreq
         *            The absolute frequency of the tag
	 */
	public void setFreq(int aFreq) {
		this.freq = aFreq;
	}

	/**
	 * @param aFreq
         *            The personal frequency of the tag
	 */
	public void setPersonFreq(int aFreq) {
		this.personFreq = aFreq;
	}

	/**
	 * @param aPerson
	 *            The person ID to set.
	 */
	public void setEPersonID(int aPerson) {
		this.ePersonId = aPerson;
	}

	/**
	 * @param aPerson
	 *            The person to set.
	 */
	public void setEPersonID(EPerson aPerson) {
		if (aPerson == null) this.ePersonId = -1;
		else this.ePersonId = aPerson.getID();
	}

	/**
	 * @see java.lang.Object#toString()
	 */
	public String toString() {
		return new ToStringBuilder(this).append(
		                "tag",       this.tag).append(
				"ePersonID", this.ePersonId).append(
				"freq",      this.personFreq).append(
				"personFreq",this.freq).toString();
	}
	
	public Item[] getBookmarks(Context context) throws SQLException {
	    return BookmarkManager.getBookmarks(context, EPerson.find(context,this.ePersonId), this.tag);
	}

}