org.daisy.dotify.api.translator

Interface MarkerProcessor

public interface MarkerProcessor

Provides an interface to a marker processor. A marker processor is responsible for converting and inserting the supplied text attributes as text markers.

Method Summary

Modifier and Type	Method and Description
java.lang.String	processAttributes(TextAttribute atts, java.lang.String... text) Processes the input text and attributes into a text containing markers at the appropriate positions.
java.lang.String[]	processAttributesRetain(TextAttribute atts, java.lang.String[] text) Processes the input text chunks and attributes into a text containing markers at the appropriate positions while retaining the text partition as specified by the input array.

Method Detail

processAttributes

java.lang.String processAttributes(TextAttribute atts,
                                   java.lang.String... text)

Processes the input text and attributes into a text containing markers at the appropriate positions. The length of the text(s) must match the text attributes specified width.

Parameters:

atts - the text attributes that apply to the text.

text - the text(s) to process

Returns:

returns a string with markers

Throws:

java.lang.IllegalArgumentException - if the specified attributes does not match the text.

processAttributesRetain

java.lang.String[] processAttributesRetain(TextAttribute atts,
                                           java.lang.String[] text)

Processes the input text chunks and attributes into a text containing markers at the appropriate positions while retaining the text partition as specified by the input array. The length of the texts must match the text attributes specified width.

Parameters:

text - the texts to process

atts - the text attributes that apply to the text.

Returns:

returns an array of strings with markers

Throws:

java.lang.IllegalArgumentException - if the specified attributes does not match the text.