/*
 * Copyright (c) 2014-2015 The Regents of the University of California.
 * All rights reserved.
 *
 * '$Author: crawl $'
 * '$Date: 2015-12-09 21:41:37 +0000 (Wed, 09 Dec 2015) $' 
 * '$Revision: 34322 $'
 * 
 * Permission is hereby granted, without written agreement and without
 * license or royalty fees, to use, copy, modify, and distribute this
 * software and its documentation for any purpose, provided that the above
 * copyright notice and the following two paragraphs appear in all copies
 * of this software.
 *
 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
 * ENHANCEMENTS, OR MODIFICATIONS.
 *
 */
package org.kepler.gis.data;

import java.io.File;
import java.io.Serializable;

import org.geotools.coverage.grid.io.AbstractGridCoverage2DReader;
import org.opengis.coverage.grid.GridCoverage;

import ptolemy.data.BooleanToken;
import ptolemy.data.Token;
import ptolemy.data.type.Type;
import ptolemy.kernel.util.IllegalActionException;

/** Token containing a GIS raster.
 * 
 *  @author Daniel Crawl
 *  @version $Id: RasterToken.java 34322 2015-12-09 21:41:37Z crawl $
 *  
 */
public class RasterToken extends Token {

    /** Create a new RasterToken from a coverage. */
    public RasterToken(GridCoverage coverage) throws IllegalActionException {
        if(coverage == null) {
            throw new IllegalActionException("Cannot create RasterToken with null coverage.");
        }
        _coverage = coverage;
    }

    /** Create a new RasterToken from a reader. */
    public RasterToken(AbstractGridCoverage2DReader reader) throws IllegalActionException {
        if(reader == null) {
            throw new IllegalActionException("Cannot create RasterToken with null reader.");
        }
        _reader = reader;
    }
    
    /** Create a new RasterToken from a file. */
    public RasterToken(File file) {
        _file = file;
    }

    /** Get the coverage. */
    public GridCoverage coverageValue() {
        return _coverage;
    }
    
    /** Get the reader. */
    public AbstractGridCoverage2DReader reader() {
        return _reader;
    }
    
    /** Get the file. */
    public File rasterFile() {
        return _file;
    }
    
    
    @Override
    public Type getType() {
        return RASTER;
    }
    
    /**
     * Test for equality of the values of this Token and the argument Token. If
     * the value of this token or the value of the rightArgument token is null,
     * then we return False.
     * 
     * @param rightArgument
     *            The Token to test against.
     * @exception IllegalActionException
     *                Not thrown in this base class.
     * @return A boolean token that contains the value true if the dates are the
     *         same.
     */
    @Override
    public final BooleanToken isEqualTo(Token rightArgument)
            throws IllegalActionException {
        GridCoverage rightData = ((RasterToken) rightArgument).coverageValue();
        GridCoverage leftData = coverageValue();

        if ((rightData == null) || (leftData == null)) {
            return BooleanToken.FALSE;
        } else if (rightData.equals(leftData)) {
            return BooleanToken.TRUE;
        } else {
            return BooleanToken.FALSE;
        }
    }

    /**
     * Return a String representation of the DateToken. The string is surrounded
     * by double-quotes; without them, the Ptolemy expression parser fails to
     * parse it.
     * 
     * @return A String representation of the DateToken.
     */
    @Override
    public String toString() {
        if (_coverage == null) {
            return "";
        } else {
            return _coverage.toString();
        }
    }

    public static class RasterType implements Cloneable, Type, Serializable {

        @Override
        public Type add(Type rightArgumentType) {
            // TODO Auto-generated method stub
            return this;
        }

        @Override
        public Object clone() {
            return this;
        }
        
        @Override
        public Token convert(Token token) throws IllegalActionException {
            if (token instanceof RasterToken) {
                return token;
            } else {
                throw new IllegalActionException("Attempt to convert token "
                        + token + " into a Raster token, which is not possible.");
            }
        }

        @Override
        public Type divide(Type rightArgumentType) {
            // TODO Auto-generated method stub
            return this;
        }

        @Override
        public int getTypeHash() {
            // TODO Auto-generated method stub
            return 0;
        }

        @Override
        public Class<?> getTokenClass() {
            return RasterToken.class;
        }

        @Override
        public boolean isAbstract() {
            return false;
        }

        @Override
        public boolean isCompatible(Type type) {
            return type == this;
        }

        @Override
        public boolean isConstant() {
            return true;
        }

        @Override
        public boolean isInstantiable() {
            return true;
        }

        @Override
        public boolean isSubstitutionInstance(Type type) {
            return type == this;
        }

        @Override
        public Type modulo(Type rightArgumentType) {
            // TODO Auto-generated method stub
            return this;
        }

        @Override
        public Type multiply(Type rightArgumentType) {
            // TODO Auto-generated method stub
            return this;
        }

        @Override
        public Type one() {
            // TODO Auto-generated method stub
            return this;
        }

        @Override
        public Type subtract(Type rightArgumentType) {
            // TODO Auto-generated method stub
            return this;
        }

        @Override
        public String toString() {
            return "raster";
        }
        
        @Override
        public Type zero() {
            // TODO Auto-generated method stub
            return this;
        }

    }
    
    public static final RasterType RASTER = new RasterType();

    private GridCoverage _coverage;
    private AbstractGridCoverage2DReader _reader;
    private File _file;
    
}