de.innovationgate.wgpublisher.encoders

Class EncoderOutput

java.lang.Object

de.innovationgate.wgpublisher.encoders.EncoderOutput

public class EncoderOutput
extends java.lang.Object

Output object for WGA encoders

Constructor Summary

Constructors

Constructor and Description
EncoderOutput(TextChunk inputChunk)

Method Summary

Methods

Modifier and Type	Method and Description
EncoderOutput	addChunk(java.lang.CharSequence text) Add a new text chunk to the output of origin TextChunk.Origin.INPUT and content type "text/plain"
EncoderOutput	addChunk(TextChunk.Origin origin, java.lang.String contentType, java.lang.CharSequence text) Add a new text chunk to the output
EncoderOutput	chainEncoder(WGAEncoder encoder) Chains another encoder that should run after this encoder run finishes.
EncoderOutput	clearChunks() Removes all already added chunks
java.util.List<WGAEncoder>	getChainedEncoders() Returns encoders that were chained after the current encoder run
java.util.List<TextChunk>	getOutputChunks() Returns the added chunks
EncoderOutput	ignoreChunk() Notifies that the encoder ignores the current text chunk, which will be kept unmodified.
EncoderOutput	replaceChunk(java.lang.String text) Replaces text of the input chunk with the given chunk text, keeping the origin of the original chunk
EncoderOutput	replaceChunkViaRegex(java.util.regex.Pattern pattern, java.lang.String replacement) Replaces parts of the input chunk using a regular expression.

Methods inherited from class java.lang.Object

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

Constructor Detail

EncoderOutput

public EncoderOutput(TextChunk inputChunk)

Method Detail

getChainedEncoders

public java.util.List<WGAEncoder> getChainedEncoders()

Returns encoders that were chained after the current encoder run

addChunk

public EncoderOutput addChunk(TextChunk.Origin origin,
                     java.lang.String contentType,
                     java.lang.CharSequence text)

Add a new text chunk to the output

Parameters:

origin - The origin of the chunk

contentType - The content type of the chunk

text - The text

Returns:

This EncoderOutput object for call chaining

addChunk

public EncoderOutput addChunk(java.lang.CharSequence text)

Add a new text chunk to the output of origin TextChunk.Origin.INPUT and content type "text/plain"

Parameters:

origin - The origin of the chunk

contentType - The content type of the chunk

text - The text

Returns:

This EncoderOutput object for call chaining

ignoreChunk

public EncoderOutput ignoreChunk()

Notifies that the encoder ignores the current text chunk, which will be kept unmodified. No further output should be placed after calling this method.

Returns:

This EncoderOutput object for call chaining

replaceChunk

public EncoderOutput replaceChunk(java.lang.String text)

Replaces text of the input chunk with the given chunk text, keeping the origin of the original chunk

Returns:

This EncoderOutput object for call chaining

clearChunks

public EncoderOutput clearChunks()

Removes all already added chunks

Returns:

This EncoderOutput object for call chaining

getOutputChunks

public java.util.List<TextChunk> getOutputChunks()

Returns the added chunks

chainEncoder

public EncoderOutput chainEncoder(WGAEncoder encoder)

Chains another encoder that should run after this encoder run finishes. The encoder will be given the output chunks of this encoder (or of a previously chained controller) and the same WGA object and flags for context. Unlimited encoders can be chained. A frequent use case is to divide up one encoder into multiple sub encoders, because it needs multiple passes on the input to work.

Parameters:

encoder - The encoder to chain

Returns:

This EncoderOutput object for call chaining

replaceChunkViaRegex

public EncoderOutput replaceChunkViaRegex(java.util.regex.Pattern pattern,
                                 java.lang.String replacement)

Replaces parts of the input chunk using a regular expression. The output are multiple chunks where the replaced parts have origin TextChunk.Origin.ADDED and the unmodified parts have origin TextChunk.Origin.INPUT

Parameters:

pattern - The regex pattern for replacement

replacement - The replacement string. This supports the group variables known from Matcher.appendReplacement(StringBuffer, String) on the state of Java SE 6, so the string "$0" will be replaced by the whole matched string, "$1" by the first matching group, "$2" the second and so on.

Returns:

This EncoderOutput object for call chaining