org.daisy.dotify.api.formatter

Interface Context

public interface Context

Provides a formatter context that can be used to process context aware content.

Method Summary

Modifier and Type	Method and Description
default java.lang.Integer	getCurrentPage() Gets the current page number (one based) or null if not known.
default java.lang.Integer	getCurrentVolume() Gets the current volume number (one based) or null if not known.
default java.lang.Integer	getMetaPage() Gets the page number (one based) of the context described the current context, or null if not available.
default java.lang.Integer	getMetaVolume() Gets the volume number (one based) of the context described in the current context, or null if not available.
default java.lang.Integer	getPagesInDocument() Gets the total number of pages contained in the document, or null if not known.
default java.lang.Integer	getPagesInVolume() Gets the total number of pages contained in the current volume, or null if not known.
default java.lang.Integer	getSheetsInDocument() Gets the total number of sheets contained in the document, or null if not known.
default java.lang.Integer	getSheetsInVolume() Gets the total number of sheets contained in the current volume, or null if not known.
default java.lang.Integer	getVolumeCount() Gets the volume count or null if not known.

Method Detail

getCurrentVolume

default java.lang.Integer getCurrentVolume()

Gets the current volume number (one based) or null if not known.

Returns:

returns the current volume number

getVolumeCount

default java.lang.Integer getVolumeCount()

Gets the volume count or null if not known.

Returns:

returns the volume count

getCurrentPage

default java.lang.Integer getCurrentPage()

Gets the current page number (one based) or null if not known.

Returns:

returns the current page number

getMetaVolume

default java.lang.Integer getMetaVolume()

Gets the volume number (one based) of the context described in the current context, or null if not available. For example, an entry in a table of contents or an end note are examples where this method can be used to retrieve the original context.

Returns:

returns the meta volume number

getMetaPage

default java.lang.Integer getMetaPage()

Gets the page number (one based) of the context described the current context, or null if not available. For example, an entry in a table of contents or an end note are examples where this method can be used to retrieve the original context.

Returns:

returns the meta page number

getPagesInVolume

default java.lang.Integer getPagesInVolume()

Gets the total number of pages contained in the current volume, or null if not known. This should include the volume's pre- and post-content.

Returns:

returns the number of pages in the current volume, or null if not known.

getPagesInDocument

default java.lang.Integer getPagesInDocument()

Gets the total number of pages contained in the document, or null if not known.

Returns:

returns the number of pages in the document, or null if not known.

getSheetsInVolume

default java.lang.Integer getSheetsInVolume()

Gets the total number of sheets contained in the current volume, or null if not known. This should include the volume's pre- and post-content.

Returns:

returns the number of sheets in the current volume, or null if not known.

getSheetsInDocument

default java.lang.Integer getSheetsInDocument()

Gets the total number of sheets contained in the document, or null if not known.

Returns:

returns the number of sheets in the document, or null if not known.