org.zephyrsoft.sdb2.model.statistics.SongStatistics.java Source code

Introduction

Here is the source code for org.zephyrsoft.sdb2.model.statistics.SongStatistics.java

Source

/*
 * This file is part of the Song Database (SDB).
 *
 * SDB 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.
 *
 * SDB 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 SDB. If not, see <http://www.gnu.org/licenses/>.
 */
package org.zephyrsoft.sdb2.model.statistics;

import java.util.Calendar;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.Iterator;
import java.util.SortedSet;
import java.util.TreeSet;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import org.apache.commons.lang3.Validate;
import org.zephyrsoft.sdb2.model.Song;

/**
 * Statistics about the displaying of one specific song.
 * 
 * @author Mathis Dirksen-Thedens
 */
@XStreamAlias("songStatistics")
public class SongStatistics implements Comparable<SongStatistics>, Iterable<Date> {

    private String songUuid;
    private SortedSet<Date> presentedOn = new TreeSet<>();

    /**
     * Create a statistics element for a single {@link Song}. By only having a constructor with the UUID as argument,
     * everyone (who doesn't use reflection) is forced to supply the UUID.
     * 
     * @param songUuid the UUID which belongs to the song that these statistics are kept for
     */
    SongStatistics(String songUuid) {
        Validate.notNull(songUuid, "the UUID must be different from null");
        this.songUuid = songUuid;
    }

    public String getSongUUID() {
        return songUuid;
    }

    @Override
    public Iterator<Date> iterator() {
        return presentedOn.iterator();
    }

    public int dateCount() {
        return presentedOn.size();
    }

    public boolean dateAdd(Date date) {
        return presentedOn.add(wipeTime(date));
    }

    private Date wipeTime(Date date) {
        GregorianCalendar cal = new GregorianCalendar();
        cal.setTime(date);
        cal.set(Calendar.HOUR, 0);
        cal.set(Calendar.MINUTE, 0);
        cal.set(Calendar.SECOND, 0);
        cal.set(Calendar.MILLISECOND, 0);
        return cal.getTime();
    }

    @Override
    public int compareTo(SongStatistics o) {
        Validate.notNull(o, "cannot compare a SongStatistics object with null");
        return songUuid.compareTo(o.getSongUUID());
    }

}