AnalysisActivity (Gini Vision Library for Android)

java.lang.Object
- AppCompatActivity
- - net.gini.android.vision.analysis.AnalysisActivity

All Implemented Interfaces:

AnalysisFragmentInterface, AnalysisFragmentListener
```
public class AnalysisActivity
extends AppCompatActivity
implements AnalysisFragmentListener, AnalysisFragmentInterface
```
Screen API

When you use the Screen API, the AnalysisActivity displays the captured or imported document and an activity indicator while the document is being analyzed by the Gini API.
Note: The title from the ActionBar was removed. Use the activity indicator message instead by overriding the string resource named gv_analysis_activity_indicator_message. The message is displayed for images only.
For PDF documents the first page is shown (only on Android 5.0 Lollipop and newer) along with the PDF's filename and number of pages above the page. On Android KitKat and older only the PDF's filename is shown with the preview area left empty.
Extending the AnalysisActivity in your application has been deprecated. The preferred way of adding network calls to the Gini Vision Library is by creating a GiniVision instance with a GiniVisionNetworkService and a GiniVisionNetworkApi implementation.
Note: When declaring your AnalysisActivity subclass in the AndroidManifest.xml you should set the theme to the GiniVisionTheme. If you would like to use your own theme please consider that AnalysisActivity extends AppCompatActivity and requires an AppCompat Theme.
The AnalysisActivity is started by the CameraActivity after the user has reviewed the document and either made no changes to the document and it hasn't been analyzed before tapping the Next button, or the user has modified the document, e.g. by rotating it.
For imported documents that cannot be reviewed, like PDFs, the CameraActivity starts the AnalysisActivity directly.
If you didn't create GiniVision instance you have to implement the following methods in your AnalysisActivity subclass:
- AnalysisActivity.onAnalyzeDocument(Document) - start analyzing the document by sending it to the Gini API.
  Note: Call AnalysisActivity.onDocumentAnalyzed() when the analysis is done and the Activity hasn't been stopped.
  Note: If an analysis error message was set in the Review Screen with ReviewActivity.onDocumentAnalysisError(String) this method won't be called until the user clicks the retry button next to the error message.
- AnalysisActivity.onAddDataToResult(Intent) - you should add the results of the analysis to the Intent as extras and retrieve them once the CameraActivity returns.
  This is called only if you called AnalysisActivity.onDocumentAnalyzed() before.
  When this is called, control is returned to your Activity which started the CameraActivity and you can extract the results of the analysis.
You can also override the following method:
- AnalysisActivity.onBackPressed() - called when the back or the up button was clicked.
Customizing the Analysis Screen
Customizing the look of the Analysis Screen is done via overriding of app resources.
The following items are customizable:
- Activity indicator color: via the color resource named gv_analysis_activity_indicator
- Activity indicator message: via the string resource named gv_analysis_activity_indicator_message
- Activity indicator message text style: via overriding the style named GiniVisionTheme.Analysis.AnalysingMessage.TextStyle
- Activity indicator message font: via overriding the style named GiniVisionTheme.Analysis.AnalysingMessage.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
- PDF info panel background: via the color resource named gv_analysis_pdf_info_background
- PDF filename text style: via overriding the style named GiniVisionTheme.Analysis.PdfFilename.TextStyle and setting an item named android:textStyle to normal, bold or italic
- PDF filename text size: via overriding the style named GiniVisionTheme.Analysis.PdfFilename.TextStyle and setting an item named autoSizeMaxTextSize and autoSizeMinTextSize to the desired maximum and minimum sp sizes
- PDF filename text color: via the color resource named gv_analysis_pdf_info_text
- PDF filename font: via overriding the style named GiniVisionTheme.Analysis.PdfFilename.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
- PDF page count text style: via overriding the style named GiniVisionTheme.Analysis.PdfPageCount.TextStyle and setting an item named android:textStyle to normal, bold or italic
- PDF page count text size: via overriding the style named GiniVisionTheme.Analysis.PdfPageCount.TextStyle and setting an item named android:textSize to the desired sp size
- PDF page count text color: via the color resource named gv_analysis_pdf_info_text
- PDF page count font: via overriding the style named GiniVisionTheme.Analysis.PdfPageCount.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
- Background color: via the color resource named gv_background. Note: this color resource is global to all Activities (CameraActivity, OnboardingActivity, ReviewActivity, AnalysisActivity)
- Error message text color: via the color resource named gv_snackbar_error_text
- Error message font: via overriding the style named GiniVisionTheme.Snackbar.Error.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
- Error message text style: via overriding the style named GiniVisionTheme.Snackbar.Error.TextStyle and setting an item named android:textStyle to normal, bold or italic
- Error message text size: via overriding the style named GiniVisionTheme.Snackbar.Error.TextStyle and setting an item named android:textSize to the desired sp size
- Error message button text color: via the color resource named gv_snackbar_error_button_title and gv_snackbar_error_button_title_pressed
- Error message button font: via overriding the style named GiniVisionTheme.Snackbar.Error.Button.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
- Error message button text style: via overriding the style named GiniVisionTheme.Snackbar.Error.Button.TextStyle and setting an item named android:textStyle to normal, bold or italic
- Error message button text size: via overriding the style named GiniVisionTheme.Snackbar.Error.Button.TextStyle and setting an item named android:textSize to the desired sp size
- Error message background color: via the color resource named gv_snackbar_error_background
- Document analysis error message retry button text: via the string resource named gv_document_analysis_error_retry
Important: All overriden styles must have their respective Root. prefixed style as their parent. Ex.: the parent of GiniVisionTheme.Snackbar.Error.TextStyle must be Root.GiniVisionTheme.Snackbar.Error.TextStyle.
Customizing the Action Bar

Customizing the Action Bar is also done via overriding of app resources and each one - except the title string resource - is global to all Activities (CameraActivity, OnboardingActivity, ReviewActivity, MultiPageReviewActivity, AnalysisActivity).
The following items are customizable:
- Background color: via the color resource named gv_action_bar (highly recommended for Android 5+: customize the status bar color via gv_status_bar)
- Back button (only for ReviewActivity and AnalysisActivity): via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_action_bar_back

Constructor Summary

Constructors
Constructor and Description

AnalysisActivity()

Constructors
Constructor and Description
`AnalysisActivity()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`hideError()` Call this method to hide the error shown before with `AnalysisFragmentInterface.showError(String, String, View.OnClickListener)` or `AnalysisFragmentInterface.showError(String, int)`.
`void`	`onAddDataToResult(Intent result)` Deprecated. When a `GiniVision` instance is available the document is analyzed internally by using the configured `GiniVisionNetworkService` implementation. The extractions will be returned in the extra called `CameraActivity.EXTRA_OUT_EXTRACTIONS` of the `CameraActivity`'s result Intent.
`void`	`onAnalyzeDocument(Document document)` Deprecated. When a `GiniVision` instance is available the document is analyzed internally by using the configured `GiniVisionNetworkService` implementation. The extractions will be returned in the extra called `CameraActivity.EXTRA_OUT_EXTRACTIONS` of the `CameraActivity`'s result Intent.
`void`	`onBackPressed()`
`void`	`onDefaultPDFAppAlertDialogCancelled()` Called when the default PDF app alert dialog was cancelled.
`void`	`onDocumentAnalyzed()` Deprecated. When a `GiniVision` instance is available the document is analyzed internally by using the configured `GiniVisionNetworkService` implementation. The extractions will be returned in the extra called `CameraActivity.EXTRA_OUT_EXTRACTIONS` of the `CameraActivity`'s result Intent.
`void`	`onError(GiniVisionError error)` Called when an error occurred.
`void`	`onExtractionsAvailable(java.util.Map extractions)` Called when the document has been analyzed and extractions are available.
`void`	`onNoExtractionsFound()` Deprecated. When a `GiniVision` instance is available the document is analyzed internally by using the configured `GiniVisionNetworkService` implementation.
`boolean`	`onOptionsItemSelected(MenuItem item)`
`void`	`onProceedToNoExtractionsScreen(Document document)` Called when the document has been analyzed and no extractions were received.
`void`	`setListener(AnalysisFragmentListener listener)` Set a listener for analysis events.
`void`	`showError(java.lang.String message, int duration)` Call this method when you need to show an error message to the user in the Analysis Screen.
`void`	`showError(java.lang.String message, java.lang.String buttonTitle, View.OnClickListener onClickListener)` Call this method when you need to show an error message with an invokable action to the user in the Analysis Screen.
`void`	`startScanAnimation()` Deprecated. When a `GiniVision` instance is available the document is analyzed internally by using the configured `GiniVisionNetworkService` implementation. The extractions will be returned in the extra called `CameraActivity.EXTRA_OUT_EXTRACTIONS` of the `CameraActivity`'s result Intent.
`void`	`stopScanAnimation()` Deprecated. When a `GiniVision` instance is available the document is analyzed internally by using the configured `GiniVisionNetworkService` implementation. The extractions will be returned in the extra called `CameraActivity.EXTRA_OUT_EXTRACTIONS` of the `CameraActivity`'s result Intent.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AnalysisActivity
```
public AnalysisActivity()
```
- Method Detail
  - hideError
```
public void hideError()
```
    Description copied from interface: AnalysisFragmentInterface
    
    Call this method to hide the error shown before with AnalysisFragmentInterface.showError(String, String, View.OnClickListener) or AnalysisFragmentInterface.showError(String, int).
    
    Specified by:
    
    hideError in interface AnalysisFragmentInterface
  - onNoExtractionsFound
```
@Deprecated
public void onNoExtractionsFound()
```
    Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation.
    
    You should call this method after you've received the analysis results from the Gini API without the required extractions.
    
    It will launch the NoResultsActivity, if the Document's type is Document.Type#IMAGE. For other types it will just finish the AnalysisActivity with RESULT_OK.
    
    Specified by:
    
    onNoExtractionsFound in interface AnalysisFragmentInterface
  - onAnalyzeDocument
```
@Deprecated
public void onAnalyzeDocument(Document document)
```
    Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the extra called CameraActivity.EXTRA_OUT_EXTRACTIONS of the CameraActivity's result Intent.
    
    Screen API: If an analysis error message was set in the Review Screen with ReviewActivity.onDocumentAnalysisError(String) this method won't be called until the user clicks the retry button next to the error message.
    
    Specified by:
    
    onAnalyzeDocument in interface AnalysisFragmentListener
    
    Parameters:
    
    document - contains the image taken by the camera (original or modified)
  - onDocumentAnalyzed
```
@Deprecated
public void onDocumentAnalyzed()
```
    Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the extra called CameraActivity.EXTRA_OUT_EXTRACTIONS of the CameraActivity's result Intent.
    
    Description copied from interface: AnalysisFragmentInterface
    
    You should call this method after you've received the analysis results from the Gini API.
    
    Specified by:
    
    onDocumentAnalyzed in interface AnalysisFragmentInterface
  - onError
```
public void onError(GiniVisionError error)
```
    Description copied from interface: AnalysisFragmentListener
    
    Called when an error occurred.
    
    Specified by:
    
    onError in interface AnalysisFragmentListener
    
    Parameters:
    
    error - details about what went wrong
  - onOptionsItemSelected
```
public boolean onOptionsItemSelected(MenuItem item)
```
  - onBackPressed
```
public void onBackPressed()
```
  - showError
```
public void showError(java.lang.String message,
                      java.lang.String buttonTitle,
                      View.OnClickListener onClickListener)
```
    Description copied from interface: AnalysisFragmentInterface
    
    Call this method when you need to show an error message with an invokable action to the user in the Analysis Screen.
    
    Specified by:
    
    showError in interface AnalysisFragmentInterface
    
    Parameters:
    
    message - a short error message
    
    buttonTitle - if not null and not empty, shows a button with the given title
    
    onClickListener - listener for the button
  - showError
```
public void showError(java.lang.String message,
                      int duration)
```
    Description copied from interface: AnalysisFragmentInterface
    
    Call this method when you need to show an error message to the user in the Analysis Screen.
    
    Specified by:
    
    showError in interface AnalysisFragmentInterface
    
    Parameters:
    
    message - a short error message
    
    duration - how long should the error message be shown in ms
  - startScanAnimation
```
@Deprecated
public void startScanAnimation()
```
    Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the extra called CameraActivity.EXTRA_OUT_EXTRACTIONS of the CameraActivity's result Intent.
    
    Description copied from interface: AnalysisFragmentInterface
    
    You should call this method when you start the document analysis using the Gini API.
    
    Specified by:
    
    startScanAnimation in interface AnalysisFragmentInterface
  - stopScanAnimation
```
@Deprecated
public void stopScanAnimation()
```
    Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the extra called CameraActivity.EXTRA_OUT_EXTRACTIONS of the CameraActivity's result Intent.
    
    Description copied from interface: AnalysisFragmentInterface
    
    You should call this method when the document analysis has finished.
    
    Specified by:
    
    stopScanAnimation in interface AnalysisFragmentInterface
  - onAddDataToResult
```
@Deprecated
public void onAddDataToResult(Intent result)
```
    Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the extra called CameraActivity.EXTRA_OUT_EXTRACTIONS of the CameraActivity's result Intent.
    
    Callback for adding your own data to the Activity's result.
    
    Called when the document was analyzed.
    
    You should add the results of the analysis as extras and retrieve them when the CameraActivity returned.
    
    Note: you must call AnalysisActivity.onDocumentAnalyzed() after you received the analysis results from the Gini API, otherwise this method won't be invoked.
    
    Parameters:
    
    result - the Intent which will be returned as the result data.
  - setListener
```
public void setListener(AnalysisFragmentListener listener)
```
    Description copied from interface: AnalysisFragmentInterface
    
    Set a listener for analysis events.
    
    By default the hosting Activity is expected to implement the AnalysisFragmentListener. In case that is not feasible you may set the listener using this method.
    
    Note: the listener is expected to be available until the fragment is attached to an activity. Make sure to set the listener before that.
    
    Specified by:
    
    setListener in interface AnalysisFragmentInterface
    
    Parameters:
    
    listener - AnalysisFragmentListener instance
  - onExtractionsAvailable
```
public void onExtractionsAvailable(java.util.Map extractions)
```
    Description copied from interface: AnalysisFragmentListener
    
    Called when the document has been analyzed and extractions are available.
    
    Specified by:
    
    onExtractionsAvailable in interface AnalysisFragmentListener
    
    Parameters:
    
    extractions - a map of the extractions with the extraction labels as keys
  - onProceedToNoExtractionsScreen
```
public void onProceedToNoExtractionsScreen(Document document)
```
    Description copied from interface: AnalysisFragmentListener
    
    Called when the document has been analyzed and no extractions were received.
    You should show the NoResultsFragmentStandard or NoResultsFragmentCompat.
    
    Specified by:
    
    onProceedToNoExtractionsScreen in interface AnalysisFragmentListener
    
    Parameters:
    
    document - contains the reviewed document
  - onDefaultPDFAppAlertDialogCancelled
```
public void onDefaultPDFAppAlertDialogCancelled()
```
    Description copied from interface: AnalysisFragmentListener
    
    Called when the default PDF app alert dialog was cancelled. You should close the AnalysisFragment because the user decided not to continue with analysis.
    This alert dialog is shown for PDFs imported from another app when your app was set as default for opening PDFs.
    
    Specified by:
    
    onDefaultPDFAppAlertDialogCancelled in interface AnalysisFragmentListener

Class AnalysisActivity

Screen API

Customizing the Analysis Screen

Customizing the Action Bar

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AnalysisActivity

Method Detail

hideError

onNoExtractionsFound

onAnalyzeDocument

onDocumentAnalyzed

onError

onOptionsItemSelected

onBackPressed

showError

showError

startScanAnimation

stopScanAnimation

onAddDataToResult

setListener

onExtractionsAvailable

onProceedToNoExtractionsScreen

onDefaultPDFAppAlertDialogCancelled