com.levigo.jadice.format.hocr

Class HocrFormat

java.lang.Object

com.levigo.jadice.document.Format

com.levigo.jadice.format.hocr.HocrFormat

All Implemented Interfaces:

Cloneable

public final class HocrFormat
extends Format

Format information for hOCR documents. The jadice hOCR implementation supports valid XHTML documents in the following flavours:

• Tesseract 3.05.00 or later
• Tesseract 4

Besides numeric entities, the following five named entities will be recognized: amp, apos, gt, lt, quot.

Field Summary

Fields inherited from class com.levigo.jadice.document.Format

BASE_FORMAT_VERSION, DEFAULT_PRIORITY, MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor and Description
HocrFormat()

Method Summary

Modifier and Type	Method and Description
FormatReader	createReader() Instantiate a new FormatReader for this format.
String[]	getDefaultExtensions() The default file-extension for the format.
String	getDescription() Describes the format represented by this instance.
MimeType	getMimeType() Return the string-encoded MIME-Type of the format.
String	getName() Return the format's name.
String	getVersion() The version of the format support.
boolean	matches(SeekableInputStream seekableInputStream) Since hOCR files should only be read explicitly, this method always returns false.

Methods inherited from class com.levigo.jadice.document.Format

canRead, canWrite, create, createWriter, equals, getPriority, hashCode, isSecondary, isSupported, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HocrFormat

public HocrFormat()

Method Detail

getDefaultExtensions

public String[] getDefaultExtensions()

Description copied from class: Format

The default file-extension for the format.

Specified by:

getDefaultExtensions in class Format

Returns:

an array of default file extension of this format

getDescription

public String getDescription()

Description copied from class: Format

Describes the format represented by this instance.

Specified by:

getDescription in class Format

Returns:

a description of this format

getName

public String getName()

Description copied from class: Format

Return the format's name.

Specified by:

getName in class Format

Returns:

the format's name

getVersion

public String getVersion()

Description copied from class: Format

The version of the format support.

Specified by:

getVersion in class Format

Returns:

the version of format support

matches

public boolean matches(SeekableInputStream seekableInputStream)

Since hOCR files should only be read explicitly, this method always returns false.

Specified by:

matches in class Format

Parameters:

seekableInputStream - will be ignored

Returns:

always false

createReader

public FormatReader createReader()

Description copied from class: Format

Instantiate a new FormatReader for this format.

Overrides:

createReader in class Format

Returns:

a FormatReader for this format

getMimeType

public MimeType getMimeType()

Description copied from class: Format

Return the string-encoded MIME-Type of the format.

Specified by:

getMimeType in class Format

Returns:

the MIME-Type