Package chemaxon.naming.document.annotate

Class DocumentAnnotatorOptions

java.lang.Object

chemaxon.naming.document.annotate.DocumentAnnotatorOptions

@PublicApi
public class DocumentAnnotatorOptions
extends Object

Represents various options regarding how a document should be annotated, both in terms of input and output.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentAnnotatorOptions.Builder	A builder for DocumentAnnotatorOptions, allowing for options to be built using a fluent interface.
static enum	DocumentAnnotatorOptions.ImageFormat	A list of supported image formats for popups in the annotated document.

Field Summary

Fields

Modifier and Type	Field	Description
final Integer	firstPage	The first page of the document that should be annotated.
final Integer	lastPage	The last page of the document that should be annotated.
final DocumentAnnotator.Listener	listener	A listener that will be notified of the progress of the annotation.
final String	nameStructureFormat	The structure format used to represent hits converted from names.
static final String	NoStructureFormat	Use this format constant to avoid exporting any structural format in the HTML output.
final DocumentAnnotatorOptions.ImageFormat	popupImageFormat	The image format which should be used for popups in the annotated document.
final String	structureFormat	The structure format used to represent hits converted from other sources than names (OSR, embedded structures, ...).
final Boolean	useOpticalCharacterRecognition	Whether to use Optical Character Recognition on images.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

NoStructureFormat

public static final String NoStructureFormat

Use this format constant to avoid exporting any structural format in the HTML output.

See Also:

• DocumentAnnotatorOptions.Builder.structureFormat(String)
• DocumentAnnotatorOptions.Builder.nameStructureFormat(String)

firstPage

public final Integer firstPage

The first page of the document that should be annotated.

By default or if null, the document is annotated from the starting page.

Note that this option only applies to documents that have page numbers, in particular PDF documents.

lastPage

public final Integer lastPage

The last page of the document that should be annotated.

By default or if null, the document is annotated until its last page.

Note that this option only applies to documents that have page numbers, in particular PDF documents.

listener

public final DocumentAnnotator.Listener listener

A listener that will be notified of the progress of the annotation.

This can be used for instance to implement a progress bar.

useOpticalCharacterRecognition

public final Boolean useOpticalCharacterRecognition

Whether to use Optical Character Recognition on images.

By default (and when set to null), Document Annotator will try to determine if OCR is required. In particular, OCR will be skipped the document has already been OCR'd by a known program.

nameStructureFormat

public final String nameStructureFormat

The structure format used to represent hits converted from names.

structureFormat

public final String structureFormat

The structure format used to represent hits converted from other sources than names (OSR, embedded structures, ...).

popupImageFormat

public final DocumentAnnotatorOptions.ImageFormat popupImageFormat

The image format which should be used for popups in the annotated document.