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

Class Header

java.lang.Object

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

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

All Implemented Interfaces:

com.iqser.red.service.redaction.v1.server.model.document.nodes.GenericSemanticNode, SemanticNode

public class Header
extends com.iqser.red.service.redaction.v1.server.model.document.nodes.AbstractSemanticNode

Represents the header part of a document page.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Header.HeaderBuilder<C extends Header,B extends Header.HeaderBuilder<C,B>>

Nested classes/interfaces inherited from class com.iqser.red.service.redaction.v1.server.model.document.nodes.AbstractSemanticNode

com.iqser.red.service.redaction.v1.server.model.document.nodes.AbstractSemanticNode.AbstractSemanticNodeBuilder<C extends com.iqser.red.service.redaction.v1.server.model.document.nodes.AbstractSemanticNode,B extends com.iqser.red.service.redaction.v1.server.model.document.nodes.AbstractSemanticNode.AbstractSemanticNodeBuilder<C,B>>

Constructor Summary

Constructors

Constructor	Description
Header()
Header(com.iqser.red.service.redaction.v1.server.model.document.textblock.TextBlock leafTextBlock)

Method Summary

Modifier and Type	Method	Description
static Header.HeaderBuilder<?,?>	builder()
boolean	equals(Object o)
com.iqser.red.service.redaction.v1.server.model.document.textblock.TextBlock	getLeafTextBlock()	Leaf means a SemanticNode has direct access to a TextBlock, by default this is false and must be overridden.
SectionIdentifier	getSectionIdentifier()	Returns the SectionIdentifier as a child of the SectionIdentifier returned by the getHeadline() method.
com.iqser.red.service.redaction.v1.server.model.document.textblock.TextBlock	getTextBlock()	Searches all Nodes located underneath this Node in the DocumentTree and concatenates their AtomicTextBlocks into a single TextBlock.
NodeType	getType()	Returns the type of this node, such as Section, Paragraph, etc.
int	hashCode()
boolean	isLeaf()	Leaf means a SemanticNode has direct access to a TextBlock, by default this is false and must be overridden.
void	setLeafTextBlock(com.iqser.red.service.redaction.v1.server.model.document.textblock.TextBlock leafTextBlock)	Should only be used during construction of the Graph.
String	toString()

Methods inherited from class com.iqser.red.service.redaction.v1.server.model.document.nodes.AbstractSemanticNode

getBBox, getBBoxCache, getDocumentTree, getEngines, getEntities, getTreeId, setBBoxCache, setDocumentTree, setEngines, setEntities, setTextBlock, setTreeId

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.iqser.red.service.redaction.v1.server.model.document.nodes.SemanticNode

accept, addEngine, addThisToEntityIfIntersects, containsAllStrings, containsAllStringsIgnoreCase, containsAllWords, containsAllWordsIgnoreCase, containsAnyString, containsAnyString, containsAnyStringIgnoreCase, containsAnyWord, containsAnyWordIgnoreCase, containsRectangle, containsString, containsStringIgnoreCase, containsWord, containsWordIgnoreCase, getEntitiesOfType, getEntitiesOfType, getEntitiesOfType, getFirstPage, getHeadline, getHighestParent, getNextSibling, getNumberOnPage, getPages, getPages, getParent, getPositionsPerPage, getPreviousSibling, getTextBlocksByPageNumbers, getTextRange, hasEntitiesOfAllTypes, hasEntitiesOfAnyType, hasEntitiesOfType, hasParent, hasText, intersectsRectangle, length, matchesRegex, matchesRegexIgnoreCase, onlyOnPage, onPage, streamAllSubNodes, streamAllSubNodesOfType, streamChildren, streamChildrenOfType, streamValidEntities

Constructor Details

Header

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

Header

public Header()

Method Details

isLeaf

public boolean isLeaf()

Description copied from interface: SemanticNode

Leaf means a SemanticNode has direct access to a TextBlock, by default this is false and must be overridden. Currently only Sections, Images, and Tables are not leaves. A TableCell might be a leaf depending on its area compared to the page.

Returns:

boolean, indicating if a Node has direct access to a TextBlock

getType

public NodeType getType()

Description copied from interface: SemanticNode

Returns the type of this node, such as Section, Paragraph, etc.

Returns:

NodeType of this node

getTextBlock

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

Description copied from interface: SemanticNode

Searches all Nodes located underneath this Node in the DocumentTree and concatenates their AtomicTextBlocks into a single TextBlock. So, for a Section all TextBlocks of Subsections, Paragraphs, and Tables are concatenated into a single TextBlock If the Node is a Leaf, the LeafTextBlock will be returned instead.

Specified by:

getTextBlock in interface SemanticNode

Overrides:

getTextBlock in class com.iqser.red.service.redaction.v1.server.model.document.nodes.AbstractSemanticNode

Returns:

TextBlock containing all AtomicTextBlocks that are located under this Node.

getSectionIdentifier

public SectionIdentifier getSectionIdentifier()

Description copied from interface: SemanticNode

Returns the SectionIdentifier as a child of the SectionIdentifier returned by the getHeadline() method.

Returns:

The SectionIdentifier from the first Headline.

toString

public String toString()

Overrides:

toString in class com.iqser.red.service.redaction.v1.server.model.document.nodes.AbstractSemanticNode

builder

public static Header.HeaderBuilder<?,?> builder()

getLeafTextBlock

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

Description copied from interface: SemanticNode

Leaf means a SemanticNode has direct access to a TextBlock, by default this is false and must be overridden. Currently only Sections and Tables are no leaves.

Returns:

AtomicTextBlock

setLeafTextBlock

public void setLeafTextBlock(com.iqser.red.service.redaction.v1.server.model.document.textblock.TextBlock leafTextBlock)

Description copied from interface: SemanticNode

Should only be used during construction of the Graph. Sets the LeafTextBlock of this SemanticNode.

Parameters:

leafTextBlock - the TextBlock to set as the LeafTextBlock of this SemanticNode

equals

public boolean equals(Object o)

Overrides:

equals in class com.iqser.red.service.redaction.v1.server.model.document.nodes.AbstractSemanticNode

hashCode

public int hashCode()

Overrides:

hashCode in class com.iqser.red.service.redaction.v1.server.model.document.nodes.AbstractSemanticNode