org.daisy.pipeline.braille.common.XMLTransform Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of braille-common Show documentation

There is a newer version: 5.0.2

package org.daisy.pipeline.braille.common;

import java.util.Map;

import javax.xml.namespace.QName;

import org.daisy.common.transform.InputValue;
import org.daisy.common.transform.StringWithNamespaceContext;
import org.daisy.common.transform.XMLInputValue;
import org.daisy.common.transform.XMLOutputValue;
import org.daisy.common.transform.XMLTransformer;

public interface XMLTransform extends Transform {

	/**
	 * Should return a transformer with:
	 * 
	 *   a "source" input port that accepts a sequence of XML documents ({@link
	 *     XMLInputValue})
	 *   a "parameter" input port that accepts a map of parameter name/value pairs ({@link
	 *     InputValue}{@code <}{@link Map}{@code <}{@link QName}{@code ,}{@link
	 *     StringWithNamespaceContext}{@code >>})
	 *   a "result" output port that returns a sequence of XML documents ({@link
	 *     XMLOutputValue})
	 * 
	 */
	public XMLTransformer fromXmlToXml();

}