Package com.iqser.red.service.redaction.v1.server.model.document.nodes

Class Page

java.lang.Object

com.iqser.red.service.redaction.v1.server.model.document.nodes.Page

public class Page
extends Object

Represents a single page in a document.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Page.PageBuilder

Constructor Summary

Constructors

Constructor	Description
Page()
Page(Integer number, Integer height, Integer width, Integer rotation, List<com.iqser.red.service.redaction.v1.server.model.document.textblock.AtomicTextBlock> textBlocksOnPage, Header header, com.iqser.red.service.redaction.v1.server.model.document.nodes.Footer footer, Set<com.iqser.red.service.redaction.v1.server.model.document.entity.TextEntity> entities, Set<Image> images)

Method Summary

Modifier and Type	Method	Description
static Page.PageBuilder	builder()
boolean	equals(Object o)
Set<com.iqser.red.service.redaction.v1.server.model.document.entity.TextEntity>	getEntities()
com.iqser.red.service.redaction.v1.server.model.document.nodes.Footer	getFooter()
Header	getHeader()
Integer	getHeight()
Set<Image>	getImages()
List<SemanticNode>	getMainBody()	Retrieves the highest SemanticNodes, which appear only on this page.
com.iqser.red.service.redaction.v1.server.model.document.textblock.TextBlock	getMainBodyTextBlock()	Constructs and returns a TextBlock representing the concatenated text of all leaf semantic nodes in the main body.
Integer	getNumber()
Integer	getRotation()
List<com.iqser.red.service.redaction.v1.server.model.document.textblock.AtomicTextBlock>	getTextBlocksOnPage()
Integer	getWidth()
int	hashCode()
void	setEntities(Set<com.iqser.red.service.redaction.v1.server.model.document.entity.TextEntity> entities)
void	setFooter(com.iqser.red.service.redaction.v1.server.model.document.nodes.Footer footer)
void	setHeader(Header header)
void	setHeight(Integer height)
void	setImages(Set<Image> images)
void	setNumber(Integer number)
void	setRotation(Integer rotation)
void	setTextBlocksOnPage(List<com.iqser.red.service.redaction.v1.server.model.document.textblock.AtomicTextBlock> textBlocksOnPage)
void	setWidth(Integer width)
Stream<SemanticNode>	streamHighestSemanticNodesOnPage()	Retrieves the highest SemanticNodes which are present on the page.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Page

public Page()

Page

public Page(Integer number,
 Integer height,
 Integer width,
 Integer rotation,
 List<com.iqser.red.service.redaction.v1.server.model.document.textblock.AtomicTextBlock> textBlocksOnPage,
 Header header,
 com.iqser.red.service.redaction.v1.server.model.document.nodes.Footer footer,
 Set<com.iqser.red.service.redaction.v1.server.model.document.entity.TextEntity> entities,
 Set<Image> images)

Method Details

getMainBodyTextBlock

public com.iqser.red.service.redaction.v1.server.model.document.textblock.TextBlock getMainBodyTextBlock()

Constructs and returns a TextBlock representing the concatenated text of all leaf semantic nodes in the main body.

Returns:

The main body text block.

getMainBody

public List<SemanticNode> getMainBody()

Retrieves the highest SemanticNodes, which appear only on this page. It is achieved by traversing the DocumentTree up, until a SemanticNode's direct parent is no longer exclusively on this page.

Returns:

A list which contains the highes SemanticNodes, which appear only on this page.

streamHighestSemanticNodesOnPage

public Stream<SemanticNode> streamHighestSemanticNodesOnPage()

Retrieves the highest SemanticNodes which are present on the page. There might be multiples, as two or more Main Sections start on a page. This is achieved by traversing up the document tree and returning all SemanticNodes whose direct parent is the Document

Returns:

A list of the highest SemanticNodes present on this page

toString

public String toString()

Overrides:

toString in class Object

builder

public static Page.PageBuilder builder()

getNumber

public Integer getNumber()

getHeight

public Integer getHeight()

getWidth

public Integer getWidth()

getRotation

public Integer getRotation()

getTextBlocksOnPage

public List<com.iqser.red.service.redaction.v1.server.model.document.textblock.AtomicTextBlock> getTextBlocksOnPage()

getHeader

public Header getHeader()

getFooter

public com.iqser.red.service.redaction.v1.server.model.document.nodes.Footer getFooter()

getEntities

public Set<com.iqser.red.service.redaction.v1.server.model.document.entity.TextEntity> getEntities()

getImages

public Set<Image> getImages()

setNumber

public void setNumber(Integer number)

setHeight

public void setHeight(Integer height)

setWidth

public void setWidth(Integer width)

setRotation

public void setRotation(Integer rotation)

setTextBlocksOnPage

public void setTextBlocksOnPage(List<com.iqser.red.service.redaction.v1.server.model.document.textblock.AtomicTextBlock> textBlocksOnPage)

setHeader

public void setHeader(Header header)

setFooter

public void setFooter(com.iqser.red.service.redaction.v1.server.model.document.nodes.Footer footer)

setEntities

public void setEntities(Set<com.iqser.red.service.redaction.v1.server.model.document.entity.TextEntity> entities)

setImages

public void setImages(Set<Image> images)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object