ISourceParser.java

/*
 * Copyright 2013 SciFY NPO <info@scify.org>.
 *
 * This product is part of the NewSum Free Software.
 * For more information about NewSum visit
 * 
 * 	http://www.scify.gr/site/en/our-projects/completed-projects/newsum-menu-en
 *
 * 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.
 * 
 * If this code or its output is used, extended, re-engineered, integrated, 
 * or embedded to any extent in another software or hardware, there MUST be 
 * an explicit attribution to this work in the resulting source code, 
 * the packaging (where such packaging exists), or user interface 
 * (where such an interface exists). 
 * The attribution must be of the form "Powered by NewSum, SciFY"
 */ 

package org.scify.NewSumServer.Server.Sources;

import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import org.apache.commons.feedparser.FeedParserException;
import org.apache.commons.feedparser.network.NetworkException;
import org.scify.NewSumServer.Server.Storage.IDataStorage;
import org.scify.NewSumServer.Server.Structures.Article;

/**
 *
 * @author George K. <gkiom@scify.org>
 */
public interface ISourceParser {

    /**
    * Fetches all the Articles that are contained in a given Feed
    * @param sLinkToFeed The URL to the Feed
    * @param sCategory The category we are interested in
    * @return A list containing all the Articles from the specified feed, category
    * @throws NetworkException
    * @throws IOException
    * @throws FeedParserException
    */
    List<Article> getNewsFromFeed(String sLinkToFeed, String sCategory)
            throws NetworkException, IOException, FeedParserException;

    /**
    * Fetches all the Articles from a given list of feeds
    * @param LinksToLoad The list of feed links
    * @param sCategory The category of interest
    * @return A list containing all the Articles
    */
    List<Article> getAllNewsByCategory(List<String> LinksToLoad, String sCategory);
    /**
    * Reads The Sources for each category and returns all Articles found
    * in one List.
    * @param Sources The Map containing all the URL Links and their assigned Category
    * @return the Articles in a List structure
    */
    List<Article> getAllArticles(HashMap<String, String> Sources);

    /**
     * Saves the full list of articles, to pass to the ArticleClusterer Class.
     */
    void saveAllArticles();
}