org.writersforge.catalan.transform.rule
Interface Rule

All Known Implementing Classes:

QueryRule, Recipe, RuleCollection

public interface Rule

A processing rule for defining complex operations on Datum content. A Rule can be a filter, a transform, simple text substitution, or might perform massive, sweepng changes on the content. The order a set of Rules is applied to content is predictable when driven by a Transformer, so it's possible to rely upon the results of previous Rules, for example to perform progressive formatting changes.

Author:

jsheets

Method Summary

org.writersforge.bellows.Datum

process(org.writersforge.bellows.Datum content) Applies changes to the supplied content.

Method Detail

process

public org.writersforge.bellows.Datum process(org.writersforge.bellows.Datum content)

Applies changes to the supplied content. If the Rule decides not to make any changes, it can return the original content, untouched.

Parameters:

content - a Datum object to apply the Rule to

Returns:

the transformed content