org.datacleaner.regexswap.RegexSwapClient Maven / Gradle / Ivy

Go to download
/**
 * DataCleaner (community edition)
 * Copyright (C) 2014 Neopost - Customer Information Management
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program 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.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.datacleaner.regexswap;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.http.client.HttpClient;
import org.datacleaner.util.http.HttpXmlUtils;
import org.w3c.dom.Element;
import org.w3c.dom.Node;

/**
 * Client class for the RegexSwap, which allows for easy retrieval of shared
 * regular expressions.
 * 
 * @author Kasper Sørensen
 */
public final class RegexSwapClient {

	public static final String CATEGORIES_URL = "http://datacleaner.org/ws/categories";
	public static final String REGEXES_URL = "http://datacleaner.org/ws/regexes";

	private final Map _categories = new HashMap();
	private final Map _regexes = new HashMap();
	private final HttpClient _httpClient;

	public RegexSwapClient(HttpClient httpClient) {
		_httpClient = httpClient;
	}

	public Category getCategoryByName(String name) {
		Category category = _categories.get(name);
		if (category == null) {
			refreshCategories();
			category = _categories.get(name);
		}
		return category;
	}

	public Regex getRegexByName(String name) {
		Regex regex = _regexes.get(name);
		if (regex == null) {
			refreshRegexes();
			regex = _regexes.get(name);
		}
		return regex;
	}

	public void refreshRegexes() {
		Element rootNode = HttpXmlUtils.getRootNode(_httpClient, REGEXES_URL);
		final List regexNodes = HttpXmlUtils.getChildNodesByName(rootNode, "regex");
		for (Node node : regexNodes) {
			createRegex((Element) node);
		}
	}

	public Collection getCategories() {
		if (_categories.isEmpty()) {
			refreshCategories();
		}
		return _categories.values();
	}

	public void refreshCategories() {
		Element rootNode = HttpXmlUtils.getRootNode(_httpClient, CATEGORIES_URL);
		final List categoryNodes = HttpXmlUtils.getChildNodesByName(rootNode, "category");
		for (Node categoryNode : categoryNodes) {
			final String name = HttpXmlUtils.getChildNodeText(categoryNode, "name");
			final String description = HttpXmlUtils.getChildNodeText(categoryNode, "description");
			final String detailsUrl = HttpXmlUtils.getChildNodeText(categoryNode, "detailsUrl");

			final Category category = new Category(name, description, detailsUrl);
			_categories.put(name, category);
		}
	}

	private Regex createRegex(final Element regexNode) {
		String name = HttpXmlUtils.getChildNodeText(regexNode, "name");
		String description = HttpXmlUtils.getChildNodeText(regexNode, "description");
		String expression = HttpXmlUtils.getChildNodeText(regexNode, "expression");
		String author = HttpXmlUtils.getChildNodeText(regexNode, "author");
		long timestamp = Long.parseLong(HttpXmlUtils.getChildNodeText(regexNode, "timestamp"));
		int positiveVotes = Integer.parseInt(HttpXmlUtils.getChildNodeText(regexNode, "positiveVotes"));
		int negativeVotes = Integer.parseInt(HttpXmlUtils.getChildNodeText(regexNode, "negativeVotes"));
		String detailsUrl = HttpXmlUtils.getChildNodeText(regexNode, "detailsUrl");
		List categories = new ArrayList();
		List categoriesNodes = HttpXmlUtils.getChildNodesByName(regexNode, "categories");
		if (!categoriesNodes.isEmpty()) {
			Node categoriesNode = categoriesNodes.get(0);
			List categoryNodes = HttpXmlUtils.getChildNodesByName(categoriesNode, "category");
			for (Node categoryNode : categoryNodes) {
				String categoryName = HttpXmlUtils.getText(categoryNode);
				Category category = getCategoryByName(categoryName);
				if (category != null) {
					categories.add(category);
				}
			}
		}
		Regex regex = new Regex(name, description, expression, author, timestamp, positiveVotes, negativeVotes, detailsUrl,
				categories);
		_regexes.put(name, regex);
		return regex;
	}

	public Regex refreshRegex(Regex regex) {
		String detailsUrl = regex.getDetailsUrl();
		Element regexNode = HttpXmlUtils.getRootNode(_httpClient, detailsUrl);
		regex = createRegex(regexNode);
		return regex;
	}

	public List getRegexes(Category category) {
		List regexes = new ArrayList();
		Node rootNode = HttpXmlUtils.getRootNode(_httpClient, category.getDetailsUrl());
		List regexNodes = HttpXmlUtils.getChildNodesByName(rootNode, "regex");
		for (Node regexNode : regexNodes) {

			String name = HttpXmlUtils.getChildNodeText(regexNode, "name");
			String description = HttpXmlUtils.getChildNodeText(regexNode, "description");
			String expression = HttpXmlUtils.getChildNodeText(regexNode, "expression");
			String author = HttpXmlUtils.getChildNodeText(regexNode, "author");
			long timestamp = Long.parseLong(HttpXmlUtils.getChildNodeText(regexNode, "timestamp"));
			int positiveVotes = Integer.parseInt(HttpXmlUtils.getChildNodeText(regexNode, "positiveVotes"));
			int negativeVotes = Integer.parseInt(HttpXmlUtils.getChildNodeText(regexNode, "negativeVotes"));
			String detailsUrl = HttpXmlUtils.getChildNodeText(regexNode, "detailsUrl");

			List categories;
			Regex regex = _regexes.get(name);
			if (regex == null) {
				categories = new ArrayList();
				regex = new Regex(name, description, expression, author, timestamp, positiveVotes, negativeVotes,
						detailsUrl, categories);
			} else {
				categories = regex.getCategories();
				if (!categories.contains(category)) {
					categories.add(category);
				}
			}

			_regexes.put(name, regex);

			regexes.add(regex);
		}
		return regexes;
	}
}