com.univocity.api.entity.html

Class HtmlParserSettings

java.lang.Object

com.univocity.parsers.common.EntityParserSettings<S,L,C>

com.univocity.parsers.remote.RemoteParserSettings<com.univocity.parsers.common.CommonParserSettings,HtmlEntityList,HtmlParsingContext>

com.univocity.api.entity.html.HtmlParserSettings

All Implemented Interfaces:

Cloneable

public final class HtmlParserSettings
extends com.univocity.parsers.remote.RemoteParserSettings<com.univocity.parsers.common.CommonParserSettings,HtmlEntityList,HtmlParsingContext>

Configuration class for the HtmlParser. Properties that also exist in HtmlEntitySettings are global and will be used by each entity configuration by default. Individual HtmlEntitySettings can have their own specific configuration modified to override its defaults.

Author:

uniVocity Software Pty Ltd - dev@univocity.com

See Also:

HtmlParser, HtmlEntityList

Field Summary

Fields inherited from class com.univocity.parsers.remote.RemoteParserSettings

downloadBeforeParsingEnabled, paginator

Fields inherited from class com.univocity.parsers.common.EntityParserSettings

entitiesToRead, entitiesToSkip, globalSettings

Constructor Summary

Constructors

Constructor and Description
HtmlParserSettings() Creates a new HtmlParserSettings, which will process an input to produce records for entities defined by a HtmlEntityList.

Method Summary

Modifier and Type	Method and Description
protected HtmlParserSettings	clone()
protected com.univocity.parsers.common.CommonParserSettings	createGlobalSettings()
void	fetchResourcesBeforeParsing(FetchOptions fetchOptions)
boolean	fetchResourcesBeforeParsingEnabled()
String	getDefaultFileExtension()
FetchOptions	getFetchOptions()
HtmlPaginator	getPaginator() Returns the HtmlPaginator associated with this HtmlParserSettings
int	getParserThreadCount() Returns the maximum number of threads used by the parser when processing data of multiple entities from the same HTML input.
protected HtmlPaginator	newPaginator(com.univocity.parsers.remote.RemoteParserSettings parserSettings) Creates a new HtmlPaginator and returns it.
void	setPaginator(HtmlPaginator paginator) Configures a HtmlPaginator to handle multiple pages of remote content that needs to parsed.
void	setParserThreadCount(int 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.

Methods inherited from class com.univocity.parsers.remote.RemoteParserSettings

clearFileNameParameters, getBatchId, getDownloadContentDirectory, getDownloadListener, getDownloadThreads, getEmptyValue, getExecutorService, getFileNameParameter, getFileNameParameters, getFileNamePattern, getNesting, getParseDate, getRemoteInterval, getTextEncoding, ignoreFollowingErrors, isColumnReorderingEnabled, isDownloadBeforeParsingEnabled, isDownloadEnabled, isDownloadOverwritingEnabled, isIgnoreFollowingErrors, setBatchId, setColumnReorderingEnabled, setDownloadBeforeParsingEnabled, setDownloadContentDirectory, setDownloadContentDirectory, setDownloadEnabled, setDownloadListener, setDownloadOverwritingEnabled, setDownloadThreads, setEmptyValue, setExecutorService, setFileNameParameter, setFileNamePattern, setNesting, setPaginator, setParseDate, setParseDate, setParseDate, setRemoteInterval, setTextEncoding, setTextEncoding

Methods inherited from class com.univocity.parsers.common.EntityParserSettings

addEntitiesToRead, addEntitiesToRead, addEntitiesToSkip, addEntitiesToSkip, createEmptyGlobalSettings, getEntitiesToRead, getEntitiesToSkip, getErrorContentLength, getNullValue, getProcessorErrorHandler, getTrimLeadingWhitespaces, getTrimTrailingWhitespaces, setEntitiesToRead, setEntitiesToRead, setEntitiesToSkip, setEntitiesToSkip, setErrorContentLength, setNullValue, setProcessorErrorHandler, setTrimLeadingWhitespaces, setTrimTrailingWhitespaces, shouldRead, shouldSkip, trimValues

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HtmlParserSettings

public HtmlParserSettings()

Creates a new HtmlParserSettings, which will process an input to produce records for entities defined by a HtmlEntityList. The HtmlEntityList is used to manage HtmlEntitySettings for each entity whose records will be parsed.

Method Detail

newPaginator

protected HtmlPaginator newPaginator(com.univocity.parsers.remote.RemoteParserSettings parserSettings)

Creates a new HtmlPaginator and returns it. Used by getPaginator().

Specified by:

newPaginator in class com.univocity.parsers.remote.RemoteParserSettings<com.univocity.parsers.common.CommonParserSettings,HtmlEntityList,HtmlParsingContext>

Returns:

the HtmlPaginator that was created

setPaginator

public final void setPaginator(HtmlPaginator paginator)

Configures a HtmlPaginator to handle multiple pages of remote content that needs to parsed.

Parameters:

paginator - a HtmlPaginator to be associated with the current HtmlParserSettings

getPaginator

public final HtmlPaginator getPaginator()

Returns the HtmlPaginator associated with this HtmlParserSettings

Overrides:

getPaginator in class com.univocity.parsers.remote.RemoteParserSettings<com.univocity.parsers.common.CommonParserSettings,HtmlEntityList,HtmlParsingContext>

Returns:

the HtmlPaginator stored within this HtmlParserSettings

getParserThreadCount

public final int getParserThreadCount()

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())

Returns:

the number of threads used by the parser.

setParserThreadCount

public final void setParserThreadCount(int 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())

Parameters:

parserThreadCount - the maximum number of threads to use

getDefaultFileExtension

public String getDefaultFileExtension()

Specified by:

getDefaultFileExtension in class com.univocity.parsers.remote.RemoteParserSettings<com.univocity.parsers.common.CommonParserSettings,HtmlEntityList,HtmlParsingContext>

createGlobalSettings

protected com.univocity.parsers.common.CommonParserSettings createGlobalSettings()

Specified by:

createGlobalSettings in class com.univocity.parsers.common.EntityParserSettings<com.univocity.parsers.common.CommonParserSettings,HtmlEntityList,HtmlParsingContext>

clone

protected HtmlParserSettings clone()

Overrides:

clone in class com.univocity.parsers.remote.RemoteParserSettings<com.univocity.parsers.common.CommonParserSettings,HtmlEntityList,HtmlParsingContext>

getFetchOptions

public final FetchOptions getFetchOptions()

fetchResourcesBeforeParsingEnabled

public final boolean fetchResourcesBeforeParsingEnabled()

fetchResourcesBeforeParsing

public final void fetchResourcesBeforeParsing(FetchOptions fetchOptions)