de.innovationgate.wgpublisher.encoders

Interface WGAEncoder

All Known Subinterfaces:

WGAInputOnlyEncoder

All Known Implementing Classes:

EncodingFormatterEncoder

public interface WGAEncoder

Encoder used to transform a text chunk, used either via attribute "encode" in WebTML or via method WGA.encode() in TMLScript or on the WGA Server API. Please consider using WGAInputOnlyEncoder if you only want to transform text chunks of origin INPUT (as is mostly the case). The same encoder instance is used for encoding all incoming text chunks of an input to be encoded, so the instance may keep state between those invocations.

Method Summary

Methods

Modifier and Type	Method and Description
void	encode(WGA wga, TextChunk input, EncoderOutput output, java.util.Map<java.lang.String,java.lang.String> flags) Encodes a text chunk, using the given EncoderOutput object to place the result.

Method Detail

encode

void encode(WGA wga,
          TextChunk input,
          EncoderOutput output,
          java.util.Map<java.lang.String,java.lang.String> flags)
            throws de.innovationgate.webgate.api.WGException

Encodes a text chunk, using the given EncoderOutput object to place the result. The method should do one of the following things:

• Call EncoderOutput.ignoreChunk() if it is not interested in this chunk. The chunk will be kept unmodified
• Call EncoderOutput.replaceChunk(String) if it wants to replace this chunk with another text chunk completely
• Call EncoderOutput.addChunk(CharSequence) an arbitrary number of times if it wants to break up the input chunk into multiple output chunks. In many cases this can also be done conveniently using EncoderOutput.replaceChunkViaRegex(java.util.regex.Pattern, String) using a regular expression.

If the method exits without placing any output on the EncoderOutput object then the input chunk will be swallowed and not put out.

Parameters:

wga - WGA context object

input - The input chunk

output - Object to place encoding output

flags - Flags given to the encoder and their values. Flags given without a value have the value "true" here.

Throws:

de.innovationgate.webgate.api.WGException