XmlTransformer.java

package gov.samhsa.acs.common.tool;

import gov.samhsa.acs.common.param.Params;

import java.util.Optional;

import javax.xml.transform.Source;
import javax.xml.transform.URIResolver;

import org.w3c.dom.Document;

/**
 * The Interface XmlTransformer.
 */
public interface XmlTransformer {

	/**
	 * Transform.
	 *
	 * @param xmlDocument
	 *            the xml document
	 * @param xslSource
	 *            the xsl source
	 * @param params
	 *            the params
	 * @param uriResolver
	 *            the uri resolver
	 * @return the string
	 */
	public abstract String transform(Document xmlDocument, Source xslSource,
			Optional<Params> params, Optional<URIResolver> uriResolver);

	/**
	 * Transform.
	 *
	 * @param xmlDocument
	 *            the xml document
	 * @param xslFileName
	 *            the xsl file name
	 * @param params
	 *            the params
	 * @param uriResolver
	 *            the uri resolver
	 * @return the string
	 */
	public abstract String transform(Document xmlDocument, String xslFileName,
			Optional<Params> params, Optional<URIResolver> uriResolver);

	/**
	 * Transform.
	 *
	 * @param obj
	 *            the obj
	 * @param xslFileName
	 *            the xsl file name
	 * @param params
	 *            the params
	 * @param uriResolver
	 *            the uri resolver
	 * @return the string
	 */
	public abstract String transform(Object obj, String xslFileName,
			Optional<Params> params, Optional<URIResolver> uriResolver);

	/**
	 * Transform.
	 *
	 * @param xmlSource
	 *            the xml source
	 * @param xslSource
	 *            the xsl source
	 * @param params
	 *            the params
	 * @param uriResolver
	 *            the uri resolver
	 * @return the string
	 */
	public abstract String transform(Source xmlSource, Source xslSource,
			Optional<Params> params, Optional<URIResolver> uriResolver);

	/**
	 * Transform.
	 *
	 * @param xml
	 *            the xml
	 * @param xslFileName
	 *            the xsl file name
	 * @param params
	 *            the params
	 * @param uriResolver
	 *            the uri resolver
	 * @return the string
	 */
	public abstract String transform(String xml, String xslFileName,
			Optional<Params> params, Optional<URIResolver> uriResolver);
}