package Torello.HTML.Tools.Images;

import Torello.Java.*;
import Torello.JavaDoc.LinkJavaSource;
// Needed for a JavaDoc Comment {@link ...}
import Torello.HTML.TagNode;

import java.net.URL;
import java.io.Serializable;
import java.util.Arrays;

/**
 * After downloading all of the user's requested images, the class {@link ImageScraper} returns an
 * instance of this class.
 * 
 * <EMBED CLASS='external-html' DATA-FILE-ID=RESULTS>
 * @see ImageScraper
 */
@Torello.JavaDoc.JDHeaderBackgroundImg(EmbedTagFileID="IMAGE_SCRAPER_CLASS")
public class Results implements Serializable, Cloneable
{
    /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
    public static final long serialVersionUID = 1;


    // ********************************************************************************************
    // ********************************************************************************************
    // Public Array Fields: User may inspect these fields when an instance of 'Results' is returned
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_urls>
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_PARALLEL_NOTE>
     */
    public final URL[] urls;

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_b64EncodedImg>
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_PARALLEL_NOTE>
     */    
    public final boolean[] b64EncodedImg;

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_skipped>
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_PARALLEL_NOTE>
     */
    public final boolean[] skipped;

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_fileNames>
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_PARALLEL_NOTE>
     */
    public final String[] fileNames;

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_saveDirectories>
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_PARALLEL_NOTE>
     */
    public final String[] saveDirectories;

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_imageFormats>
     * <EMBED CLASS='external-html' DATA-DEFVAL=null DATA-SPEC="image-format"
     *      DATA-FILE-ID=RES_SKIPPED_NOTE>
     * 
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_PARALLEL_NOTE>
     */
    public final IF[] imageFormats;

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_exceptions>
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_PARALLEL_NOTE>
     */
    public final Exception[] exceptions;

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_sizes>
     * <EMBED CLASS='external-html' DATA-DEFVAL="-1" DATA-SPEC=size DATA-FILE-ID=RES_SKIPPED_NOTE>
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_PARALLEL_NOTE>
     */
    public final long[] sizes;

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_widths>
     * <EMBED CLASS='external-html' DATA-DEFVAL="-1" DATA-SPEC=width DATA-FILE-ID=RES_SKIPPED_NOTE>
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_PARALLEL_NOTE>
     */
    public final int[] widths;

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_heights>
     * <EMBED CLASS='external-html' DATA-DEFVAL="-1" DATA-SPEC=height
     *      DATA-FILE-ID=RES_SKIPPED_NOTE>
     * <EMBED CLASS='external-html' DATA-FILE-ID=RES_PARALLEL_NOTE>
     */
    public final int[] heights;


    // ********************************************************************************************
    // ********************************************************************************************
    // Some Package-Private Fields, Used here and by class ImageScraper
    // ********************************************************************************************
    // ********************************************************************************************


    // next result received array position.
    int pos = 0;

    // number of successfully saved images.
    int successCounter = 0;


    // ********************************************************************************************
    // ********************************************************************************************
    // Package-Private Constructor
    // ********************************************************************************************
    // ********************************************************************************************


    Results(int size)
    {
        // *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
        // Create each of these arrays
        // *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

        urls                = new URL[size];
        b64EncodedImg       = new boolean[size];
        skipped             = new boolean[size];
        fileNames           = new String[size];
        saveDirectories     = new String[size];
        imageFormats        = new IF[size];
        exceptions          = new Exception[size];
        sizes               = new long[size];
        widths              = new int[size];
        heights             = new int[size];


        // *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
        // Initialize each element of the above arrays
        // *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

        for (int i=0; i < size; i++)
        {
            urls[i]             = null;
            b64EncodedImg[i]    = false;
            skipped[i]          = false;
            fileNames[i]        = null;
            saveDirectories[i]  = null;
            imageFormats[i]     = null;
            exceptions[i]       = null;
            sizes[i]            = -1;
            widths[i]           = -1;
            heights[i]          = -1;
        }
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // No Image Downloaded
    // ********************************************************************************************
    // ********************************************************************************************


    // Request static-builder generated an "Exception URL"
    // Called From: ImageScraper.loopBody(RECORD)

    void tagNodeSRCError(Exception e)
    {
        skipped[pos]    = true;
        exceptions[pos] = e;

        pos++;
    }


    // User-Provided "Predicate<URL> skipURL"
    // Called From: ImageScraper.downloadImage(RECORD)

    void skippedURL(URL url)
    {
        urls[pos]       = url;
        skipped[pos]    = true;

        pos++;
    }


    // User-Provided "boolean skipBase64EncodedImages"
    // Called From: ImageScraper.convertB64Image(RECORD)

    void skipB64()
    {
        b64EncodedImg[pos]  = true;
        skipped[pos]        = true;

        pos++;
    }


    // Called from many places.  This method is the biggest of the Results-Reporters 
    //   * Exception-thrown
    //   * 'ImageInfo' instance hasn't been constructed yet

    void exceptionFail(URL url, Exception e)
    {
        urls[pos]           = url;
        b64EncodedImg[pos]  = (url == null);
        skipped[pos]        = true;
        exceptions[pos]     = e;

        pos++;
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // "ImageInfo" instance available now: Image Successfully Downloaded and Converted to Array.
    // ********************************************************************************************
    // ********************************************************************************************


    // There are 3 different User-Provided Lambda-Target's that might throw exceptions
    // This is called from within "ImageScraper.RECORD.userLambdaEx(...)"

    void userLambdaException(ImageInfo imageInfo, Exception e)
    {
        skipped[pos]    = true;
        exceptions[pos] = e;

        copyImageInfo(imageInfo);
    }


    // The User Keep/Reject Predicate rejected this image
    // Called From: ImageScraper.handleImageByteArray(RECORD)

    void predicateReject(ImageInfo imageInfo)
    {
        skipped[pos] = true;
        copyImageInfo(imageInfo);
    }


    // Image was written to disk somewhere, or accepted by the Request.imageReceiver
    // Called From: ImageScraper.writeOrTransmit(RECORD)

    void success(ImageInfo imageInfo, String targetDirectory)
    {
        // Directory where the image was saved, if called by "ImageReceiver", this will be null
        saveDirectories[pos] = targetDirectory;

        copyImageInfo(imageInfo);

        // Only time this is ever incremented
        successCounter++;
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // SMALL HELPER
    // ********************************************************************************************
    // ********************************************************************************************


    // Private Method, used in all 5 previous methods directly above here
    private void copyImageInfo(ImageInfo imageInfo)
    {
        urls[pos]           = imageInfo.url;
        b64EncodedImg[pos]  = imageInfo.isB64EncodedImage;
        imageFormats[pos]   = imageInfo.actualExtension;
        sizes[pos]          = imageInfo.imgByteArr.length;
        widths[pos]         = imageInfo.width;
        heights[pos]        = imageInfo.height;
        fileNames[pos]      = imageInfo.fileName() + '.' + imageInfo.actualExtension;

        pos++;
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // interface java.lang.Cloneable
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Generates a <B STYLE='color: red;'>Deep Copy</B> of {@code 'this'} instance.  This means
     * all internal arrays are also cloned / copied
     * 
     * @return A duplicate instance of this class, with all arrays having been copied.
     */
    public Results clone()
    { return new Results(this); }

    // Private Constructor, used only for the 'clone()' method
    private Results(Results r)
    {
        this.urls               = r.urls.clone();
        this.b64EncodedImg      = r.b64EncodedImg.clone();
        this.skipped            = r.skipped.clone();
        this.fileNames          = r.fileNames.clone();
        this.saveDirectories    = r.saveDirectories.clone();
        this.imageFormats       = r.imageFormats.clone();
        this.exceptions         = r.exceptions.clone();
        this.sizes              = r.sizes.clone();
        this.widths             = r.widths.clone();
        this.heights            = r.heights.clone();

        this.pos                = r.pos;
        this.successCounter     = r.successCounter;
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // java.lang.Object
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Checks whether {@code 'this'} instance is equal to another instance of class
     * {@code Results}.  This method performs a <B STYLE='color: red;'>Deep Equals</B> comparison
     * using the {@code equals(...)} method suite found in class' {@code java.util.Arrays}.
     * 
     * @param other This may be any Java Object, but only an instance class {@code 'Results'} has
     * any chance of being marked as <B STYLE='color: red;'>equal</B> to this instance.
     * 
     * @return {@code TRUE} if and only if {@code 'o'} has a type that's assignable to
     * {@code Results} - and if each of the internal arrays in this instance are equal to the
     * arrays in parameter {@code 'o'}.
     */
    @LinkJavaSource(handle="ResultsEquals")
    public boolean equals(Object other)
    { return ResultsEquals.equals(this, other); }

    /**
     * Returns a {@code java.lang.String} representation of {@code 'this'} instance
     * @return A Java {@code String} containing the data inside this class.
     */
    @LinkJavaSource(handle="ResultsToString")
    public String toString()
    { return ResultsToString.run(this); }

    /**
     * Java's hash-code requirement.  The code is computed by summing the first 10 {@link #sizes}
     * array elements.
     * 
     * @return A hash-code that may be used when storing this node in a java sorted-collection.
     */
    public int hashCode()
    {
       int sum = 0;

       for (int i=0; (i < 10) && (i < sizes.length); i++) sum += sizes[i];

       return sum;
    }
}