Package com.levigo.jadice.server.documentplatform

Class JadiceDocumentInfo

java.lang.Object

com.levigo.jadice.server.documentplatform.JadiceDocumentInfo

All Implemented Interfaces:

IDocumentInfo, Serializable

public class JadiceDocumentInfo
extends Object
implements IDocumentInfo, Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
JadiceDocumentInfo(String uuid, int pageCount, boolean isAnnotated, String baseFormat, Dimension2D[] pageSizes, float[] verticalResolutions, float[] horizontalResolutions, String[] pageFormats, com.levigo.jadice.document.metadata.Metadata[] metadata)

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()

Methods inherited from class java.lang.Object

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

Constructor Detail

JadiceDocumentInfo

public JadiceDocumentInfo(String uuid,
                          int pageCount,
                          boolean isAnnotated,
                          String baseFormat,
                          Dimension2D[] pageSizes,
                          float[] verticalResolutions,
                          float[] horizontalResolutions,
                          String[] pageFormats,
                          com.levigo.jadice.document.metadata.Metadata[] metadata)

Method Detail

getUUID

public String getUUID()

Specified by:

getUUID in interface IDocumentInfo

Returns:

The UUID of the Stream that was analyzed

See Also:

StreamDescriptor.getUUID()

getPageCount

public int getPageCount()

Specified by:

getPageCount in interface IDocumentInfo

Returns:

Number of pages

isAnnotated

public boolean isAnnotated()

Specified by:

isAnnotated in interface IDocumentInfo

Returns:

true if the document contains annotations

getBaseFormat

public String getBaseFormat()

Specified by:

getBaseFormat in interface IDocumentInfo

Returns:

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

getSize

public Dimension2D getSize(int pageIndex)

Description copied from interface: IDocumentInfo

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

Specified by:

getSize in interface IDocumentInfo

Parameters:

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

Returns:

The size of the page in Unit.JadiceDocumentUnit

getVerticalResolution

public float getVerticalResolution(int pageIndex)

Description copied from interface: IDocumentInfo

Determine the vertical resolution of a given page in dpi.

Specified by:

getVerticalResolution in interface IDocumentInfo

Parameters:

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

Returns:

The vertical resolution of the page in dpi

getHorizontalResolution

public float getHorizontalResolution(int pageIndex)

Description copied from interface: IDocumentInfo

Determine the horizontal resolution of a given page in dpi.

Specified by:

getHorizontalResolution in interface IDocumentInfo

Parameters:

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

Returns:

The horizontal resolution of the page in dpi

getFormat

public String getFormat(int pageIndex)

Description copied from interface: IDocumentInfo

Determine the Format of a given page.

Specified by:

getFormat in interface IDocumentInfo

Parameters:

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

Returns:

The format description of the page, might be null

getMetadata

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

Description copied from interface: IDocumentInfo

Return the Metadata for a given page.

Specified by:

getMetadata in interface IDocumentInfo

Parameters:

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

Returns:

The meta data of the page, might be null