/*
 * Copyright (c) 2003-2010 The Regents of the University of California.
 * All rights reserved.
 *
 * '$Author: crawl $'
 * '$Date: 2012-11-26 22:23:27 +0000 (Mon, 26 Nov 2012) $' 
 * '$Revision: 31127 $'
 * 
 * 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.reporting.roml;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

import javax.swing.DefaultListModel;

import org.kepler.objectmanager.lsid.KeplerLSID;
import org.kepler.objectmanager.lsid.LSIDGenerator;
import org.kepler.reporting.rio.Item;
import org.kepler.reporting.rio.ItemLabel;
import org.kepler.reporting.rio.ItemValue;
import org.kepler.reporting.rio.ReportSection;

import ptolemy.actor.gui.TableauFrame;


public class ReportLayout implements Serializable {
        
        protected KeplerLSID lsid = null;
        protected String name;
        protected String title = "";
        protected String headerGraphic;
        protected KeplerLSID workflowLsid;
        protected List<ReportSection> sections = new ArrayList<ReportSection>();

        private boolean modified = false;
        private boolean locked = false;
        private DefaultListModel dlm = new DefaultListModel();
        
        
        public ReportLayout() {
                sections.add(new ReportSection());
                if (lsid == null){
                        try {
                                lsid = LSIDGenerator.getInstance().getNewLSID();
                        } catch (Exception e) {
                                // TODO Auto-generated catch block
                                e.printStackTrace();
                        }
                }
        }
        
        public boolean isBlank() {
                //no items and no title
                boolean empty = 
                        (
                        this.getSections().get(0).getColumns().get(0).getItems().isEmpty() 
                        && 
                        (this.getTitle() == null || this.getTitle().length() == 0)
                        );
                return empty;
        }
        
        public boolean isModified() {
                return modified;
        }
        

        /**
         * Mark TableauFrame modified so user will be prompted to save,
         * and increment ReportLayout LSID. This is a bit of a hack.
         * @param tableauFrame
         */
        public void setModified(TableauFrame tableauFrame) {
                tableauFrame.setModified(true);
                incrementLSID();
        }
        
        private void incrementLSID() {
                if (lsid.isLocalToInstance()){
                        lsid = LSIDGenerator.getInstance().updateLsidRevision(lsid);
                }
                else{
                        //TODO maintain referral list - currently just throwing away old LSID. 
                        try {
                                lsid = LSIDGenerator.getInstance().getNewLSID();
                        } catch (Exception e) {
                                // TODO Auto-generated catch block
                                e.printStackTrace();
                        }
                }
        }
        
        public boolean isLocked() {
                return locked;
        }
        
        public void setLocked(boolean flag) {
                locked = flag;
        }
        
        public KeplerLSID getLsid() {
                return lsid;
        }

        public void setLsid(KeplerLSID lsid) {
                this.lsid = lsid;
        }

        public KeplerLSID getWorkflowLSID() {
                return workflowLsid;
        }

        public void setWorkflowLSID(KeplerLSID workflowLsid) {
                this.workflowLsid = workflowLsid;
        }

        public String getName() {
                return name;
        }

        public void setName(String name) {
                this.name = name;
        }

        public List<ReportSection> getSections() {
                return sections;
        }
        
        public String getTitle() {
                return title;
        }
        
        public void setTitle(String title) {
                this.title = title;
        }
        
        public String getHeaderGraphic() {
                return headerGraphic;
        }

        public void setHeaderGraphic(String headerGraphic) {
                this.headerGraphic = headerGraphic;
        }

        public DefaultListModel getAllItemsAsListModel() {
                dlm.clear();
                //items
                List<Item> items = this.getSections().get(0).getColumns().get(0).getItems();
                for (int i = 0; i < items.size(); i++) {
                        Item item = items.get(i);
                        //labels (does not take into consideration the placement/properties)
                        dlm.add(i, item.getName());
                }
                
                return dlm;
        }
        
        public String toString() {
                
                StringBuffer buf = new StringBuffer();
                buf.append(getTitle());
                //items
                List<Item> items = this.getSections().get(0).getColumns().get(0).getItems();
                for (int i = 0; i < items.size(); i++) {
                        //labels (does not take into consideration the placement/properties)
                        List<ItemLabel> labels = items.get(i).getLabels();
                        for (int k = 0; k < labels.size(); k++) {
                                buf.append(labels.get(k).getValue().toString());
                        }
                        //values
                        List<ItemValue> values = items.get(i).getValues();
                        for (int j = 0; j < values.size(); j++) {
                                buf.append(values.get(j).getValue().toString());
                        }
                }
                
                return buf.toString();
        }
        
}