PageId (dotify.library 1.0.5 API)

java.lang.Object
- org.daisy.dotify.formatter.impl.search.PageId

public final class PageId
extends Object

TODO: Write java doc.

Constructor Summary

Constructors
Constructor Description

PageId(int ordinal, int globalStartIndex, SequenceId sequenceId)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`int`	`getOrdinal()`	0-based index of this page in the current sequence.
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PageId
```
public PageId(int ordinal,
              int globalStartIndex,
              SequenceId sequenceId)
```
    Parameters:
    
    ordinal - Numbering of the current page.
    
    globalStartIndex - Start index of the sequence that contains this page: the number of pages that the whole body (all sequences), or the pre- or post-content of the current volume, already contains.
    
    sequenceId - Index of the page in current sequence.
- Method Detail
  - getOrdinal
```
public int getOrdinal()
```
    0-based index of this page in the current sequence.
    
    Returns:
    
    Index of the page in current sequence.
  - 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