com.univocity.api.entity.html.HtmlParserSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of univocity-html-parser-api Show documentation
Univocity HTML Parser Public API
The newest version!
package com.univocity.api.entity.html;

import com.univocity.api.*;
import com.univocity.parsers.common.*;
import com.univocity.parsers.remote.*;

/**
 * Configuration class for the {@link HtmlParser}. Properties that also exist in {@link HtmlEntitySettings} are global
 * and will be used by each entity configuration by default. Individual {@link HtmlEntitySettings} can have their own
 * specific configuration modified to override its defaults.
 *
 * @author Univocity Software Pty Ltd - [email protected]
 * @see HtmlParser
 * @see HtmlEntityList
 */
public final class HtmlParserSettings extends RemoteParserSettings {

	private int parserThreadCount = Runtime.getRuntime().availableProcessors();

	private FetchOptions fetchOptions;

	/**
	 * Creates a new {@code HtmlParserSettings}, which will process
	 * an input to produce records for entities defined by a {@link HtmlEntityList}.  The
	 * {@link HtmlEntityList} is used to manage {@link HtmlEntitySettings} for each entity whose records
	 * will be parsed.
	 */
	public HtmlParserSettings() {
	}

	/**
	 * Creates a new {@link HtmlPaginator} and returns it. Used by {@link #getPaginator()}.
	 *
	 * @return the {@link HtmlPaginator} that was created
	 */
	@Override
	protected HtmlPaginator newPaginator(RemoteParserSettings parserSettings) {
		return new HtmlPaginator((HtmlParserSettings) parserSettings);
	}

	/**
	 * Configures a {@link HtmlPaginator} to handle multiple pages of remote content that needs to parsed.
	 *
	 * @param paginator a {@link HtmlPaginator} to be associated with the current {@code HtmlParserSettings}
	 */
	public final void setPaginator(HtmlPaginator paginator) {
		this.paginator = paginator;
	}


	/**
	 * Returns the {@link HtmlPaginator} associated with this {@code HtmlParserSettings}
	 *
	 * @return the {@link HtmlPaginator} stored within this {@code HtmlParserSettings}
	 */
	public final HtmlPaginator getPaginator() {
		return (HtmlPaginator) super.getPaginator();
	}


	/**
	 * Returns the maximum number of threads used by the parser when processing data of multiple entities from
	 * the same HTML input.
	 *
	 * Defaults to the number of available processors available to the JVM (via `Runtime.getRuntime().availableProcessors()`)
	 *
	 * @return the number of threads used by the parser.
	 */
	public final int getParserThreadCount() {
		return parserThreadCount <= 0 ? 1 : parserThreadCount;
	}

	/**
	 * Explicitly defines a maximum number of threads that should be used by the parser when processing data of
	 * multiple entities from the same HTML input.
	 *
	 * By default, to the number of available processors available to the JVM will be used (via `Runtime.getRuntime().availableProcessors()`)
	 *
	 * @param parserThreadCount the maximum number of threads to use
	 */
	@Range(min = 1, max = 16)
	@UI(order = 3)
	public final void setParserThreadCount(int parserThreadCount) {
		if (parserThreadCount <= 0) {
			parserThreadCount = 1;
		}
		this.parserThreadCount = parserThreadCount;
	}

	@Override
	public String getDefaultFileExtension() {
		return "html";
	}

	@Override
	protected CommonParserSettings createGlobalSettings() {
		return createEmptyGlobalSettings();
	}

	@Override
	protected HtmlParserSettings clone() {
		HtmlParserSettings out = (HtmlParserSettings) super.clone();
		if(fetchOptions != null){
			out.fetchOptions = this.fetchOptions.clone();
		}
		return out;
	}

	public final FetchOptions getFetchOptions() {
		return fetchOptions;
	}

	public final boolean fetchResourcesBeforeParsingEnabled(){
		return fetchOptions != null;
	}

	public final void fetchResourcesBeforeParsing(FetchOptions fetchOptions) {
		this.fetchOptions = fetchOptions;
	}
}