Document (Gini Vision Library for Android)

All Known Implementing Classes:

GiniVisionDocument, GiniVisionMultiPageDocument, ImageDocument, ImageMultiPageDocument, PdfDocument, PdfMultiPageDocument, QRCodeDocument, QRCodeMultiPageDocument
```
public interface Document
```
This class is the container for transferring documents between the client application and the Gini Vision Library and between the Fragments of the Gini Vision Library.
Due to the size limitations of the android.os.Bundle, the document data byte array has to be stored in a memory cache when parceling and read from the cache when unparceling.
Warning: Always retrieve the Document extras from a Bundle to force unparceling and removing of the reference to the byte array from the memory cache. Failing to do so will lead to memory leaks.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Document.ImportMethod` Enum of supported methods for importing documents.
`static class`	`Document.Source` Source of the document (e.g.
`static class`	`Document.Type` Supported document types.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`byte[]`	`getData()` The contents of a document, if the document was loaded into memory.
`java.lang.String`	`getId()` Retrieve the document's unique id.
`Document.ImportMethod`	`getImportMethod()` Retrieve with which method the document has been imported.
`Intent`	`getIntent()` The `Intent` with which the imported document was received.
`byte[]`	`getJpeg()` Deprecated. Use `Document.getData()` instead. This method might return a byte array containing other types, like PDFs. To check if the byte array contains an image query the type with `Document.getType()` and check if it equals `Document.Type.IMAGE`.
`java.lang.String`	`getMimeType()` Retrieve the document's mime type (media type).
`int`	`getRotationForDisplay()` Deprecated. Use `ImageDocument.getRotationForDisplay()` instead, if `Document.getType()` equals `Document.Type.IMAGE`.
`Document.Source`	`getSource()` Retrieve from which source the document originates from.
`Document.Type`	`getType()` Get the concrete document type.
`Uri`	`getUri()` The `Uri` of the imported document.
`boolean`	`isImported()` Document is imported if it was picked from another app from the Camera Screen's document upload button or if a file was passed to the Gini Vision Library through the client application from another app.
`boolean`	`isReviewable()` Documents like PDFs are not reviewable and can be passed directly to the Analysis Screen.

- Method Detail
  - getId
```
java.lang.String getId()
```
    Retrieve the document's unique id.
    
    Returns:
    
    a unique id
  - getJpeg
```
@Deprecated
byte[] getJpeg()
```
    Deprecated. Use Document.getData() instead. This method might return a byte array containing other types, like PDFs.
    To check if the byte array contains an image query the type with Document.getType() and check if it equals Document.Type.IMAGE.
    
    The image of a document as a JPEG.
    
    Returns:
    
    a byte array containg a JPEG
  - getRotationForDisplay
```
@Deprecated
int getRotationForDisplay()
```
    Deprecated. Use ImageDocument.getRotationForDisplay() instead, if Document.getType() equals Document.Type.IMAGE.
    
    The amount of clockwise rotation needed to display the image in the correct orientation.
    
    Degrees are positive and multiples of 90.
    
    Returns:
    
    degrees by which the image should be rotated clockwise before displaying
  - getType
```
Document.Type getType()
```
    Get the concrete document type.
    
    Returns:
    
    the document type
  - getMimeType
```
java.lang.String getMimeType()
```
    Retrieve the document's mime type (media type).
    
    Returns:
    
    mime type string
  - getData
```
byte[] getData()
```
    The contents of a document, if the document was loaded into memory.
    
    For photos captured with the camera or for QR Codes this is never null.
    
    If Document.isImported() is true then this might be null. If it's null you can use Document.getIntent() and access the contents using the Intent.
    
    Returns:
    
    a byte array containing one of the supported document types
  - getIntent
```
Intent getIntent()
```
    The Intent with which the imported document was received.
    
    Returns:
    
    the Intent of the imported document
  - getUri
```
Uri getUri()
```
    The Uri of the imported document.
    
    Returns:
    
    Uri
  - isImported
```
boolean isImported()
```
    Document is imported if it was picked from another app from the Camera Screen's document upload button or if a file was passed to the Gini Vision Library through the client application from another app.
    
    Returns:
    
    true if the document was imported
  - getImportMethod
```
Document.ImportMethod getImportMethod()
```
    Retrieve with which method the document has been imported.
    
    Returns:
    
    the document's Document.ImportMethod
  - getSource
```
Document.Source getSource()
```
    Retrieve from which source the document originates from.
    
    Returns:
    
    the document's Document.Source
  - isReviewable
```
boolean isReviewable()
```
    Documents like PDFs are not reviewable and can be passed directly to the Analysis Screen. Reviewable documents have to be shown in the Review Screen first before passing it on to the Analysis Screen.
    
    Returns:
    
    true if the document can be reviewed in the Review Screen otherwise the document has to be passed directly to the Analysis Screen

Interface Document

Nested Class Summary

Method Summary

Method Detail

getId

getJpeg

getRotationForDisplay

getType

getMimeType

getData

getIntent

getUri

isImported

getImportMethod

getSource

isReviewable