GuideClassifier.java

// BlogBridge -- RSS feed reader, manager, and web based service
// Copyright (C) 2002-2006 by R. Pito Salas
//
// 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
//
// Contact: R. Pito Salas
// mailto:pitosalas@users.sourceforge.net
// More information: about BlogBridge
// http://www.blogbridge.com
// http://sourceforge.net/projects/blogbridge
//
// $Id: GuideClassifier.java,v 1.2 2007/04/17 12:18:44 spyromus Exp $
//

package com.salas.bb.domain;

import static com.salas.bb.domain.GuideClass.READ;

/**
 * A feed can have several classes assigned.
 */
public final class GuideClassifier
{
    /**
     * Hidden utility class constructor.
     */
    private GuideClassifier()
    {
    }

    /**
     * Returns the OR'ed classes corresponding to a guide.
     *
     * @param guide guide.
     *
     * @return corresponding classes.
     */
    public static int classify(IGuide guide)
    {
        int classes = 0;

        if (guide != null)
        {
            if (isRead(guide)) classes |= READ;
        }

        return classes;
    }

    /**
     * Returns <code>TRUE</code> if a guide is completely read.
     *
     * @param guide guide.
     *
     * @return <code>TRUE</code> if read.
     */
    static boolean isRead(IGuide guide)
    {
        boolean read = true;

        int feeds = guide.getFeedsCount();
        for (int i = 0; read && i < feeds; i++)
        {
            IFeed feed = guide.getFeedAt(i);
            read = feed.isRead() || !feed.isVisible();
        }
        
        return read;
    }
}