Photo.java

/*
 * cameracontrol
 * Copyright (C) 2010 Stefano Fornari
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by
 * the Free Software Foundation with the addition of the following permission
 * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
 * WORK IN WHICH THE COPYRIGHT IS OWNED BY Stefano Fornari, Stefano Fornari
 * DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * 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 Affero General Public License
 * along with this program; if not, see http://www.gnu.org/licenses or write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301 USA.
 */

package ste.cameracontrol;

import java.awt.Graphics2D;
import java.awt.image.BufferedImage;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import javax.imageio.ImageIO;

/**
 * This class associates an image name to a BufferedImage
 *
 * @author ste
 */
public class Photo {
    private String name;
    private byte[] jpegData;
    private byte[] rawData;

    /**
     * Creates a Photo object given the name and data
     *
     * @param name the photo name - NOT EMPTY
     * @param data the photo raw data
     *
     * @throws IllegalArgumentException if name is null or empty
     */
    public Photo(String name) {
        if ((name == null) || (name.length() == 0)) {
            throw new IllegalArgumentException("name cannot be null or empty");
        }
        this.name = name;
    }
    
    public String getName() {
        return name;
    }

    public byte[] getJpegData() {
        return jpegData;
    }

    public void setJpegData(byte[] data) {
        if ((data == null) || (data.length == 0)) {
            throw new IllegalArgumentException("data cannot be null or empty");
        }

        this.jpegData = data;
    }

    public void setRawData(byte[] data) {
        if ((data == null) || (data.length == 0)) {
            throw new IllegalArgumentException("data cannot be null or empty");
        }

        this.rawData = data;
    }

    public byte[] getRawData() {
        return rawData;
    }

    public BufferedImage getJpegImage() {
        if (jpegData == null) {
            return null;
        }

        BufferedImage ret = null;
        try {
            ret = ImageIO.read(new ByteArrayInputStream(jpegData));
        } catch (IOException e) {
            //
            // Do nothing, ret will be null
            //
            e.printStackTrace();
        }

        return ret;
    }

    public BufferedImage getRawImage() {
        if (rawData == null) {
            return null;
        }

        BufferedImage ret = new BufferedImage(100, 50, BufferedImage.TYPE_INT_ARGB);
        Graphics2D g2 = ret.createGraphics();
        g2.drawString("RAW image display not yet supported", 25, 25);

        return ret;
    }
    
    /**
     * Does this Photo contain the jpeg image?
     * 
     * @return true if the Photo contains the jpeg image, false otherwise
     */
    public boolean hasJpeg() {
        return (jpegData != null);
    }

    /**
     * Does this Photo contain the raw image?
     *
     * @return true if the Photo contains the raw image, false otherwise
     */
    public boolean hasRaw() {
        return (rawData != null);
    }


    @Override
    public boolean equals(Object o) {
        if ((o == null) || !(o instanceof Photo)) {
            return false;
        }

        Photo p = (Photo)o;
        return getName().equals(p.getName());
    }

    @Override
    public int hashCode() {
        return name.hashCode();
    }
}