```
public class FeaturedDocument

                    
```
A "featured document" is "very important" and the numerical features of each node are calculated, the numerical feature can be used to locate nodes or can be used by machine learning algorithms.
FeaturedDocument is a wrapper for org.jsoup.nodes.Document, every node's numerical features are calculated by a ai.platon.pulsar.dom.features.FeatureCalculator which can be customized.
The DOM of a FeaturedDocument is immutable, no method is provided to append or insert elements or nodes.
FeaturedDocument provides a set of powerful methods to select elements, text contexts, attributes and so on:
- select: retrieves a list of elements matching the CSS query
- selectFirst: retrieves the first matching element
- selectFirstText: retrieves the text content of the first matching element
- selectFirstAttribute: retrieves the attribute value associated to the given name of the first matching element
- selectHyperlinks: retrieves all hyperlinks of elements matching the CSS query
- selectAnchors: retrieves all anchor elements matching the CSS query
- selectImages: retrieves all image elements matching the CSS query
Other methods provided include DOM traversal, node counting, document attribute retrieval, export, and so on.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`FeaturedDocument.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final Integer`	`sequence`
`private final String`	`title`
`private final String`	`location`
`private final String`	`baseUri`
`private final Element`	`head`
`private final Element`	`body`
`private final String`	`text`
`private final String`	`ownText`
`private final String`	`wholeText`
`private final String`	`html`
`private final String`	`outerHtml`
`private final Charset`	`charset`
`private final String`	`nodeName`
`private final String`	`id`
`private final String`	`className`
`private final String`	`data`
`private final List<DataNode>`	`dataNodes`
`private final List<TextNode>`	`textNodes`
`private final List<Node>`	`childNodes`
`private final String`	`prettyHtml`
`private RealVector`	`features`
`private final DocumentFragments`	`fragments`
`private final Document`	`document`

Constructor Summary

Constructors
Constructor	Description
`FeaturedDocument(String baseUri)`	The constructor
`FeaturedDocument(FeaturedDocument other)`	The constructor
`FeaturedDocument(Document document)`

Method Summary

Modifier and Type	Method	Description
`final Integer`	`getSequence()`	The process scope unique sequence.
`final String`	`getTitle()`
`final String`	`getLocation()`
`final String`	`getBaseUri()`
`final Element`	`getHead()`
`final Element`	`getBody()`
`final String`	`getText()`
`final String`	`getOwnText()`
`final String`	`getWholeText()`
`final String`	`getHtml()`
`final String`	`getOuterHtml()`
`final Charset`	`getCharset()`
`final String`	`getNodeName()`
`final String`	`getId()`
`final String`	`getClassName()`
`final String`	`getData()`
`final List<DataNode>`	`getDataNodes()`
`final List<TextNode>`	`getTextNodes()`
`final List<Node>`	`getChildNodes()`
`final String`	`getPrettyHtml()`
`final RealVector`	`getFeatures()`
`final Unit`	`setFeatures(RealVector features)`
`final DocumentFragments`	`getFragments()`
`final Document`	`getDocument()`
`final Document`	`unbox()`	Get the underlying document.
`final Boolean`	`isNil()`	Check if this document is nil.
`final Boolean`	`isInternal()`	Check if this document is internal.
`final Boolean`	`isNotInternal()`	Check if this document is internal.
`final Element`	`createElement(String tagName)`	Create a new Element, with this document's base uri.
`final String`	`guessTitle()`	Guess the document's title.
`final Unit`	`absoluteLinks()`	Make all links in the document to be absolute.
`final Elements`	`select(String query, Integer offset, Integer limit)`	Find elements that match the CSS query.
`final Elements`	`select(String query, Integer offset)`	Find elements that match the CSS query.
`final Elements`	`select(String query)`	Find elements that match the CSS query.
`final <T extends Any> List<T>`	`select(String query, Integer offset, Integer limit, Function1<Element, T> transformer)`	Find elements that match the CSS query.
`final Element`	`selectFirst(String query)`	Find the first element that match the CSS query.
`final <T extends Any> T`	`selectFirst(String query, Function1<Element, T> transformer)`	Find the first element that match the CSS query.
`final Element`	`selectFirstOrNull(String query)`	Find the first element that match the CSS query.
`final <T extends Any> T`	`selectFirstOrNull(String query, Function1<Element, T> transformer)`	Find the first element that match the CSS query.
`final Optional<Element>`	`selectFirstOptional(String query)`	Find elements that match the CSS query.
`final <T extends Any> Optional<T>`	`selectFirstOptional(String query, Function1<Element, T> transformer)`	Find elements that match the CSS query.
`final Element`	`first(String query)`
`final <T extends Any> T`	`first(String query, Function1<Element, T> transformer)`
`final String`	`selectFirstText(String query)`	Find the text content of the first element that match the CSS query.
`final String`	`selectFirstTextOrNull(String query)`	Find the text content of the first element that match the CSS query.
`final Optional<String>`	`selectFirstTextOptional(String query)`	Find the text content of the first element that match the CSS query.
`final String`	`firstText(String query)`	Find the text content of the first element that match the CSS query.
`final String`	`firstTextOrNull(String query)`	Find the text content of the first element that match the CSS query.
`final Optional<String>`	`firstTextOptional(String query)`	Find the text content of the first element that match the CSS query.
`final String`	`selectFirstAttribute(String query, String attrName, String defaultValue)`	Find the attribute value of the first element that match the CSS query.
`final String`	`selectFirstAttribute(String query, String attrName)`	Find the attribute value of the first element that match the CSS query.
`final String`	`selectFirstAttributeOrNull(String query, String attrName)`	Find the attribute value of the first element that match the CSS query.
`final Optional<String>`	`selectFirstAttributeOptional(String query, String attrName)`	Find the attribute value of the first element that match the CSS query.
`final String`	`firstAttribute(String query, String attrName, String defaultValue)`	Find the attribute value of the first element that match the CSS query.
`final String`	`firstAttribute(String query, String attrName)`	Find the attribute value of the first element that match the CSS query.
`final String`	`firstAttributeOrNull(String query, String attrName)`	Find the attribute value of the first element that match the CSS query.
`final Optional<String>`	`firstAttributeOptional(String query, String attrName)`	Find the attribute value of the first element that match the CSS query.
`final List<Hyperlink>`	`selectHyperlinks(String query, Integer offset, Integer limit)`	Find hyperlinks in elements matching the CSS query.
`final List<Hyperlink>`	`selectHyperlinks(String query, Integer offset)`	Find hyperlinks in elements matching the CSS query.
`final List<Hyperlink>`	`selectHyperlinks(String query)`	Find hyperlinks in elements matching the CSS query.
`final List<GeoAnchor>`	`selectAnchors(String query, Integer offset, Integer limit)`	Find anchor elements matching the CSS query.
`final List<GeoAnchor>`	`selectAnchors(String query, Integer offset)`	Find anchor elements matching the CSS query.
`final List<GeoAnchor>`	`selectAnchors(String query)`	Find anchor elements matching the CSS query.
`final List<String>`	`selectImages(String query, Integer offset, Integer limit)`	Find image elements matching the CSS query.
`final List<String>`	`selectImages(String query, Integer offset)`	Find image elements matching the CSS query.
`final List<String>`	`selectImages(String query)`	Find image elements matching the CSS query.
`final Unit`	`forEach(Function1<Node, Unit> action)`	Traverse the DOM and apply the action to each Node.
`final Unit`	`forEachMatching(Function1<Node, Boolean> predicate, Function1<Node, Unit> action)`	Traverse the DOM and apply the action to each Node that matches predicate.
`final Unit`	`forEachElement(Function1<Element, Unit> action)`	Traverse the DOM and apply the action to each Element.
`final Unit`	`forEachElementMatching(Function1<Element, Boolean> predicate, Function1<Element, Unit> action)`	Traverse the DOM and apply the action to each Element that matches predicate.
`final Integer`	`count(Function1<Node, Boolean> predicate)`	Count nodes matching predicate.
`final Integer`	`countElements(Function1<Element, Boolean> predicate)`	Count elements matching predicate.
`final Double`	`getFeature(Integer key)`	Retrieves the feature with the given key.
`final String`	`formatFeatures(Integer featureKeys)`	Format node features.
`final String`	`formatNamedFeatures()`	Format named node features.
`final Unit`	`removeAttrs(String attributeKeys)`	Remove attributes associated with the given keys.
`final Unit`	`removeScripts()`	Remove all script nodes in the document.
`final Unit`	`stripScripts()`	Remove all script nodes in the document.
`final Unit`	`removeStyles()`	Remove all style nodes from the document, and remove all style attributes from all elements.
`final Unit`	`stripStyles()`
`final Path`	`export()`	Export the document.
`final Path`	`exportTo(Path path)`	Export the document to the given path.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FeaturedDocument
```
FeaturedDocument(String baseUri)
```
    The constructor
    
    Parameters:
    
    baseUri - The URL where the HTML was retrieved from.
  - FeaturedDocument
```
FeaturedDocument(FeaturedDocument other)
```
    The constructor
  - FeaturedDocument
```
FeaturedDocument(Document document)
```
- Method Detail
  - getSequence
```
 final Integer getSequence()
```
    The process scope unique sequence.
  - getTitle
```
 final String getTitle()
```
  - getLocation
```
 final String getLocation()
```
  - getBaseUri
```
 final String getBaseUri()
```
  - getHead
```
 final Element getHead()
```
  - getBody
```
 final Element getBody()
```
  - getText
```
 final String getText()
```
  - getOwnText
```
 final String getOwnText()
```
  - getWholeText
```
 final String getWholeText()
```
  - getHtml
```
 final String getHtml()
```
  - getOuterHtml
```
 final String getOuterHtml()
```
  - getCharset
```
 final Charset getCharset()
```
  - getNodeName
```
 final String getNodeName()
```
  - getId
```
 final String getId()
```
  - getClassName
```
 final String getClassName()
```
  - getData
```
 final String getData()
```
  - getDataNodes
```
 final List<DataNode> getDataNodes()
```
  - getTextNodes
```
 final List<TextNode> getTextNodes()
```
  - getChildNodes
```
 final List<Node> getChildNodes()
```
  - getPrettyHtml
```
 final String getPrettyHtml()
```
  - getFeatures
```
 final RealVector getFeatures()
```
  - setFeatures
```
 final Unit setFeatures(RealVector features)
```
  - getFragments
```
 final DocumentFragments getFragments()
```
  - getDocument
```
 final Document getDocument()
```
  - unbox
```
 final Document unbox()
```
    Get the underlying document.
  - isNil
```
 final Boolean isNil()
```
    Check if this document is nil.
  - isInternal
```
 final Boolean isInternal()
```
    Check if this document is internal.
  - isNotInternal
```
 final Boolean isNotInternal()
```
    Check if this document is internal.
  - createElement
```
 final Element createElement(String tagName)
```
    Create a new Element, with this document's base uri. Does not make the new element a child of this document.
    
    Parameters:
    
    tagName - element tag name (e.g.
  - guessTitle
```
 final String guessTitle()
```
    Guess the document's title.
    The title should be guessed for some site without a <title> tag inside a <head> tag.
  - absoluteLinks
```
 final Unit absoluteLinks()
```
    Make all links in the document to be absolute.
  - select
```
@JvmOverloads() final Elements select(String query, Integer offset, Integer limit)
```
    Find elements that match the CSS query. Matched elements may include the document, or any of its children.
    This method is generally more powerful to use than the DOM-type {@code getElementBy*} methods, because multiple filters can be combined.
  - select
```
@JvmOverloads() final Elements select(String query, Integer offset)
```
    Find elements that match the CSS query. Matched elements may include the document, or any of its children.
    This method is generally more powerful to use than the DOM-type {@code getElementBy*} methods, because multiple filters can be combined.
  - select
```
@JvmOverloads() final Elements select(String query)
```
    Find elements that match the CSS query. Matched elements may include the document, or any of its children.
    This method is generally more powerful to use than the DOM-type {@code getElementBy*} methods, because multiple filters can be combined.
  - select
```
 final <T extends Any> List<T> select(String query, Integer offset, Integer limit, Function1<Element, T> transformer)
```
    Find elements that match the CSS query. Matched elements may include the document, or any of its children.
    This method is generally more powerful to use than the DOM-type {@code getElementBy*} methods, because multiple filters can be combined.
  - selectFirst
```
 final Element selectFirst(String query)
```
    Find the first element that match the CSS query. Matched element may be the document, or any of its children.
    This method is generally more powerful to use than the DOM-type {@code getElementBy*} methods, because multiple filters can be combined.
  - selectFirst
```
 final <T extends Any> T selectFirst(String query, Function1<Element, T> transformer)
```
    Find the first element that match the CSS query. Matched element may be the document, or any of its children.
    This method is generally more powerful to use than the DOM-type {@code getElementBy*} methods, because multiple filters can be combined.
  - selectFirstOrNull
```
 final Element selectFirstOrNull(String query)
```
    Find the first element that match the CSS query. Matched element may be the document, or any of its children.
    This method is generally more powerful to use than the DOM-type {@code getElementBy*} methods, because multiple filters can be combined.
  - selectFirstOrNull
```
 final <T extends Any> T selectFirstOrNull(String query, Function1<Element, T> transformer)
```
    Find the first element that match the CSS query. Matched element may be the document, or any of its children.
    This method is generally more powerful to use than the DOM-type {@code getElementBy*} methods, because multiple filters can be combined.
  - selectFirstOptional
```
 final Optional<Element> selectFirstOptional(String query)
```
    Find elements that match the CSS query. Matched elements may include the document, or any of its children.
    This method is generally more powerful to use than the DOM-type {@code getElementBy*} methods, because multiple filters can be combined.
    Return the first element, if no element matches the query, return an Optional object.
  - selectFirstOptional
```
 final <T extends Any> Optional<T> selectFirstOptional(String query, Function1<Element, T> transformer)
```
    Find elements that match the CSS query. Matched elements may include the document, or any of its children.
    This method is generally more powerful to use than the DOM-type {@code getElementBy*} methods, because multiple filters can be combined.
    Return the first element, if no element matches the query, return an Optional object.
  - first
```
@Deprecated(message = Inappropriate name, replaceWith = @ReplaceWith(imports = {}, expression = selectFirst(query))) final Element first(String query)
```
  - first
```
@Deprecated(message = Inappropriate name, replaceWith = @ReplaceWith(imports = {}, expression = selectFirst(query, transformer))) final <T extends Any> T first(String query, Function1<Element, T> transformer)
```
  - selectFirstText
```
 final String selectFirstText(String query)
```
    Find the text content of the first element that match the CSS query. Matched element may be the document, or any of its children.
  - selectFirstTextOrNull
```
 final String selectFirstTextOrNull(String query)
```
    Find the text content of the first element that match the CSS query. Matched element may be the document, or any of its children.
  - selectFirstTextOptional
```
 final Optional<String> selectFirstTextOptional(String query)
```
    Find the text content of the first element that match the CSS query. Matched element may be the document, or any of its children.
  - firstText
```
 final String firstText(String query)
```
    Find the text content of the first element that match the CSS query. Matched element may be the document, or any of its children.
  - firstTextOrNull
```
 final String firstTextOrNull(String query)
```
    Find the text content of the first element that match the CSS query. Matched element may be the document, or any of its children.
  - firstTextOptional
```
 final Optional<String> firstTextOptional(String query)
```
    Find the text content of the first element that match the CSS query. Matched element may be the document, or any of its children.
  - selectFirstAttribute
```
@JvmOverloads() final String selectFirstAttribute(String query, String attrName, String defaultValue)
```
    Find the attribute value of the first element that match the CSS query. Matched element may be the document, or any of its children.
  - selectFirstAttribute
```
@JvmOverloads() final String selectFirstAttribute(String query, String attrName)
```
    Find the attribute value of the first element that match the CSS query. Matched element may be the document, or any of its children.
  - selectFirstAttributeOrNull
```
 final String selectFirstAttributeOrNull(String query, String attrName)
```
    Find the attribute value of the first element that match the CSS query. Matched element may be the document, or any of its children.
  - selectFirstAttributeOptional
```
 final Optional<String> selectFirstAttributeOptional(String query, String attrName)
```
    Find the attribute value of the first element that match the CSS query. Matched element may be the document, or any of its children.
  - firstAttribute
```
@JvmOverloads() final String firstAttribute(String query, String attrName, String defaultValue)
```
    Find the attribute value of the first element that match the CSS query. Matched element may be the document, or any of its children.
  - firstAttribute
```
@JvmOverloads() final String firstAttribute(String query, String attrName)
```
    Find the attribute value of the first element that match the CSS query. Matched element may be the document, or any of its children.
  - firstAttributeOrNull
```
 final String firstAttributeOrNull(String query, String attrName)
```
    Find the attribute value of the first element that match the CSS query. Matched element may be the document, or any of its children.
  - firstAttributeOptional
```
 final Optional<String> firstAttributeOptional(String query, String attrName)
```
    Find the attribute value of the first element that match the CSS query. Matched element may be the document, or any of its children.
  - selectHyperlinks
```
@JvmOverloads() final List<Hyperlink> selectHyperlinks(String query, Integer offset, Integer limit)
```
    Find hyperlinks in elements matching the CSS query.
  - selectHyperlinks
```
@JvmOverloads() final List<Hyperlink> selectHyperlinks(String query, Integer offset)
```
    Find hyperlinks in elements matching the CSS query.
  - selectHyperlinks
```
@JvmOverloads() final List<Hyperlink> selectHyperlinks(String query)
```
    Find hyperlinks in elements matching the CSS query.
  - selectAnchors
```
@JvmOverloads() final List<GeoAnchor> selectAnchors(String query, Integer offset, Integer limit)
```
    Find anchor elements matching the CSS query.
  - selectAnchors
```
@JvmOverloads() final List<GeoAnchor> selectAnchors(String query, Integer offset)
```
    Find anchor elements matching the CSS query.
  - selectAnchors
```
@JvmOverloads() final List<GeoAnchor> selectAnchors(String query)
```
    Find anchor elements matching the CSS query.
  - selectImages
```
@JvmOverloads() final List<String> selectImages(String query, Integer offset, Integer limit)
```
    Find image elements matching the CSS query.
  - selectImages
```
@JvmOverloads() final List<String> selectImages(String query, Integer offset)
```
    Find image elements matching the CSS query.
  - selectImages
```
@JvmOverloads() final List<String> selectImages(String query)
```
    Find image elements matching the CSS query.
  - forEach
```
 final Unit forEach(Function1<Node, Unit> action)
```
    Traverse the DOM and apply the action to each Node.
  - forEachMatching
```
 final Unit forEachMatching(Function1<Node, Boolean> predicate, Function1<Node, Unit> action)
```
    Traverse the DOM and apply the action to each Node that matches predicate.
  - forEachElement
```
 final Unit forEachElement(Function1<Element, Unit> action)
```
    Traverse the DOM and apply the action to each Element.
  - forEachElementMatching
```
 final Unit forEachElementMatching(Function1<Element, Boolean> predicate, Function1<Element, Unit> action)
```
    Traverse the DOM and apply the action to each Element that matches predicate.
  - count
```
 final Integer count(Function1<Node, Boolean> predicate)
```
    Count nodes matching predicate.
  - countElements
```
 final Integer countElements(Function1<Element, Boolean> predicate)
```
    Count elements matching predicate.
  - getFeature
```
 final Double getFeature(Integer key)
```
    Retrieves the feature with the given key.
  - formatFeatures
```
 final String formatFeatures(Integer featureKeys)
```
    Format node features.
  - formatNamedFeatures
```
 final String formatNamedFeatures()
```
    Format named node features.
  - removeAttrs
```
 final Unit removeAttrs(String attributeKeys)
```
    Remove attributes associated with the given keys.
  - removeScripts
```
 final Unit removeScripts()
```
    Remove all script nodes in the document.
  - stripScripts
```
 final Unit stripScripts()
```
    Remove all script nodes in the document.
  - removeStyles
```
 final Unit removeStyles()
```
    Remove all style nodes from the document, and remove all style attributes from all elements.
  - stripStyles
```
 final Unit stripStyles()
```
  - export
```
 final Path export()
```
    Export the document.
  - exportTo
```
 final Path exportTo(Path path)
```
    Export the document to the given path.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```

Class FeaturedDocument

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FeaturedDocument

FeaturedDocument

FeaturedDocument

Method Detail

getSequence

getTitle

getLocation

getBaseUri

getHead

getBody

getText

getOwnText

getWholeText

getHtml

getOuterHtml

getCharset

getNodeName

getId

getClassName

getData

getDataNodes

getTextNodes

getChildNodes

getPrettyHtml

getFeatures

setFeatures

getFragments

getDocument

unbox

isNil

isInternal

isNotInternal

createElement

guessTitle

absoluteLinks

select

select

select

select

selectFirst

selectFirst

selectFirstOrNull

selectFirstOrNull

selectFirstOptional

selectFirstOptional

first

first

selectFirstText

selectFirstTextOrNull

selectFirstTextOptional

firstText

firstTextOrNull

firstTextOptional

selectFirstAttribute

selectFirstAttribute

selectFirstAttributeOrNull

selectFirstAttributeOptional

firstAttribute

firstAttribute

firstAttributeOrNull

firstAttributeOptional

selectHyperlinks

selectHyperlinks

selectHyperlinks

selectAnchors

selectAnchors

selectAnchors

selectImages

selectImages

selectImages

forEach

forEachMatching

forEachElement