eu.mihosoft.vrl.io.vrlx.VRLXAbstractSession Maven / Gradle / Ivy

Go to download
/* 
 * VRLXAbstractSession.java
 * 
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2007–2018 by Michael Hoffer,
 * Copyright (c) 2015–2018 G-CSC, Uni Frankfurt,
 * Copyright (c) 2009–2015 Steinbeis Forschungszentrum (STZ Ölbronn)
 * 
 * This file is part of Visual Reflection Library (VRL).
 *
 * VRL is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * as published by the Free Software Foundation.
 * 
 * see: http://opensource.org/licenses/LGPL-3.0
 *      file://path/to/VRL/src/eu/mihosoft/vrl/resources/license/lgplv3.txt
 *
 * VRL 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 Lesser General Public License for more details.
 *
 * This version of VRL includes copyright notice and attribution requirements.
 * According to the LGPL this information must be displayed even if you modify
 * the source code of VRL. Neither the VRL Canvas attribution icon nor any
 * copyright statement/attribution may be removed.
 *
 * Attribution Requirements:
 *
 * If you create derived work you must do three things regarding copyright
 * notice and author attribution.
 *
 * First, the following text must be displayed on the Canvas:
 * "based on VRL source code". In this case the VRL canvas icon must be removed.
 * 
 * Second, the copyright notice must remain. It must be reproduced in any
 * program that uses VRL.
 *
 * Third, add an additional notice, stating that you modified VRL. A suitable
 * notice might read
 * "VRL source code modified by YourName 2012".
 * 
 * Note, that these requirements are in full accordance with the LGPL v3
 * (see 7. Additional Terms, b).
 *
 * Please cite the publication(s) listed below.
 *
 * Publications:
 *
 * M. Hoffer, C. Poliwoda, & G. Wittum. (2013). Visual reflection library:
 * a framework for declarative GUI programming on the Java platform.
 * Computing and Visualization in Science, 2013, 16(4),
 * 181–192. http://doi.org/10.1007/s00791-014-0230-y
 */

package eu.mihosoft.vrl.io.vrlx;

import eu.mihosoft.vrl.io.IOUtil;
import eu.mihosoft.vrl.lang.ClassEntry;
import eu.mihosoft.vrl.lang.VCompiler;
import eu.mihosoft.vrl.lang.java.ClassEntryClassLoader;
import eu.mihosoft.vrl.reflection.CallOptionsEvaluator;
import eu.mihosoft.vrl.reflection.DefaultObjectRepresentation;
import eu.mihosoft.vrl.reflection.ObjectDescription;
import eu.mihosoft.vrl.reflection.ReferenceTask;
import eu.mihosoft.vrl.system.VClassLoader;
import eu.mihosoft.vrl.reflection.VisualCanvas;
import eu.mihosoft.vrl.reflection.VisualObject;
import eu.mihosoft.vrl.reflection.VisualObjects;
import eu.mihosoft.vrl.types.VCanvas3D;
import eu.mihosoft.vrl.visual.Canvas;
import eu.mihosoft.vrl.visual.CanvasWindow;
import eu.mihosoft.vrl.visual.Connection;
import eu.mihosoft.vrl.visual.MessageType;
import eu.mihosoft.vrl.visual.WindowGroups;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.apache.tools.ant.taskdefs.Jar;

/**
 * Format definition for the VRL reflection package.
 * @author Michael Hoffer <[email protected]>
 */
public final class VRLXAbstractSession {

    private static final DynamicFileFormat format;
    public static final String VRLX_REFLECTION =
            VRLXVisual.VRLX_BASE + "/reflection";
    public static final String CONTENT_PATH = 
            VRLXVisual.VRLX_VISUAL + "/session-code";

    static {

        format = new FileFormatTemplate(
                new DefaultIOModel(new XMLEntryFactory()));

        getVRLXFormat().addTask(CONTENT_PATH,
                new AbstractSessionTask());
    }

    // no instanciation allowed
    private VRLXAbstractSession() {
        throw new AssertionError(); // not in this class either!
    }

    /**
     * Returns the file format.
     * @return the file format
     */
    public static DynamicFileFormat getVRLXFormat() {
        return format;
    }
    
    public static IOModel getIOModel() {
        return new DefaultIOModel(new XMLEntryFactory());
    }


    public static class AbstractSessionTask implements SessionTask {

        @Override
        public TaskType getType() {
            return TaskType.LOAD_AND_SAVE;
        }

        @Override
        public boolean load(Canvas canvas, SessionEntry entry) {
            
            AbstractSession session = null;

            try {
                session = (AbstractSession) format.getModel().getFileContent(
                        entry,
                        AbstractSession.class);
            } catch (Exception ex) {
                //
            }
            if (session == null) {
                VRLXSessionController.showErrorMessage(
                        canvas, null,
                        "Error while loading AbstractSession:");
                return false;
            }
            
            VisualCanvas vCanvas =
                        VisualCanvas.asVisualCanvas(canvas);
            
            vCanvas.setSession(session);
            
            return true;
        }
        
        public AbstractSession load(SessionEntry entry) throws IOException {
            AbstractSession session = null;

            try {
                session = (AbstractSession) format.getModel().getFileContent(
                        entry,
                        AbstractSession.class);
            } catch (Exception ex) {
                //
            }
            if (session == null) {
                throw new IOException("Error while loading AbstractSession:");
            }
            
            return session;
        }

        @Override
        public boolean save(Canvas canvas, SessionEntry entry) {
            VisualCanvas vCanvas = VisualCanvas.asVisualCanvas(canvas);

            SessionEntryFile file = format.getModel().asFile(entry);

            if (file == null) {
                return false;
            }

            file.setContent(vCanvas.getSession());

            return true;
        }
        
        public boolean save(SessionEntry entry, AbstractSession session) {

            SessionEntryFile file = format.getModel().asFile(entry);

            if (file == null) {
                return false;
            }

            file.setContent(session);

            return true;
        }
    }
}