com.affinda.api.client.models

Class AnnotationUpdate

java.lang.Object

com.affinda.api.client.models.AnnotationUpdate

Direct Known Subclasses:

AnnotationBatchUpdate

public class AnnotationUpdate
extends Object

The AnnotationUpdate model.

Constructor Summary

Constructors

Constructor and Description
AnnotationUpdate()

Method Summary

Modifier and Type	Method and Description
String	getDataPoint() Get the dataPoint property: Data point's identifier.
String	getDocument() Get the document property: Uniquely identify a document.
Integer	getPageIndex() Get the pageIndex property: The page number within the document, starting from 0.
Integer	getParent() Get the parent property: The parent annotation's ID.
Object	getParsed() Get the parsed property: The parsed property.
String	getRaw() Get the raw property: Raw data extracted from the before any post-processing.
List<Rectangle>	getRectangles() Get the rectangles property: x/y coordinates for the rectangles containing the data.
Boolean	isClientVerified() Get the isClientVerified property: Indicates whether the data has been validated by a human.
AnnotationUpdate	setDataPoint(String dataPoint) Set the dataPoint property: Data point's identifier.
AnnotationUpdate	setDocument(String document) Set the document property: Uniquely identify a document.
AnnotationUpdate	setIsClientVerified(Boolean isClientVerified) Set the isClientVerified property: Indicates whether the data has been validated by a human.
AnnotationUpdate	setPageIndex(Integer pageIndex) Set the pageIndex property: The page number within the document, starting from 0.
AnnotationUpdate	setParent(Integer parent) Set the parent property: The parent annotation's ID.
AnnotationUpdate	setParsed(Object parsed) Set the parsed property: The parsed property.
AnnotationUpdate	setRaw(String raw) Set the raw property: Raw data extracted from the before any post-processing.
AnnotationUpdate	setRectangles(List<Rectangle> rectangles) Set the rectangles property: x/y coordinates for the rectangles containing the data.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationUpdate

public AnnotationUpdate()

Method Detail

getRectangles

public List<Rectangle> getRectangles()

Get the rectangles property: x/y coordinates for the rectangles containing the data. An annotation can be contained within multiple rectangles.

Returns:

the rectangles value.

setRectangles

public AnnotationUpdate setRectangles(List<Rectangle> rectangles)

Set the rectangles property: x/y coordinates for the rectangles containing the data. An annotation can be contained within multiple rectangles.

Parameters:

rectangles - the rectangles value to set.

Returns:

the AnnotationUpdate object itself.

getDocument

public String getDocument()

Get the document property: Uniquely identify a document.

Returns:

the document value.

setDocument

public AnnotationUpdate setDocument(String document)

Set the document property: Uniquely identify a document.

Parameters:

document - the document value to set.

Returns:

the AnnotationUpdate object itself.

getPageIndex

public Integer getPageIndex()

Get the pageIndex property: The page number within the document, starting from 0.

Returns:

the pageIndex value.

setPageIndex

public AnnotationUpdate setPageIndex(Integer pageIndex)

Set the pageIndex property: The page number within the document, starting from 0.

Parameters:

pageIndex - the pageIndex value to set.

Returns:

the AnnotationUpdate object itself.

getRaw

public String getRaw()

Get the raw property: Raw data extracted from the before any post-processing.

Returns:

the raw value.

setRaw

public AnnotationUpdate setRaw(String raw)

Set the raw property: Raw data extracted from the before any post-processing.

Parameters:

raw - the raw value to set.

Returns:

the AnnotationUpdate object itself.

getParsed

public Object getParsed()

Get the parsed property: The parsed property.

Returns:

the parsed value.

setParsed

public AnnotationUpdate setParsed(Object parsed)

Set the parsed property: The parsed property.

Parameters:

parsed - the parsed value to set.

Returns:

the AnnotationUpdate object itself.

isClientVerified

public Boolean isClientVerified()

Get the isClientVerified property: Indicates whether the data has been validated by a human.

Returns:

the isClientVerified value.

setIsClientVerified

public AnnotationUpdate setIsClientVerified(Boolean isClientVerified)

Set the isClientVerified property: Indicates whether the data has been validated by a human.

Parameters:

isClientVerified - the isClientVerified value to set.

Returns:

the AnnotationUpdate object itself.

getDataPoint

public String getDataPoint()

Get the dataPoint property: Data point's identifier.

Returns:

the dataPoint value.

setDataPoint

public AnnotationUpdate setDataPoint(String dataPoint)

Set the dataPoint property: Data point's identifier.

Parameters:

dataPoint - the dataPoint value to set.

Returns:

the AnnotationUpdate object itself.

getParent

public Integer getParent()

Get the parent property: The parent annotation's ID.

Returns:

the parent value.

setParent

public AnnotationUpdate setParent(Integer parent)

Set the parent property: The parent annotation's ID.

Parameters:

parent - the parent value to set.

Returns:

the AnnotationUpdate object itself.