```
public class FeaturedDocument

                    
```
The featured document.
A "featured document" is "very important" and all its features are calculated.

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field	Description
`private final DocumentFragments`	`fragments`
`private final Document`	`documentOrNull`
`private final Integer`	`sequence`
`private final String`	`title`
`private final String`	`baseUri`
`private final String`	`location`
`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`	`data`
`private final String`	`id`
`private final String`	`className`
`private final String`	`prettyHtml`
`private RealVector`	`features`
`private final Document`	`document`

Constructor Summary

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

Method Summary

Modifier and Type	Method	Description
`final DocumentFragments`	`getFragments()`
`final Document`	`getDocumentOrNull()`
`final Integer`	`getSequence()`	The process scope unique sequence.
`final String`	`getTitle()`
`final String`	`getBaseUri()`
`final String`	`getLocation()`
`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`	`getData()`
`final String`	`getId()`
`final String`	`getClassName()`
`final String`	`getPrettyHtml()`
`final RealVector`	`getFeatures()`
`final Unit`	`setFeatures(RealVector features)`
`final Document`	`getDocument()`
`final Document`	`unbox()`
`final Boolean`	`isNil()`
`final Boolean`	`isInternal()`
`final Boolean`	`isNotInternal()`
`final Element`	`createElement(String tagName)`
`final String`	`guessTitle()`	The title should be guessed for some site without a <title> tag inside a <head> tag
`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, with the document as the starting context.
`final Elements`	`select(String query, Integer offset)`	Find elements that match the CSS query, with the document as the starting context.
`final Elements`	`select(String query)`	Find elements that match the CSS query, with the document as the starting context.
`final <T extends Any> List<T>`	`select(String query, Integer offset, Integer limit, Function1<Element, T> transformer)`	Find elements that match the CSS query, with the document as the starting context.
`final Element`	`selectFirst(String query)`	Find the first element that match the CSS query, with the document as the starting context.
`final <T extends Any> T`	`selectFirst(String query, Function1<Element, T> transformer)`	Find the first element that match the CSS query, with the document as the starting context.
`final Element`	`selectFirstOrNull(String query)`	Find the first element that match the CSS query, with the document as the starting context.
`final <T extends Any> T`	`selectFirstOrNull(String query, Function1<Element, T> transformer)`	Find the first element that match the CSS query, with the document as the starting context.
`final Optional<Element>`	`selectFirstOptional(String query)`	Find elements that match the CSS query, with the document as the starting context.
`final <T extends Any> Optional<T>`	`selectFirstOptional(String query, Function1<Element, T> transformer)`	Find elements that match the CSS query, with the document as the starting context.
`final List<Hyperlink>`	`selectHyperlinks(String query, Integer offset, Integer limit)`	Find hyperlinks in elements that match the CSS query, with the document as the starting context.
`final List<Hyperlink>`	`selectHyperlinks(String query, Integer offset)`	Find hyperlinks in elements that match the CSS query, with the document as the starting context.
`final List<Hyperlink>`	`selectHyperlinks(String query)`	Find hyperlinks in elements that match the CSS query, with the document as the starting context.
`final Element`	`first(String query)`
`final <T extends Any> T`	`first(String query, Function1<Element, T> transformer)`
`final String`	`firstText(String query)`	Find the text content of the first element that match the CSS query, with the document as the starting context.
`final String`	`firstTextOrNull(String query)`	Find the text content of the first element that match the CSS query, with the document as the starting context.
`final Optional<String>`	`firstTextOptional(String query)`	Find the text content of the first element that match the CSS query, with the document as the starting context.
`final String`	`firstAttribute(String query, String attrName, String defaultValue)`	Find the attribute value of the first element that match the CSS query, with the document as the starting context.
`final String`	`firstAttributeOrNull(String query, String attrName)`	Find the attribute value of the first element that match the CSS query, with the document as the starting context.
`final Optional<String>`	`firstAttributeOptional(String query, String attrName)`	Find the attribute value of the first element that match the CSS query, with the document as the starting context.
`final Double`	`getFeature(Integer key)`	Retrieves the feature with the given key.
`final String`	`formatFeatures(Integer featureKeys)`	Format features.
`final String`	`formatNamedFeatures()`	Format named features.
`final Unit`	`removeAttrs(String attributeKeys)`	Remove attributes with the given keys.
`final Unit`	`stripScripts()`	Remove all script nodes in the document.
`final Unit`	`stripStyles()`	Remove all style nodes from the document, and remove all style attributes from all elements.
`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)
```
 - FeaturedDocument
```
FeaturedDocument(FeaturedDocument other)
```
 - FeaturedDocument
```
FeaturedDocument(Document document)
```
- Method Detail
 - getFragments
```
 final DocumentFragments getFragments()
```
 - getDocumentOrNull
```
 final Document getDocumentOrNull()
```
 - getSequence
```
 final Integer getSequence()
```
 The process scope unique sequence.
 - getTitle
```
 final String getTitle()
```
 - getBaseUri
```
 final String getBaseUri()
```
 - getLocation
```
 final String getLocation()
```
 - 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()
```
 - getData
```
 final String getData()
```
 - getId
```
 final String getId()
```
 - getClassName
```
 final String getClassName()
```
 - getPrettyHtml
```
 final String getPrettyHtml()
```
 - getFeatures
```
 final RealVector getFeatures()
```
 - setFeatures
```
 final Unit setFeatures(RealVector features)
```
 - getDocument
```
 final Document getDocument()
```
 - unbox
```
 final Document unbox()
```
 - isNil
```
 final Boolean isNil()
```
 - isInternal
```
 final Boolean isInternal()
```
 - isNotInternal
```
 final Boolean isNotInternal()
```
 - createElement
```
 final Element createElement(String tagName)
```
 - guessTitle
```
 final String guessTitle()
```
 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, with the document as the starting context. 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, e.g.:
 - select
```
@JvmOverloads() final Elements select(String query, Integer offset)
```
 Find elements that match the CSS query, with the document as the starting context. 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, e.g.:
 - select
```
@JvmOverloads() final Elements select(String query)
```
 Find elements that match the CSS query, with the document as the starting context. 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, e.g.:
 - 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, with the document as the starting context. 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, e.g.:
 - selectFirst
```
 final Element selectFirst(String query)
```
 Find the first element that match the CSS query, with the document as the starting context. 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, e.g.:
 - selectFirst
```
 final <T extends Any> T selectFirst(String query, Function1<Element, T> transformer)
```
 Find the first element that match the CSS query, with the document as the starting context. 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, e.g.:
 - selectFirstOrNull
```
 final Element selectFirstOrNull(String query)
```
 Find the first element that match the CSS query, with the document as the starting context. 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, e.g.:
 - selectFirstOrNull
```
 final <T extends Any> T selectFirstOrNull(String query, Function1<Element, T> transformer)
```
 Find the first element that match the CSS query, with the document as the starting context. 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, e.g.:
 - selectFirstOptional
```
 final Optional<Element> selectFirstOptional(String query)
```
 Find elements that match the CSS query, with the document as the starting context. 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, e.g.:
 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, with the document as the starting context. 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, e.g.:
 Return the first element, if no element matches the query, return an Optional object.
 - selectHyperlinks
```
@JvmOverloads() final List<Hyperlink> selectHyperlinks(String query, Integer offset, Integer limit)
```
 Find hyperlinks in elements that match the CSS query, with the document as the starting context. 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, e.g.:
 - selectHyperlinks
```
@JvmOverloads() final List<Hyperlink> selectHyperlinks(String query, Integer offset)
```
 Find hyperlinks in elements that match the CSS query, with the document as the starting context. 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, e.g.:
 - selectHyperlinks
```
@JvmOverloads() final List<Hyperlink> selectHyperlinks(String query)
```
 Find hyperlinks in elements that match the CSS query, with the document as the starting context. 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, e.g.:
 - 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)
```
 - firstText
```
 final String firstText(String query)
```
 Find the text content of the first element that match the CSS query, with the document as the starting context. 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, with the document as the starting context. 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, with the document as the starting context. Matched element may be the document, or any of its children.
 - firstAttribute
```
 final String firstAttribute(String query, String attrName, String defaultValue)
```
 Find the attribute value of the first element that match the CSS query, with the document as the starting context. 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, with the document as the starting context. 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, with the document as the starting context. Matched element may be the document, or any of its children.
 - getFeature
```
 final Double getFeature(Integer key)
```
 Retrieves the feature with the given key.
 - formatFeatures
```
 final String formatFeatures(Integer featureKeys)
```
 Format features.
 - formatNamedFeatures
```
 final String formatNamedFeatures()
```
 Format named features.
 - removeAttrs
```
 final Unit removeAttrs(String attributeKeys)
```
 Remove attributes with the given keys.
 - stripScripts
```
 final Unit stripScripts()
```
 Remove all script nodes in the document.
 - stripStyles
```
 final Unit stripStyles()
```
 Remove all style nodes from the document, and remove all style attributes from all elements.
 - 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

getFragments

getDocumentOrNull

getSequence

getTitle

getBaseUri

getLocation

getHead

getBody

getText

getOwnText

getWholeText

getHtml

getOuterHtml

getCharset

getNodeName

getData

getId

getClassName

getPrettyHtml

getFeatures

setFeatures

getDocument

unbox

isNil

isInternal

isNotInternal

createElement

guessTitle

absoluteLinks

select

select

select

select

selectFirst

selectFirst

selectFirstOrNull

selectFirstOrNull

selectFirstOptional

selectFirstOptional

selectHyperlinks

selectHyperlinks

selectHyperlinks

first

first

firstText

firstTextOrNull

firstTextOptional

firstAttribute

firstAttributeOrNull

firstAttributeOptional

getFeature

formatFeatures

formatNamedFeatures

removeAttrs

stripScripts

stripStyles

export

exportTo

equals

hashCode

toString