Java tutorial
/******************************************************************************* * xFramium * * Copyright 2016 by Moreland Labs, Ltd. (http://www.morelandlabs.com) * * Some open source application is free software: you can redistribute * it and/or modify it under the terms of the GNU General Public * License as published by the Free Software Foundation, either * version 3 of the License, or (at your option) any later version. * * Some open source application 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 General Public License for more details. * * You should have received a copy of the GNU General Public License * along with xFramium. If not, see <http://www.gnu.org/licenses/>. * * @license GPL-3.0+ <http://spdx.org/licenses/GPL-3.0+> *******************************************************************************/ package org.xframium.page.keyWord.step; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.xframium.page.keyWord.KeyWordStep; import org.xframium.page.keyWord.KeyWordStep.StepFailure; import org.xframium.page.keyWord.KeyWordStep.ValidationType; import org.xframium.page.keyWord.step.spi.KWSAddDevice; import org.xframium.page.keyWord.step.spi.KWSAlert; import org.xframium.page.keyWord.step.spi.KWSAlign; import org.xframium.page.keyWord.step.spi.KWSAt; import org.xframium.page.keyWord.step.spi.KWSAttribute; import org.xframium.page.keyWord.step.spi.KWSBreak; import org.xframium.page.keyWord.step.spi.KWSBrowser; import org.xframium.page.keyWord.step.spi.KWSCache; import org.xframium.page.keyWord.step.spi.KWSCall; import org.xframium.page.keyWord.step.spi.KWSCall2; import org.xframium.page.keyWord.step.spi.KWSCheckColor; import org.xframium.page.keyWord.step.spi.KWSClick; import org.xframium.page.keyWord.step.spi.KWSCommand; import org.xframium.page.keyWord.step.spi.KWSCompare; import org.xframium.page.keyWord.step.spi.KWSContrastRatio; import org.xframium.page.keyWord.step.spi.KWSDevice; import org.xframium.page.keyWord.step.spi.KWSDumpState; import org.xframium.page.keyWord.step.spi.KWSElse; import org.xframium.page.keyWord.step.spi.KWSEmail; import org.xframium.page.keyWord.step.spi.KWSEnabled; import org.xframium.page.keyWord.step.spi.KWSExecJS; import org.xframium.page.keyWord.step.spi.KWSExecWS; import org.xframium.page.keyWord.step.spi.KWSExists; import org.xframium.page.keyWord.step.spi.KWSFocus; import org.xframium.page.keyWord.step.spi.KWSFork; import org.xframium.page.keyWord.step.spi.KWSFunction; import org.xframium.page.keyWord.step.spi.KWSGesture; import org.xframium.page.keyWord.step.spi.KWSLoop; import org.xframium.page.keyWord.step.spi.KWSMath; import org.xframium.page.keyWord.step.spi.KWSMouse; import org.xframium.page.keyWord.step.spi.KWSNavigate; import org.xframium.page.keyWord.step.spi.KWSOperator; import org.xframium.page.keyWord.step.spi.KWSReport; import org.xframium.page.keyWord.step.spi.KWSReturn; import org.xframium.page.keyWord.step.spi.KWSSQL; import org.xframium.page.keyWord.step.spi.KWSSet; import org.xframium.page.keyWord.step.spi.KWSSetContentKey; import org.xframium.page.keyWord.step.spi.KWSString; import org.xframium.page.keyWord.step.spi.KWSString2; import org.xframium.page.keyWord.step.spi.KWSSync; import org.xframium.page.keyWord.step.spi.KWSValue; import org.xframium.page.keyWord.step.spi.KWSVisible; import org.xframium.page.keyWord.step.spi.KWSVisual; import org.xframium.page.keyWord.step.spi.KWSWait; import org.xframium.page.keyWord.step.spi.KWSWaitFor; import org.xframium.page.keyWord.step.spi.KWSWindow; import com.xframium.serialization.SerializationManager; import com.xframium.serialization.json.ReflectionSerializer; // TODO: Auto-generated Javadoc /** * A factory for creating KeyWordStep objects. */ public class KeyWordStepFactory { /** The singleton. */ private static KeyWordStepFactory singleton = new KeyWordStepFactory(); /** * Instance. * * @return the key word step factory */ public static KeyWordStepFactory instance() { return singleton; } /** The step map. */ private Map<String, Class> stepMap = new HashMap<String, Class>(20); private Map<Class, String> classMap = new HashMap<Class, String>(20); /** The log. */ private Log log = LogFactory.getLog(KeyWordStepFactory.class); public String getKW(Class currentClass) { return classMap.get(currentClass); } /** * Instantiates a new key word step factory. */ private KeyWordStepFactory() { initializeDefaults(); } public List<KeyWordStep> getSupportedKeywords() { List<KeyWordStep> supportedKeywords = new ArrayList<KeyWordStep>(20); for (Class keyword : stepMap.values()) { try { supportedKeywords.add((KeyWordStep) keyword.newInstance()); } catch (Exception e) { } } return supportedKeywords; } /** * Initialize defaults. */ private void initializeDefaults() { addKeyWord("CALL", KWSCall.class); addKeyWord("CALL2", KWSCall2.class); addKeyWord("CLICK", KWSClick.class); addKeyWord("EXISTS", KWSExists.class); addKeyWord("FUNCTION", KWSFunction.class); addKeyWord("GESTURE", KWSGesture.class); addKeyWord("RETURN", KWSReturn.class); addKeyWord("SET", KWSSet.class); addKeyWord("GET", KWSValue.class); addKeyWord("WAIT", KWSWait.class); addKeyWord("WAIT_FOR", KWSWaitFor.class); addKeyWord("ATTRIBUTE", KWSAttribute.class); addKeyWord("LOOP", KWSLoop.class); addKeyWord("BREAK", KWSBreak.class); addKeyWord("DEVICE", KWSDevice.class); addKeyWord("FORK", KWSFork.class); addKeyWord("VISIBLE", KWSVisible.class); addKeyWord("VERIFY_COLOR", KWSCheckColor.class); addKeyWord("VERIFY_CONTRAST", KWSContrastRatio.class); addKeyWord("WINDOW", KWSWindow.class); addKeyWord("EXECJS", KWSExecJS.class); addKeyWord("EXECWS", KWSExecWS.class); addKeyWord("COMPARE", KWSCompare.class); addKeyWord("STRING", KWSString.class); addKeyWord("STRING2", KWSString2.class); addKeyWord("MATH", KWSMath.class); addKeyWord("MOUSE", KWSMouse.class); addKeyWord("CACHE", KWSCache.class); addKeyWord("REPORT", KWSReport.class); addKeyWord("ADD_DEVICE", KWSAddDevice.class); addKeyWord("HAS_FOCUS", KWSFocus.class); addKeyWord("ALIGN", KWSAlign.class); addKeyWord("SYNC", KWSSync.class); addKeyWord("AT", KWSAt.class); addKeyWord("ELSE", KWSElse.class); addKeyWord("STATE", KWSDumpState.class); addKeyWord("ALERT", KWSAlert.class); addKeyWord("SQL", KWSSQL.class); addKeyWord("OPERATOR", KWSOperator.class); addKeyWord("NAVIGATE", KWSNavigate.class); addKeyWord("VISUAL", KWSVisual.class); addKeyWord("SET_CONTENT_KEY", KWSSetContentKey.class); addKeyWord("BROWSER", KWSBrowser.class); addKeyWord("IS_ENABLED", KWSEnabled.class); addKeyWord("ENABLED", KWSEnabled.class); addKeyWord("COMMAND", KWSCommand.class); addKeyWord("EMAIL", KWSEmail.class); } /** * Adds the key word. * * @param keyWord * the key word * @param kwImpl * the kw impl */ public void addKeyWord(String keyWord, Class kwImpl) { if (stepMap.containsKey(keyWord)) log.warn("Overwriting Keyword [" + keyWord + "] of type [" + stepMap.get(keyWord).getClass().getSimpleName() + "] with [" + kwImpl.getClass().getSimpleName()); stepMap.put(keyWord.toUpperCase(), kwImpl); classMap.put(kwImpl, keyWord); SerializationManager.instance().getDefaultAdapter().addCustomMapping(kwImpl, new ReflectionSerializer()); } /** * Creates a new KeyWordStep object. * * @param name * the name * @param pageName * the page name * @param active * the active * @param type * the type * @param linkId * the link id * @param timed * the timed * @param sFailure * the s failure * @param inverse * the inverse * @param os * the os * @param poi * the poi * @param threshold * the threshold * @param description * the description * @param waitTime * the wait time * @param context * the context * @param validation * the validation * @param device * the device * @param validationType * the validation type * @return the key word step */ public KeyWordStep createStep(String name, String pageName, boolean active, String type, String linkId, boolean timed, StepFailure sFailure, boolean inverse, String os, String browser, String poi, int threshold, String description, long waitTime, String context, String validation, String device, ValidationType validationType, String tagNames, boolean startAt, boolean breakpoint, String deviceTags, String siteName) { Class kwImpl = stepMap.get(type.toUpperCase()); if (kwImpl == null) { log.error("Unknown KeyWord [" + type + "]"); System.exit(-1); } try { KeyWordStep returnValue = (KeyWordStep) kwImpl.newInstance(); returnValue.setActive(active); returnValue.setLinkId(linkId); returnValue.setName(name); returnValue.setPageName(pageName); returnValue.setTimed(timed); returnValue.setFailure(sFailure); returnValue.setInverse(inverse); returnValue.setOs(os); returnValue.setBrowser(browser); returnValue.setPoi(poi); returnValue.setThreshold(threshold); returnValue.setDescription(description); returnValue.setWait(waitTime); returnValue.setValidation(validation); returnValue.setValidationType(validationType); returnValue.setContext(context); returnValue.setDevice(device); returnValue.setTagNames(tagNames); returnValue.setStartAt(startAt); returnValue.setBreakpoint(breakpoint); returnValue.setDeviceTags(deviceTags); if (siteName != null && siteName.trim().length() > 0) returnValue.setSiteName(siteName); return returnValue; } catch (Exception e) { throw new IllegalArgumentException("Unknown KeyWord [" + type + "]", e); } } }