org.cip4.jdflib.extensions.MessagePoolHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of JDFLibJ Show documentation
CIP4 JDF Library for JDF 1.x
There is a newer version: 2.1.8.10
/*
 * The CIP4 Software License, Version 1.0
 *
 *
 * Copyright (c) 2001-2023 The International Cooperation for the Integration of Processes in Prepress, Press and Postpress (CIP4). All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the
 * distribution.
 *
 * 3. The end-user documentation included with the redistribution, if any, must include the following acknowledgment: "This product includes software developed by the The International Cooperation for
 * the Integration of Processes in Prepress, Press and Postpress (www.cip4.org)" Alternately, this acknowledgment mrSubRefay appear in the software itself, if and wherever such third-party
 * acknowledgments normally appear.
 *
 * 4. The names "CIP4" and "The International Cooperation for the Integration of Processes in Prepress, Press and Postpress" must not be used to endorse or promote products derived from this software
 * without prior written permission. For written permission, please contact [email protected].
 *
 * 5. Products derived from this software may not be called "CIP4", nor may "CIP4" appear in their name, without prior writtenrestartProcesses() permission of the CIP4 organization
 *
 * Usage of this software in commercial products is subject to restrictions. For details please consult [email protected].
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE INTERNATIONAL COOPERATION FOR THE INTEGRATION OF PROCESSES IN PREPRESS, PRESS AND POSTPRESS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIrSubRefAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE. ====================================================================
 *
 * This software consists of voluntary contributions made by many individuals on behalf of the The International Cooperation for the Integration of Processes in Prepress, Press and Postpress and was
 * originally based on software restartProcesses() copyright (c) 1999-2001, Heidelberger Druckmaschinen AG copyright (c) 1999-2001, Agfa-Gevaert N.V.
 *
 * For more information on The International Cooperation for the Integration of Processes in Prepress, Press and Postpress , please see .
 *
 */
package org.cip4.jdflib.extensions;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import org.cip4.jdflib.core.ElementName;
import org.cip4.jdflib.core.JDFConstants;
import org.cip4.jdflib.core.KElement;
import org.cip4.jdflib.core.VElement;
import org.cip4.jdflib.util.ContainerUtil;
import org.cip4.jdflib.util.StringUtil;

/**
 * @author Rainer Prosi, Heidelberger Druckmaschinen *
 */
public class MessagePoolHelper extends BaseXJDFHelper
{

	/**
	 * @param pool
	 */
	public MessagePoolHelper(final KElement pool)
	{
		super(pool);
	}

	/**
	 *
	 * @param sh
	 * @return
	 */
	public MessageResourceHelper getMessageResourceHelper(final SetHelper sh)
	{
		final String name = sh == null ? null : sh.getName();
		if (name == null)
		{
			return null;
		}
		final VElement v = theElement.getXPathElementVector("*/ResourceInfo/ResourceSet[@Name=\"" + name + "\"]", 0);
		if (v != null)
		{
			for (final KElement e : v)
			{
				final SetHelper thisHelper = new SetHelper(e);
				if (sh.matches(thisHelper))
				{
					final KElement message = e.getParentNode_KElement().getParentNode_KElement();
					return newMessageResourceHelper(message);
				}
			}
		}
		return null;
	}

	/**
	 *
	 * @param message
	 * @return
	 */
	MessageResourceHelper newMessageResourceHelper(final KElement message)
	{
		return new MessageResourceHelper(message);
	}

	/**
	 *
	 * @param sh
	 * @return
	 */
	public MessageResourceHelper getCreateMessageResourceHelper(final SetHelper sh)
	{
		final String name = sh == null ? null : sh.getName();
		if (name == null)
		{
			return null;
		}
		MessageResourceHelper ah = getMessageResourceHelper(sh);
		if (ah == null)
		{
			ah = new MessageResourceHelper(theElement.appendElement(XJDFConstants.AuditResource));

			final KElement set = ah.getRoot().appendElement(ElementName.RESOURCEINFO).appendElement(XJDFConstants.ResourceSet);
			final SetHelper shNew = new SetHelper(set);
			shNew.setName(name);
			shNew.setUsage(sh.getUsage());
			shNew.setProcessUsage(sh.getProcessUsage());
		}
		ah.cleanUp();
		return ah;
	}

	/**
	 * @see org.cip4.jdflib.extensions.BaseXJDFHelper#cleanUp()
	 */
	@Override
	public void cleanUp()
	{
		final List vA = getMessageHelpers();
		if (vA != null)
		{
			for (final MessageHelper ah : vA)
			{
				ah.cleanUp();
			}
		}
		super.cleanUp();
	}

	/**
	 *
	 * @return
	 * @deprecated use getMessageHelpes
	 */
	@Deprecated
	public List getAuditHelpers()
	{
		return getMessageHelpers();
	}

	/**
	 *
	 * @return
	 */
	public List getMessageHelpers()
	{
		final ArrayList vA = new ArrayList<>();
		final VElement v = theElement.getChildElementVector(null, null);
		for (final KElement e : v)
		{
			if (!XJDFConstants.Header.equals(e.getLocalName()))
			{
				ContainerUtil.add(vA, getMessageHelper(e));
			}
		}
		return vA;
	}

	/**
	 *
	 * @param e
	 * @return
	 */
	public MessageHelper getMessageHelper(final KElement e)
	{
		if (e == null)
			return null;
		final String name = e.getLocalName();
		if (XJDFConstants.AuditResource.equals(name) || XJDFConstants.SignalResource.equals(name) || XJDFConstants.ResponseResource.equals(name))
			return newMessageResourceHelper(e);
		else if (name.startsWith(JDFConstants.AUDIT))
			return new AuditHelper(e);
		else
			return new MessageHelper(e);
	}

	public MessageHelper getMessageHelper(final String type, int i)
	{
		if (StringUtil.isEmpty(type))
			return getMessageHelper(i);
		else
		{
			final List messageHelpers = getMessageHelpers();
			if (i < 0)
			{
				Collections.reverse(messageHelpers);
				i = -1 - i;
			}
			for (final MessageHelper mh : messageHelpers)
			{
				if (type.equals(mh.getType()) && (i >= 0 && i-- == 0))
					return mh;
			}
		}
		return null;
	}

	/**
	 *
	 * @param e
	 * @return
	 */
	public MessageHelper getMessageHelper(int i)
	{
		final List v = getMessageHelpers();
		if (v == null)
			return null;
		if (i < 0)
			i = i + v.size();
		if (i < 0 || i >= v.size())
			return null;
		return v.get(i);
	}

	/**
	 *
	 * @param elementName
	 * @return
	 */
	public MessageHelper appendMessage(final String elementName)
	{
		if (StringUtil.isEmpty(elementName))
		{
			log.error("Cannot append null element");
			return null;
		}
		final KElement e = theElement.appendElement(elementName);
		final MessageHelper messageHelper = getMessageHelper(e);
		messageHelper.cleanUp();
		return messageHelper;
	}

	/**
	 *
	 * @param elementName
	 * @return
	 */
	public MessageHelper getCreateMessage(final String elementName, int skip)
	{
		MessageHelper messageHelper = getMessageHelper(elementName, skip);
		if (StringUtil.isEmpty(elementName) || messageHelper != null)
		{
			return messageHelper;
		}
		final KElement e = theElement.getCreateElement(elementName, null, skip);
		messageHelper = getMessageHelper(e);
		messageHelper.cleanUp();
		return messageHelper;
	}
}