source: trunk/autoquest-plugin-guitar/src/main/java/de/ugoe/cs/autoquest/plugin/guitar/GUITARTestCaseParser.java @ 927

//   Copyright 2012 Georg-August-Universität Göttingen, Germany
//
//   Licensed under the Apache License, Version 2.0 (the "License");
//   you may not use this file except in compliance with the License.
//   You may obtain a copy of the License at
//
//       http://www.apache.org/licenses/LICENSE-2.0
//
//   Unless required by applicable law or agreed to in writing, software
//   distributed under the License is distributed on an "AS IS" BASIS,
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//   See the License for the specific language governing permissions and
//   limitations under the License.

package de.ugoe.cs.autoquest.plugin.guitar;

import java.io.File;
import java.util.LinkedList;
import java.util.List;

import de.ugoe.cs.autoquest.eventcore.Event;
import de.ugoe.cs.autoquest.plugin.guitar.eventcore.GUITAREventTarget;
import de.ugoe.cs.autoquest.plugin.guitar.eventcore.GUITAREventType;
import de.ugoe.cs.autoquest.plugin.guitar.eventcore.GUITARReplayable;
import edu.umd.cs.guitar.model.IO;
import edu.umd.cs.guitar.model.data.EFG;
import edu.umd.cs.guitar.model.data.EventType;
import edu.umd.cs.guitar.model.data.StepType;
import edu.umd.cs.guitar.model.data.TestCase;

/**
 * <p>
 * Parser for GUITAR test case files.
 * </p>
 * 
 * @author Steffen Herbold
 * @version 1.0
 */
public class GUITARTestCaseParser {

        /**
         * <p>
         * Name of the EFG file for the application the test cases that are parsed
         * are generated for.
         * </p>
         */
        private String efgFileName = null;

        /**
         * <p>
         * Internal handle to the parsed EFG.
         * </p>
         */
        private EFG efg = null;

        /**
         * <p>
         * Constructor. Creates a new GUITARTestCaseParser. No EFG file is
         * associated with this parser.
         * </p>
         */
        public GUITARTestCaseParser() {

        }

        /**
         * <p>
         * Constructor. Creates a new GUITARTestCaseParser.
         * </p>
         * 
         * @param efgFileName
         *            EFG file associated with the test cases that are parsed.
         */
        public GUITARTestCaseParser(String efgFileName) {
                this.efgFileName = efgFileName;
        }

        /**
         * <p>
         * Parses a GUITAR test case file and returns its contents as an event
         * sequence.
         * </p>
         * 
         * @param testcaseFile
         *            file that is parsed
         * @return event sequence describing the test case
         */
        public List<Event> parseTestCaseFile(File testcaseFile) {
                TestCase testcase = (TestCase) IO.readObjFromFile(
                                testcaseFile.getAbsolutePath(), TestCase.class);
                List<StepType> steps = testcase.getStep();
                List<Event> sequence = new LinkedList<Event>();
                for (StepType step : steps) {
                        String eventId = step.getEventId();
                        GUITAREventType type = new GUITAREventType(eventId);
                        GUITAREventTarget target = new GUITAREventTarget(getWidgetId(eventId));
                        Event event = new Event(type, target);
                        event.addReplayable(new GUITARReplayable(eventId));
                        sequence.add(event);
                }
                return sequence;
        }

        /**
         * <p>
         * If {@link #efgFileName} is specified, this function retrieves the
         * widgetId of the widget the event with id eventId belongs to from the EFG.
         * </p>
         * 
         * @param eventId
         * @return widgetId of the associated widget; null if {@link #efgFileName}
         *         ==null or no widgetId for the event is found in the EFG
         */
        private String getWidgetId(String eventId) {
                if (eventId != null && efgFileName != null) {
                        if (efg == null) {
                                efg = (EFG) IO.readObjFromFile(efgFileName, EFG.class);
                        }
                        for (EventType event : efg.getEvents().getEvent()) {
                                if (eventId.equals(event.getEventId())) {
                                        return event.getWidgetId();
                                }
                        }
                }
                return null;
        }
}