de.digitalcollections.solrocr.formats

Class OcrSnippet

java.lang.Object

de.digitalcollections.solrocr.formats.OcrSnippet

public class OcrSnippet
extends Object

A structured representation of a highlighted OCR snippet.

Constructor Summary

Constructors

Constructor and Description
OcrSnippet(String text, List<OcrBox> snippetRegions) Create a new snippet on the given region on the page along with its plaintext.

Method Summary

Modifier and Type	Method and Description
void	addHighlightRegion(List<OcrBox> region) Add a new highlighted region in the snippet.
List<OcrBox[]>	getHighlightRegions() Get the highlighted regions of the snippet region.
float	getScore() Get the score of the passage, compared to all other passages in the document
List<OcrBox>	getSnippetRegions() Get the region of the page that the snippes is located in
String	getText() Get the plaintext version of the highlighted page text with highlighting tags
void	setScore(float score) Set the score of the passage, compared to all other passages in the document
org.apache.solr.common.util.NamedList	toNamedList() Convert the snippet to a NamedList that is used by Solr to populate the response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OcrSnippet

public OcrSnippet(String text,
                  List<OcrBox> snippetRegions)

Create a new snippet on the given region on the page along with its plaintext.

Parameters:

text - plaintext version of the highlighted page text with highlighting tags

snippetRegions - regions the snippet is located in

Method Detail

addHighlightRegion

public void addHighlightRegion(List<OcrBox> region)

Add a new highlighted region in the snippet. Note that the region should be relative to the snippet region!

Parameters:

region - Location of the highlighted region relative to the snippet region.

getText

public String getText()

Get the plaintext version of the highlighted page text with highlighting tags

getSnippetRegions

public List<OcrBox> getSnippetRegions()

Get the region of the page that the snippes is located in

getHighlightRegions

public List<OcrBox[]> getHighlightRegions()

Get the highlighted regions of the snippet region. The highlighted regions are relative to the snippet region, not to the page.

getScore

public float getScore()

Get the score of the passage, compared to all other passages in the document

setScore

public void setScore(float score)

Set the score of the passage, compared to all other passages in the document

toNamedList

public org.apache.solr.common.util.NamedList toNamedList()

Convert the snippet to a NamedList that is used by Solr to populate the response.