org.freaknet.gtrends.api.GoogleTrendsCsvParser.java Source code

Introduction

Here is the source code for org.freaknet.gtrends.api.GoogleTrendsCsvParser.java

Source

/**
 * Copyright (C) 2013 Marco Tizzoni <marco.tizzoni@gmail.com>
 *
 * This file is part of j-google-trends-api
 *
 *     j-google-trends-api 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.
 *
 *     j-google-trends-api 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 j-google-trends-api.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.freaknet.gtrends.api;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.StringReader;
import java.util.ArrayList;
import java.util.LinkedList;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.commons.configuration.ConfigurationException;

/**
 * Parse the CSV as provided by the CSV Download functionality in Google Trends.
 *
 * @author Marco Tizzoni <marco.tizzoni@gmail.com>
 */
public class GoogleTrendsCsvParser {

    private static final String SECTION_TOP_SEARCHES_FOR = "Top searches for";
    private final String _csv;
    private String _separator;

    /**
     *
     * @param csv
     * @throws org.apache.commons.configuration.ConfigurationException
     */
    public GoogleTrendsCsvParser(String csv) throws ConfigurationException {
        this._csv = csv;
        this._separator = GoogleConfigurator.getConfiguration().getString("google.csv.separator");
    }

    /**
     * Gets the specified section from the CSV.
     *
     * @param section Section of the CSV to retrieve
     * @param header If the section has a header. If <code>true</code> the first
     * line will be skipped.
     * @return content The content of the section
     */
    public String getSectionAsString(String section, boolean header) {
        String ret = null;
        Logger.getLogger(GoogleConfigurator.getLoggerPrefix()).log(Level.FINE, "Parsing CSV for section: {0}",
                section);

        Pattern startSectionPattern = Pattern.compile("^" + section + ".*$", Pattern.MULTILINE);
        Matcher matcher = startSectionPattern.matcher(_csv);

        if (matcher.find()) {
            ret = _csv.subSequence(matcher.start(), _csv.length()).toString();

            int end = ret.length();

            Pattern endSectionPattern = Pattern.compile("\n\n", Pattern.MULTILINE);
            matcher = endSectionPattern.matcher(ret);
            if (matcher.find()) {
                end = matcher.start();
            }

            ret = ret.subSequence(0, end).toString().substring(ret.indexOf('\n') + 1);

            if (header) {
                ret = ret.substring(ret.indexOf('\n') + 1);
            }
        } else {
            Logger.getLogger(GoogleConfigurator.getLoggerPrefix()).log(Level.WARNING,
                    "Writing the full CSV file. Section not found: #{0}", section);
            return "";
        }

        return ret;
    }

    /**
     * Gets the specified section from the CSV as list of <code>String[]</code>.
     *
     * @param section Section of the CSV to retrieve
     * @param header If the section has a header. If <code>true</code> the first
     * line will be skipped.
     * @param fieldSep Field _separator for each line
     * @return An <code>ArrayList</code> of <code>String[]</code> where each
     * element in the <code>ArrayList</code> is a row and each <code>String</code>
     * is a column
     * @throws IOException
     */
    public List<String[]> getSectionAsStringArrayList(String section, boolean header, String fieldSep)
            throws IOException {
        List<String[]> ret = new ArrayList<String[]>();
        BufferedReader r = new BufferedReader(new StringReader(getSectionAsString(section, header)));

        String line;
        while ((line = r.readLine()) != null) {
            ret.add(line.split(fieldSep));
        }

        return ret;
    }

    /**
     * Retrieve the CSV section as list of <code>String</code>.
     *
     * @param section Section of the CSV to retrieve
     * @param header If the section has a header. If <code>true</code> the first
     * line will be skipped.
     * @param fieldSep Field _separator for each line
     * @return An <code>ArrayList</code> of <code>String</code> where each
     * <code>String</code> element in the <code>ArrayList</code> is a row
     * @throws IOException
     */
    public List<String> getSectionAsStringList(String section, boolean header, String fieldSep) throws IOException {
        List<String> ret = new ArrayList<String>();
        BufferedReader r = new BufferedReader(new StringReader(getSectionAsString(section, header)));

        String line;
        while ((line = r.readLine()) != null) {
            ret.add(line);
        }

        return ret;
    }

    /**
     * @return the _separator
     */
    public String getSeparator() {
        return _separator;
    }

    /**
     * @param separator the _separator to set
     */
    public void setSeparator(String separator) {
        this._separator = separator;
    }

    /**
     * Retrieve the whole CSV document.
     *
     * @return The CSV file.
     */
    public String getCsv() {
        return this._csv;
    }

    public LinkedList<String> getTopSearches(int max) {
        LinkedList<String> res = new LinkedList<String>();
        List<String> topSearches;
        try {
            topSearches = getSectionAsStringList(SECTION_TOP_SEARCHES_FOR, false, _separator);
        } catch (IOException ex) {
            Logger.getLogger(GoogleTrendsCsvParser.class.getName()).log(Level.WARNING,
                    "Cannot find Top Search section", ex);
            return res;
        }
        for (String col : topSearches) {
            res.add(col.split(_separator)[0]);
            if (res.size() >= max) {
                return res;
            }
        }
        return res;
    }
}