org.afplib.io

Class AbstractChainLink

java.lang.Object

org.afplib.io.AbstractChainLink

All Implemented Interfaces:

ChainLink

public abstract class AbstractChainLink
extends Object
implements ChainLink

Field Summary

Fields

Modifier and Type	Field and Description
protected Chain	chain
protected List<SF>	sfBuffer

Constructor Summary

Constructors

Constructor and Description
AbstractChainLink()

Method Summary

Modifier and Type	Method and Description
protected void	commit()
boolean	needTwoPass() signals that this filter wants to read the AFP before actually modifying it.
boolean	onStructuredField(Chain chain, SF sf) is called for each structured field.
protected abstract boolean	onStructuredField(SF sf)
protected boolean	read(SF sf)

Methods inherited from class java.lang.Object

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

Field Detail

sfBuffer

protected List<SF> sfBuffer

chain

protected Chain chain

Constructor Detail

AbstractChainLink

public AbstractChainLink()

Method Detail

needTwoPass

public boolean needTwoPass()

Description copied from interface: ChainLink

signals that this filter wants to read the AFP before actually modifying it. Can be used to first know e.g. which IMMs are used in an AFP file. If needTwoPass returns true, onStructuredField will be first called with chain=null passing all SF for reading. The second pass actually requires a commit call on Chain.

Specified by:

needTwoPass in interface ChainLink

Returns:

true, if this filter wants to read the AFP before modifying it.

onStructuredField

public final boolean onStructuredField(Chain chain,
                                       SF sf)
                                throws IOException

Description copied from interface: ChainLink

is called for each structured field. The implementing class needs to call commit on Chain for each structured field(s) it wants to be saved. If a filter does not commit the resulting AFP will be empty.

Specified by:

onStructuredField in interface ChainLink

Parameters:

chain - functional interface for committing changes or just passing SFs to the next filter

sf - structured field

Returns:

false, if the work of this filter is done.

Throws:

IOException

onStructuredField

protected abstract boolean onStructuredField(SF sf)
                                      throws IOException

Throws:

IOException

commit

protected void commit()
               throws IOException

Throws:

IOException

read

protected boolean read(SF sf)