AbstractWebElementContext.java

/*
 * Copyright 2012-2014 eBay Software Foundation and selendroid committers.
 * 
 * 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 io.selendroid.server.model.internal;

import io.selendroid.server.common.exceptions.SelendroidException;
import io.selendroid.server.model.AndroidElement;
import io.selendroid.server.model.AndroidWebElement;
import io.selendroid.server.model.By;
import io.selendroid.server.model.KnownElements;
import io.selendroid.server.model.SearchContext;
import io.selendroid.server.model.SelendroidWebDriver;
import io.selendroid.server.model.By.ByClass;
import io.selendroid.server.model.By.ById;
import io.selendroid.server.model.By.ByLinkText;
import io.selendroid.server.model.By.ByPartialLinkText;
import io.selendroid.server.model.By.ByTagName;
import io.selendroid.server.model.By.ByXPath;

import java.util.ArrayList;
import java.util.List;

import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;

import android.webkit.WebView;

public abstract class AbstractWebElementContext
    implements
      SearchContext,
      FindsByTagName,
      FindsByName,
      FindsById,
      FindsByText,
      FindsByXPath,
      FindsByPartialText,
      FindsByClass {
  protected static final String LOCATOR_ID = "id";
  protected static final String LOCATOR_LINK_TEXT = "linkText";
  protected static final String LOCATOR_PARTIAL_LINK_TEXT = "partialLinkText";
  protected static final String LOCATOR_NAME = "name";
  protected static final String LOCATOR_TAG_NAME = "tagName";
  protected static final String LOCATOR_XPATH = "xpath";
  protected static final String LOCATOR_CSS_SELECTOR = "css";
  protected static final String LOCATOR_CLASS_NAME = "className";

  protected KnownElements knownElements;
  protected volatile WebView view;
  protected SelendroidWebDriver driver = null;

  public AbstractWebElementContext(KnownElements knownElements, WebView webview,
      SelendroidWebDriver driver) {
    if (knownElements == null) {
      throw new IllegalArgumentException("knowElements instance is null");
    }
    if (webview == null) {
      throw new IllegalArgumentException("webview instance is null");
    }
    this.knownElements = knownElements;
    this.view = webview;
    this.driver = driver;
  }

  protected List<AndroidElement> replyElements(JSONArray result) {
    List<AndroidElement> elements = new ArrayList<AndroidElement>();
    if (result == null) {
      return elements;
    }

    try {
      if (result.length() > 0) {
        for (int i = 0; i < result.length(); i++) {
          JSONObject element = result.getJSONObject(i);
          String id = element.getString("ELEMENT");
          elements.add(newAndroidWebElementById(id));
        }
      }
    } catch (JSONException e) {
      throw new SelendroidException(e);
    }
    return elements;
  }

  protected AndroidElement replyElement(JSONObject result) {
    if (result == null) {
      return null;
    }
    String id;
    try {
      id = result.getString("ELEMENT");
      return newAndroidWebElementById(id);
    } catch (JSONException e) {
      throw new SelendroidException(e);
    }
  }

  public AndroidWebElement newAndroidWebElementById(String id) {
    AndroidWebElement element = new AndroidWebElement(id, view, driver, knownElements);
    knownElements.add(element);
    return element;
  }

  public AndroidWebElement getElementTree() {
    throw new UnsupportedOperationException(
        "Logging the element tree of a webview is currently not supported.");
  }

  @Override
  public List<AndroidElement> findElements(By by) {
    if (by instanceof ById) {
      return findElementsById(by.getElementLocator());
    } else if (by instanceof ByTagName) {
      return findElementsByTagName(by.getElementLocator());
    } else if (by instanceof ByLinkText) {
      return findElementsByText(by.getElementLocator());
    } else if (by instanceof ByPartialLinkText) {
      return findElementsByPartialText(by.getElementLocator());
    } else if (by instanceof ByXPath) {
      return findElementsByXPath(by.getElementLocator());
    } else if (by instanceof ByClass) {
      return findElementsByClass(by.getElementLocator());
    } else if (by instanceof By.ByName) {
      return findElementsByName(by.getElementLocator());
    } else if (by instanceof By.ByCssSelector) {
      return findElementsByCssSelector(by.getElementLocator());
    }
    throw new UnsupportedOperationException(String.format(
        "By locator %s is curently not supported!", by.getClass().getSimpleName()));
  }

  @Override
  public AndroidElement findElement(By by) {
    if (by instanceof By.ById) {
      return findElementById(by.getElementLocator());
    } else if (by instanceof By.ByXPath) {
      return findElementByXPath(by.getElementLocator());
    } else if (by instanceof By.ByLinkText) {
      return findElementByText(by.getElementLocator());
    } else if (by instanceof ByPartialLinkText) {
      return findElementByPartialText(by.getElementLocator());
    } else if (by instanceof By.ByName) {
      return findElementByName(by.getElementLocator());
    } else if (by instanceof By.ByClass) {
      return findElementByClass(by.getElementLocator());
    } else if (by instanceof By.ByCssSelector) {
      return findElementByCssSelector(by.getElementLocator());
    }
    throw new UnsupportedOperationException(String.format(
        "By locator %s is curently not supported!", by.getClass().getSimpleName()));
  }

  @Override
  public AndroidElement findElementById(String id) {
    return lookupElement(LOCATOR_ID, id);
  }

  @Override
  public List<AndroidElement> findElementsById(String id) {
    return lookupElements(LOCATOR_ID, id);
  }

  @Override
  public AndroidElement findElementByTagName(String using) {
    return lookupElement(LOCATOR_TAG_NAME, using);
  }

  @Override
  public AndroidElement findElementByPartialText(String using) {
    return lookupElement(LOCATOR_PARTIAL_LINK_TEXT, using);
  }

  @Override
  public List<AndroidElement> findElementsByPartialText(String using) {
    return lookupElements(LOCATOR_PARTIAL_LINK_TEXT, using);
  }

  @Override
  public List<AndroidElement> findElementsByTagName(String using) {
    return lookupElements(LOCATOR_TAG_NAME, using);
  }

  @Override
  public AndroidElement findElementByText(String using) {
    return lookupElement(LOCATOR_LINK_TEXT, using);
  }

  @Override
  public List<AndroidElement> findElementsByText(String using) {
    return lookupElements(LOCATOR_LINK_TEXT, using);
  }

  public AndroidElement findElementByXPath(String using) {
    return lookupElement(LOCATOR_XPATH, using);
  }

  public List<AndroidElement> findElementsByXPath(String using) {
    return lookupElements(LOCATOR_XPATH, using);
  }

  public AndroidElement findElementByCssSelector(String using) {
    return lookupElement(LOCATOR_CSS_SELECTOR, using);
  }

  public List<AndroidElement> findElementsByCssSelector(String using) {
    return lookupElements(LOCATOR_CSS_SELECTOR, using);
  }

  public AndroidElement findElementByName(String using) {
    return lookupElement(LOCATOR_NAME, using);
  }

  public List<AndroidElement> findElementsByName(String using) {
    return lookupElements(LOCATOR_NAME, using);
  }

  @Override
  public AndroidElement findElementByClass(String using) {
    return lookupElement(LOCATOR_CLASS_NAME, using);
  }

  @Override
  public List<AndroidElement> findElementsByClass(String using) {
    return lookupElements(LOCATOR_CLASS_NAME, using);
  }

  protected abstract AndroidElement lookupElement(String strategy, String locator);

  protected abstract List<AndroidElement> lookupElements(String strategy, String locator);
}