com.itextpdf.tool.xml.pipeline.AbstractPipeline Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xmlworker Show documentation
Parses XML to PDF, with CSS support, using iText
There is a newer version: 5.5.13.4
/*
 *
 * This file is part of the iText (R) project.
    Copyright (c) 1998-2017 iText Group NV
 * Authors: Balder Van Camp, Emiel Ackermann, et al.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License version 3
 * as published by the Free Software Foundation with the addition of the
 * following permission added to Section 15 as permitted in Section 7(a):
 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
 * ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
 * OF THIRD PARTY RIGHTS
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Affero General Public License for more details.
 * You should have received a copy of the GNU Affero General Public License
 * along with this program; if not, see http://www.gnu.org/licenses or write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA, 02110-1301 USA, or download the license from the following URL:
 * http://itextpdf.com/terms-of-use/
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License,
 * a covered work must retain the producer line in every PDF that is created
 * or manipulated using iText.
 *
 * You can be released from the requirements of the license by purchasing
 * a commercial license. Buying such a license is mandatory as soon as you
 * develop commercial activities involving the iText software without
 * disclosing the source code of your own applications.
 * These activities include: offering paid services to customers as an ASP,
 * serving PDFs on the fly in a web application, shipping iText with a closed
 * source product.
 *
 * For more information, please contact iText Software Corp. at this
 * address: [email protected]
 */
package com.itextpdf.tool.xml.pipeline;

import com.itextpdf.tool.xml.CustomContext;
import com.itextpdf.tool.xml.NoCustomContextException;
import com.itextpdf.tool.xml.Pipeline;
import com.itextpdf.tool.xml.PipelineException;
import com.itextpdf.tool.xml.ProcessObject;
import com.itextpdf.tool.xml.Tag;
import com.itextpdf.tool.xml.WorkerContext;
import com.itextpdf.tool.xml.exceptions.LocaleMessages;

/**
 * Abstract class with default implementations. Override this instead of
 * implementing Pipeline and let your pipeline override only the methods
 * relevant to your implementation.
 *
 * @author redlab_b
 * @param  the type of CustomContext
 *
 */
public abstract class AbstractPipeline implements Pipeline {

	private Pipeline next;

	/**
	 * @param next the pipeline that's next in the sequence.
	 *
	 */
	public AbstractPipeline(final Pipeline next) {
		setNext(next);
	}

	/*
	 * (non-Javadoc)
	 *
	 * @see com.itextpdf.tool.xml.pipeline.Pipeline#getNext()
	 */
	public Pipeline getNext() {
		return next;
	}

	/**
	 * Just calls getNext.
Override this to get notified on encountered opening tags.
	 *
	 */
	public Pipeline open(final WorkerContext context, final Tag t, final ProcessObject po) throws PipelineException {
		return getNext();
	}

	/**
	 * Just calls getNext.
Override this to get notified on encountered content.
	 *
	 */
	public Pipeline content(final WorkerContext ctx, final Tag currentTag, final String text, final ProcessObject po) throws PipelineException {
		return getNext();
	}

	/**
	 * Just calls getNext.
Override this to get notified on encountered closing tags.
	 *
	 */
	public Pipeline close(final WorkerContext context, final Tag t, final ProcessObject po) throws PipelineException {
		return getNext();
	}

	/**
	 * Returns the local context for this class using getContextKey, override
	 * this together with getContextKey to change the key usage in case you want
	 * to add multiple identical pipelines to the worker.
	 *
	 * @param context the WorkerContext
	 * @return the local context for this class using
	 *         {@link AbstractPipeline#getContextKey()}
	 * @throws PipelineException thrown when there is no {@link CustomContext} or the CustomContext is null.
	 */
	@SuppressWarnings("unchecked")
	public T getLocalContext(final WorkerContext context) throws PipelineException {
		try {
			CustomContext cc = context.get(getContextKey());
			if (null != cc) {
				return (T) cc;
			}
			throw new PipelineException(String.format(LocaleMessages.getInstance().getMessage(LocaleMessages.OWN_CONTEXT_404), this.getClass().getName()));
		} catch (NoCustomContextException e) {
			throw new PipelineException(String.format(LocaleMessages.getInstance().getMessage(LocaleMessages.OWN_CONTEXT_404), this.getClass().getName()), e);
		}
	}
	/**
	 * setNext method. When using this while parsing one can make live
	 * changes the pipeline structure. Use with caution.
	 *
	 * @param next set the next pipeline
	 */
	public void setNext(final Pipeline next) {
		this.next = next;
	}

	/**
	 * Defaults to the fully qualified class name of the object.
	 * @return getClass().getName() as name.
	 */
	public String getContextKey() {
		return this.getClass().getName();
	}

	/* (non-Javadoc)
	 * @see com.itextpdf.tool.xml.Pipeline#init(com.itextpdf.tool.xml.WorkerContext)
	 */
	public Pipeline init(final WorkerContext context) throws PipelineException {
		return getNext();
	}
}