SpineReference

java.lang.Object
- nl.siegmann.epublib.domain.ResourceReference
- - nl.siegmann.epublib.domain.SpineReference

All Implemented Interfaces:

java.io.Serializable
```
public class SpineReference
extends ResourceReference
implements java.io.Serializable
```
A Section of a book. Represents both an item in the package document and a item in the index.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

private boolean linear

private static long serialVersionUID
- Fields inherited from class nl.siegmann.epublib.domain.ResourceReference
  resource

Constructor Summary

Constructors
Constructor Description

SpineReference(Resource resource)

SpineReference(Resource resource, boolean linear)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`isLinear()`	Linear denotes whether the section is Primary or Auxiliary.
`void`	`setLinear(boolean linear)`

Methods inherited from class nl.siegmann.epublib.domain.ResourceReference
getResource, getResourceId, setResource

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

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - linear
```
private boolean linear
```
- Constructor Detail
  - SpineReference
```
public SpineReference(Resource resource)
```
  - SpineReference
```
public SpineReference(Resource resource,
                      boolean linear)
```
- Method Detail
  - isLinear
```
public boolean isLinear()
```
    Linear denotes whether the section is Primary or Auxiliary. Usually the cover page has linear set to false and all the other sections have it set to true. It's an optional property that readers may also ignore.
    primary or auxiliary is useful for Reading Systems which opt to present auxiliary content differently than primary content. For example, a Reading System might opt to render auxiliary content in a popup window apart from the main window which presents the primary content. (For an example of the types of content that may be considered auxiliary, refer to the example below and the subsequent discussion.)
    
    Returns:
    
    whether the section is Primary or Auxiliary.
    
    See Also:
    
    OPF Spine specification
  - setLinear
```
public void setLinear(boolean linear)
```