
public class FeaturedDocument

The featured document. A featured document have all it's features 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 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`	`html`
`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 String`	`getTitle()`
`final Unit`	`setTitle(String title)`
`final String`	`getBaseUri()`
`final String`	`getLocation()`
`final Element`	`getHead()`
`final Element`	`getBody()`
`final String`	`getText()`
`final String`	`getHtml()`
`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 Unit`	`absoluteLinks()`
`final Elements`	`select(String query, Integer offset, Integer limit)`
`final Elements`	`select(String query, Integer offset)`
`final Elements`	`select(String query)`
`final <T extends Any> List<T>`	`select(String query, Integer offset, Integer limit, Function1<Element, T> transformer)`
`final Element`	`selectFirst(String query)`
`final <T extends Any> T`	`selectFirst(String query, Function1<Element, T> extractor)`
`final Element`	`selectFirstOrNull(String query)`
`final <T extends Any> T`	`selectFirstOrNull(String query, Function1<Element, T> extractor)`
`final Element`	`first(String query)`
`final <T extends Any> T`	`first(String query, Function1<Element, T> extractor)`
`final Double`	`getFeature(Integer key)`
`final String`	`formatFeatures(Integer featureKeys)`
`final String`	`formatNamedFeatures()`
`final Unit`	`removeAttrs(String attributeKeys)`
`final Unit`	`stripScripts()`
`final Unit`	`stripStyles()`
`final Path`	`export()`
`final Path`	`exportTo(Path 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()
```

getTitle
```
 final String getTitle()
```

setTitle
```
 final Unit setTitle(String title)
```

getBaseUri
```
 final String getBaseUri()
```

getLocation
```
 final String getLocation()
```

getHead
```
 final Element getHead()
```

getBody
```
 final Element getBody()
```

getText
```
 final String getText()
```

getHtml
```
 final String getHtml()
```

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)

absoluteLinks
```
 final Unit absoluteLinks()
```

select

@JvmOverloads() final Elements select(String query, Integer offset, Integer limit)

select

@JvmOverloads() final Elements select(String query, Integer offset)

select

@JvmOverloads() final Elements select(String query)

select

 final <T extends Any> List<T> select(String query, Integer offset, Integer limit, Function1<Element, T> transformer)

selectFirst

 final Element selectFirst(String query)

selectFirst

 final <T extends Any> T selectFirst(String query, Function1<Element, T> extractor)

selectFirstOrNull

 final Element selectFirstOrNull(String query)

selectFirstOrNull

 final <T extends Any> T selectFirstOrNull(String query, Function1<Element, T> extractor)

first
```
 final Element first(String query)
```

first

 final <T extends Any> T first(String query, Function1<Element, T> extractor)

getFeature
```
 final Double getFeature(Integer key)
```

formatFeatures

 final String formatFeatures(Integer featureKeys)

formatNamedFeatures
```
 final String formatNamedFeatures()
```

removeAttrs

 final Unit removeAttrs(String attributeKeys)

stripScripts
```
 final Unit stripScripts()
```

stripStyles
```
 final Unit stripStyles()
```

export
```
 final Path export()
```

exportTo
```
 final Path exportTo(Path 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

getTitle

setTitle

getBaseUri

getLocation

getHead

getBody

getText

getHtml

getPrettyHtml

getFeatures

setFeatures

getDocument

unbox

isNil

isInternal

isNotInternal

createElement

absoluteLinks

select

select

select

select

selectFirst

selectFirst

selectFirstOrNull

selectFirstOrNull

first

first

getFeature

formatFeatures

formatNamedFeatures

removeAttrs

stripScripts

stripStyles

export

exportTo

equals

hashCode

toString