/**
 * 
 */
package com.grayben.riskExtractor.htmlScorer;

import java.io.IOException;
import java.io.InputStream;

/**
 * A class implementing this interface is able to process HTML from a number of sources
 * and output a representation of the readable text in that HTML, with scores attached to
 * elements of this text.
 * <p>
 * Created by Ben Gray, 2015.
 */
public interface HtmlScorer {

    /**
     * Score HTML stored locally.
     *
     * @param htmlStream the stream containing the HTML to score
     * @param charsetName the name of the charset used to encode the file
     * @param baseUri the baseURI of the HTML document
     * @return the scored text
     *
     */
	ScoredText scoreHtml(InputStream htmlStream, String charsetName, String baseUri) throws IOException;

    /**
     * Score HTML stored remotely.
     *
     * @param url the URL of the file containing the HTML to score
     * @return the scored text
     * @throws IOException
     */
	ScoredText scoreHtml(String url) throws IOException;
}

/**
 * 
 */
package com.grayben.riskExtractor.htmlScorer;

import java.io.IOException;
import java.io.InputStream;

/**
 * A class implementing this interface is able to process HTML from a number of sources
 * and output a representation of the readable text in that HTML, with scores attached to
 * elements of this text.
 * <p>
 * Created by Ben Gray, 2015.
 */
public interface HtmlScorer {

    /**
     * Score HTML stored locally.
     *
     * @param htmlStream the stream containing the HTML to score
     * @param charsetName the name of the charset used to encode the file
     * @param baseUri the baseURI of the HTML document
     * @return the scored text
     *
     */
	ScoredText scoreHtml(InputStream htmlStream, String charsetName, String baseUri) throws IOException;

    /**
     * Score HTML stored remotely.
     *
     * @param url the URL of the file containing the HTML to score
     * @return the scored text
     * @throws IOException if unable to connect to url
     */
	ScoredText scoreHtml(String url) throws IOException;
}

Add documentation for IOException thrown
Add documentation for IOException thrown
