/*
 * Copyright (c) 2009-2011 Lockheed Martin Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.eurekastreams.server.domain;

import java.io.Serializable;

import javax.persistence.Basic;
import javax.persistence.Column;
import javax.persistence.Embeddable;
import javax.persistence.EmbeddedId;
import javax.persistence.Entity;

import org.eurekastreams.commons.model.WrappedLightEntity;

/**
 * Object representing the person following a group relationship.
 */
@Entity
public class GroupFollower extends WrappedLightEntity implements Serializable
{
    /**
     * Serial version uid.
     */
    private static final long serialVersionUID = 2197093976396575034L;

    /**
     * Instance of FollowerPk (Composite primary key object) for this class.
     */
    @EmbeddedId
    private GroupFollowerPk pk = null;

    /**
     * Index of the followed group in the list of followed groups for the follower.
     */
    @Basic
    private int groupStreamIndex = 0;

    /**
     * Whether to receive notifications after new activities are posted to this group.
     */
    @Basic
    @Column(name="receiveNewActivityNotification")
    private Boolean receiveNewActivityNotifications = true;

    /**
     * Constructor.
     * 
     * @param inFollowerId
     *            Follower id.
     * @param inFollowingId
     *            Following id (id of Object being followed).
     */
    public GroupFollower(final long inFollowerId, final long inFollowingId)
    {
        pk = new GroupFollowerPk(inFollowerId, inFollowingId);
    }

    /**
     * Constructor (no-op for ORM).
     */
    @SuppressWarnings("unused")
    private GroupFollower()
    {
    }

    /**
     * FollowerId getter.
     * 
     * @return Follower id.
     */
    public long getFollowerId()
    {
        return pk.getFollowerId();
    }

    /**
     * FollowingId getter.
     * 
     * @return Following id (id of Object being followed).
     */
    public long getFollowingId()
    {
        return pk.getFollowingId();
    }

    /**
     * @param inGroupStreamIndex
     *            the group stream index to set
     */
    public void setGroupStreamIndex(final int inGroupStreamIndex)
    {
        groupStreamIndex = inGroupStreamIndex;
    }

    /**
     * @return the group stream index
     */
    public int getGroupStreamIndex()
    {
        return groupStreamIndex;
    }

    /**
     * @return the receiveNewActivityNotifications
     */
    public boolean getReceiveNewActivityNotifications()
    {
        return receiveNewActivityNotifications;
    }

    /**
     * @param inReceiveNewActivityNotifications
     *            the receiveNewActivityNotifications to set
     */
    public void setReceiveNewActivityNotifications(final boolean inReceiveNewActivityNotifications)
    {
        receiveNewActivityNotifications = inReceiveNewActivityNotifications;
    }

    /**
     * Composite primary key for follower.
     * 
     */
    @Embeddable
    public static class GroupFollowerPk implements Serializable
    {
        /**
         * Serial version uid.
         */
        private static final long serialVersionUID = -6415173783140689235L;

        /**
         * Follower id.
         */
        @Basic
        private long followerId = 0;

        /**
         * Following id (id of Object being followed).
         */
        @Basic
        private long followingId = 0;

        /**
         * Constructor.
         * 
         * @param inFollowerId
         *            Follower id.
         * @param inFollowingId
         *            Following id (id of Object being followed).
         */
        public GroupFollowerPk(final long inFollowerId, final long inFollowingId)
        {
            followerId = inFollowerId;
            followingId = inFollowingId;
        }

        /**
         * Constructor (no-op for ORM).
         */
        @SuppressWarnings("unused")
        private GroupFollowerPk()
        {
        }

        /**
         * FollowerId getter.
         * 
         * @return Follower id.
         */
        public long getFollowerId()
        {
            return followerId;
        }

        /**
         * FollowingId getter.
         * 
         * @return Following id (id of Object being followed).
         */
        public long getFollowingId()
        {
            return followingId;
        }

        /**
         * Override hashCode for comparing pk object.
         * 
         * @return The generated hashcode.
         */
        @Override
        public int hashCode()
        {
            int hashCode = 0;
            hashCode ^= (new Long(followerId)).hashCode();
            hashCode ^= (new Long(followingId)).hashCode();
            return hashCode;
        }

        /**
         * Override equals for comparing pk object.
         * 
         * @param obj
         *            The object to compare to this one.
         * @return True if obj is equal to this one, false otherwise.
         */
        @Override
        public boolean equals(final Object obj)
        {
            if (!(obj instanceof GroupFollowerPk))
            {
                return false;
            }
            GroupFollowerPk target = (GroupFollowerPk) obj;

            return (target.followingId == followingId) && (target.followerId == followerId);
        }
    }

    /**
     * Enumeration for follower/following relationship status.
     * 
     */
    public static enum GroupFollowerStatus implements Serializable
    {
        /**
         * Follower/Following relationship is not specified.
         */
        NOTSPECIFIED,

        /**
         * Follower/Following relationship is not allowed.
         */
        DISABLED,

        /**
         * Follower/Following relationship is established.
         */
        FOLLOWING,

        /**
         * Follower/Following relationship is not established.
         */
        NOTFOLLOWING,
    }

}