Package org.daisy.dotify.formatter.impl.volume

Class VolumeTemplate

java.lang.Object

org.daisy.dotify.formatter.impl.volume.VolumeTemplate

All Implemented Interfaces:

VolumeTemplateBuilder

public class VolumeTemplate
extends Object
implements VolumeTemplateBuilder

Provides a VolumeTemplateBuilder implementation.

Constructor Summary

Constructors

Constructor	Description
VolumeTemplate(FormatterCoreContext fc, Condition condition, Integer splitterMax)

Method Summary

Modifier and Type	Method	Description
boolean	appliesTo(Context context)	Test if this Template applies to this combination of volume and volume count.
Iterable<VolumeSequence>	getPostVolumeContent()
VolumeContentBuilder	getPostVolumeContentBuilder()	Gets the post volume content builder.
Iterable<VolumeSequence>	getPreVolumeContent()
VolumeContentBuilder	getPreVolumeContentBuilder()	Gets the pre volume content builder.
int	getVolumeMaxSize()	Gets the maximum number of sheets allowed.

Methods inherited from class java.lang.Object

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

Constructor Detail

VolumeTemplate

public VolumeTemplate(FormatterCoreContext fc,
                      Condition condition,
                      Integer splitterMax)

Method Detail

appliesTo

public boolean appliesTo(Context context)

Test if this Template applies to this combination of volume and volume count.

Parameters:

context - the context to test

Returns:

returns true if the Template should be applied to the volume

getPreVolumeContent

public Iterable<VolumeSequence> getPreVolumeContent()

getPostVolumeContent

public Iterable<VolumeSequence> getPostVolumeContent()

getVolumeMaxSize

public int getVolumeMaxSize()

Gets the maximum number of sheets allowed.

Returns:

returns the number of sheets allowed

getPreVolumeContentBuilder

public VolumeContentBuilder getPreVolumeContentBuilder()

Description copied from interface: VolumeTemplateBuilder

Gets the pre volume content builder.

Specified by:

getPreVolumeContentBuilder in interface VolumeTemplateBuilder

Returns:

returns the pre volume content builder

getPostVolumeContentBuilder

public VolumeContentBuilder getPostVolumeContentBuilder()

Description copied from interface: VolumeTemplateBuilder

Gets the post volume content builder.

Specified by:

getPostVolumeContentBuilder in interface VolumeTemplateBuilder

Returns:

returns the post volume content builder