com.univocity.api.entity.html

Class HtmlEntityList

java.lang.Object

com.univocity.parsers.common.EntityList<S>

com.univocity.parsers.remote.RemoteEntityList<HtmlEntitySettings>

com.univocity.api.entity.html.HtmlEntityList

All Implemented Interfaces:

Iterable<HtmlEntitySettings>

public final class HtmlEntityList
extends com.univocity.parsers.remote.RemoteEntityList<HtmlEntitySettings>

Manages a list of HTML entities and their HtmlEntitySettings. Common configuration options shared with HtmlEntitySettings and HtmlParserSettings are inherited from the HtmlParserSettings, but can be overridden in the configuration of each individual entity.

Author:

uniVocity Software Pty Ltd - parsers@univocity.com

See Also:

HtmlParser, HtmlParserSettings, HtmlParserListener

Field Summary

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

downloadThreadPool

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

entities, originalEntityNames

Constructor Summary

Constructors

Constructor and Description
HtmlEntityList() Creates a new, empty HtmlEntityList, with a default global HtmlParserSettings configuration, which is used to provide defaults to all entity-specific settings in this list.
HtmlEntityList(HtmlParserSettings parserSettings) Creates a new, empty HtmlEntityList, applying the global HtmlParserSettings configuration, which is used to provide defaults to all entity-specific settings in this list.

Method Summary

Modifier and Type	Method and Description
HtmlPaginator	getPaginator() Returns the HtmlPaginator associated with the HtmlParserSettings of this HtmlEntityList
HtmlParserSettings	getParserSettings()
protected HtmlEntitySettings	newEntity(String entityName, HtmlEntitySettings parentEntity) Creates a new HtmlEntitySettings for an entity with the supplied name and returns it.
protected HtmlEntityList	newInstance()

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

addEntitySettings, configureEntity, getDownloadThreadPool

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

configureEntity, getEntities, getEntity, getEntityNames, iterator, removeEntity, removeEntity

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

HtmlEntityList

public HtmlEntityList()

Creates a new, empty HtmlEntityList, with a default global HtmlParserSettings configuration, which is used to provide defaults to all entity-specific settings in this list.

HtmlEntityList

public HtmlEntityList(HtmlParserSettings parserSettings)

Creates a new, empty HtmlEntityList, applying the global HtmlParserSettings configuration, which is used to provide defaults to all entity-specific settings in this list.

Parameters:

parserSettings - the global parser settings whose configuration may provide defaults for all entities defined in this list.

Method Detail

newEntity

protected final HtmlEntitySettings newEntity(String entityName,
                                             HtmlEntitySettings parentEntity)

Creates a new HtmlEntitySettings for an entity with the supplied name and returns it. Used by EntityList.configureEntity(String).

Specified by:

newEntity in class com.univocity.parsers.common.EntityList<HtmlEntitySettings>

Parameters:

entityName - the name that will be used to identify the entity

Returns:

the new settings object of the given entity.

getParserSettings

public HtmlParserSettings getParserSettings()

Overrides:

getParserSettings in class com.univocity.parsers.remote.RemoteEntityList<HtmlEntitySettings>

newInstance

protected HtmlEntityList newInstance()

Overrides:

newInstance in class com.univocity.parsers.remote.RemoteEntityList<HtmlEntitySettings>

getPaginator

public final HtmlPaginator getPaginator()

Returns the HtmlPaginator associated with the HtmlParserSettings of this HtmlEntityList

Returns:

the HtmlPaginator stored the HtmlParserSettings of this HtmlEntityList