Package com.levigo.jadice.server.documentplatform

Interface IDocumentInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

JadiceDocumentInfo

public interface IDocumentInfo
extends Serializable

DTO that contains information about a document the JadiceDocumentInfoNode has processed.

See Also:

JadiceDocumentInfoNode

Method Summary

Modifier and Type	Method	Description
String	getBaseFormat()
String	getFormat(int pageIndex)	Determine the Format of a given page.
float	getHorizontalResolution(int pageIndex)	Determine the horizontal resolution of a given page in dpi.
com.levigo.jadice.document.metadata.Metadata	getMetadata(int pageIndex)	Return the Metadata for a given page.
int	getPageCount()
Dimension2D	getSize(int pageIndex)	Determine the size of a given page in Unit.JadiceDocumentUnit.
String	getUUID()
float	getVerticalResolution(int pageIndex)	Determine the vertical resolution of a given page in dpi.
boolean	isAnnotated()

Method Detail

getUUID

String getUUID()

Returns:

The UUID of the Stream that was analyzed

See Also:

StreamDescriptor.getUUID()

getPageCount

int getPageCount()

Returns:

Number of pages

isAnnotated

boolean isAnnotated()

Returns:

true if the document contains annotations

getBaseFormat

String getBaseFormat()

Returns:

The description of the document's page format. Might be null if the document has an unknown or unsupported format

getSize

Dimension2D getSize(int pageIndex)

Determine the size of a given page in Unit.JadiceDocumentUnit.

Parameters:

pageIndex - The index of the page (0-based). Value must be in range [0.. getPageCount()-1]

Returns:

The size of the page in Unit.JadiceDocumentUnit

getVerticalResolution

float getVerticalResolution(int pageIndex)

Determine the vertical resolution of a given page in dpi.

Parameters:

pageIndex - The index of the page (0-based). Value must be in range [0.. getPageCount()-1]

Returns:

The vertical resolution of the page in dpi

getHorizontalResolution

float getHorizontalResolution(int pageIndex)

Determine the horizontal resolution of a given page in dpi.

Parameters:

pageIndex - The index of the page (0-based). Value must be in range [0.. getPageCount()-1]

Returns:

The horizontal resolution of the page in dpi

getFormat

String getFormat(int pageIndex)

Determine the Format of a given page.

Parameters:

pageIndex - The index of the page (0-based). Value must be in range [0.. getPageCount()-1]

Returns:

The format description of the page, might be null

getMetadata

com.levigo.jadice.document.metadata.Metadata getMetadata(int pageIndex)

Return the Metadata for a given page.

Parameters:

pageIndex - The index of the page (0-based). Value must be in range [0.. getPageCount()-1]

Returns:

The meta data of the page, might be null

Since:

jadice server 5.1.4.0