Package io.scanbot.sdk.persistence
Class Page
-
- All Implemented Interfaces:
-
android.os.Parcelable
,java.io.Serializable
public final class Page implements Parcelable, Serializable
Object which represents snapped document
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
Page.Size
-
Field Summary
Fields Modifier and Type Field Description private final String
pageId
private final List<PointF>
polygon
private final DetectionStatus
detectionStatus
private final ImageFilterType
filter
private final List<ParametricFilter>
parametricFilters
private final Page.Size
documentImageSizeLimit
private final PageImageSource
pageImageSource
-
Constructor Summary
Constructors Constructor Description Page(String pageId, List<PointF> polygon, DetectionStatus detectionStatus, ImageFilterType filter)
Object which represents snapped document Page(String pageId, List<PointF> polygon, DetectionStatus detectionStatus, List<ParametricFilter> parametricFilters)
Object which represents snapped document Page(String pageId, List<PointF> polygon, DetectionStatus detectionStatus, ParametricFilter parametricFilter)
Object which represents snapped document Page(String pageId, List<PointF> polygon, DetectionStatus detectionStatus)
Object which represents snapped document Page(String pageId, List<PointF> polygon, DetectionStatus detectionStatus, List<ParametricFilter> parametricFilters, Page.Size documentImageSizeLimit)
Object which represents snapped document Page(String pageId, List<PointF> polygon, DetectionStatus detectionStatus, ImageFilterType filter, List<ParametricFilter> parametricFilters, Page.Size documentImageSizeLimit, PageImageSource pageImageSource)
-
Method Summary
Modifier and Type Method Description final String
getPageId()
final List<PointF>
getPolygon()
final DetectionStatus
getDetectionStatus()
final ImageFilterType
getFilter()
final List<ParametricFilter>
getParametricFilters()
final Page.Size
getDocumentImageSizeLimit()
final PageImageSource
getPageImageSource()
-
-
Constructor Detail
-
Page
Page(String pageId, List<PointF> polygon, DetectionStatus detectionStatus, ImageFilterType filter)
Object which represents snapped document- Parameters:
pageId
- id of the pagepolygon
- polygon of the cropped pagedetectionStatus
- information about the state of detection of the document on this pagefilter
- filter to apply
-
Page
Page(String pageId, List<PointF> polygon, DetectionStatus detectionStatus, List<ParametricFilter> parametricFilters)
Object which represents snapped document- Parameters:
pageId
- id of the pagepolygon
- polygon of the cropped pagedetectionStatus
- information about the state of detection of the document on this pageparametricFilters
- filters to apply
-
Page
Page(String pageId, List<PointF> polygon, DetectionStatus detectionStatus, ParametricFilter parametricFilter)
Object which represents snapped document- Parameters:
pageId
- id of the pagepolygon
- polygon of the cropped pagedetectionStatus
- information about the state of detection of the document on this pageparametricFilter
- filter to apply
-
Page
Page(String pageId, List<PointF> polygon, DetectionStatus detectionStatus)
Object which represents snapped document- Parameters:
pageId
- id of the pagepolygon
- polygon of the cropped pagedetectionStatus
- information about the state of detection of the document on this page
-
Page
Page(String pageId, List<PointF> polygon, DetectionStatus detectionStatus, List<ParametricFilter> parametricFilters, Page.Size documentImageSizeLimit)
Object which represents snapped document- Parameters:
pageId
- id of the pagepolygon
- polygon of the cropped pagedetectionStatus
- information about the state of detection of the document on this pageparametricFilters
- filters to applydocumentImageSizeLimit
- the limit of size of the page
-
Page
Page(String pageId, List<PointF> polygon, DetectionStatus detectionStatus, ImageFilterType filter, List<ParametricFilter> parametricFilters, Page.Size documentImageSizeLimit, PageImageSource pageImageSource)
- Parameters:
pageId
- id of the pagepolygon
- polygon of the cropped pagedetectionStatus
- information about the state of detection of the document on this pagefilter
- deprecated filter type to applyparametricFilters
- filters to applydocumentImageSizeLimit
- the limit of size of the pagepageImageSource
- type of the source of the image
-
-
Method Detail
-
getPolygon
final List<PointF> getPolygon()
-
getDetectionStatus
final DetectionStatus getDetectionStatus()
-
getFilter
final ImageFilterType getFilter()
-
getParametricFilters
final List<ParametricFilter> getParametricFilters()
-
getDocumentImageSizeLimit
final Page.Size getDocumentImageSizeLimit()
-
getPageImageSource
final PageImageSource getPageImageSource()
-
-
-
-