Package org.daisy.dotify.formatter.impl.search

Class PageDetails

java.lang.Object

org.daisy.dotify.formatter.impl.search.PageDetails

public class PageDetails
extends Object

TODO: Write java doc.

Constructor Summary

Constructors

Constructor	Description
PageDetails(boolean duplex, PageId pageId, BlockLineLocation loc, int pageNumberOffset)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
List<String>	getContentIdentifiers()	Get identifiers for this page excluding identifiers before text content.
List<String>	getIdentifiers()	Get all identifiers for this page.
List<Marker>	getMarkers()	Get all markers for this page.
PageId	getPageId()
BlockLineLocation	getPageLocation()	BlockLineLocation of the last line of the previous page.
int	getPageNumber()
int	hashCode()
void	startsContentIdentifiers()	Sets content identifiers to begin at the current index in the identifiers list.
void	startsContentMarkers()	Sets content markers to begin at the current index in the markers list.
String	toString()
PageDetails	with(int ordinal)

Methods inherited from class java.lang.Object

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

Constructor Detail

PageDetails

public PageDetails(boolean duplex,
                   PageId pageId,
                   BlockLineLocation loc,
                   int pageNumberOffset)

Parameters:

duplex - Double sided output.

pageId - ID of the page.

loc - Block location for the start of this page.

pageNumberOffset - The offset that needs to be added to the 1-based index of the page within the sequence to obtain the desired page number.

Method Detail

with

public PageDetails with(int ordinal)

getPageId

public PageId getPageId()

getPageNumber

public int getPageNumber()

getPageLocation

public BlockLineLocation getPageLocation()

BlockLineLocation of the last line of the previous page.

Returns:

page location for last line of previous page.

startsContentMarkers

public void startsContentMarkers()

Sets content markers to begin at the current index in the markers list.

startsContentIdentifiers

public void startsContentIdentifiers()

Sets content identifiers to begin at the current index in the identifiers list.

getMarkers

public List<Marker> getMarkers()

Get all markers for this page.

Returns:

returns a list of all markers on a page

getIdentifiers

public List<String> getIdentifiers()

Get all identifiers for this page.

Returns:

returns a list of all identifiers on a page

getContentIdentifiers

public List<String> getContentIdentifiers()

Get identifiers for this page excluding identifiers before text content.

Returns:

returns a list of identifiers on a page

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object