org.cip4.jdflib.jmf.JDFJobPhase 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-2025 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 may 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 written 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 CONSEQUENTIAL 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 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 .
 *
 *
 */
/**
 * ========================================================================== class JDFJobPhase extends JDFResource ==========================================================================
 *
 * @COPYRIGHT Heidelberger Druckmaschinen AG, 1999-2001 ALL RIGHTS RESERVED Warning! very preliminary test version. Interface subject to change without prior notice! Revision history: ...
 **/

package org.cip4.jdflib.jmf;

import org.apache.xerces.dom.CoreDocumentImpl;
import org.cip4.jdflib.auto.JDFAutoJobPhase;
import org.cip4.jdflib.auto.JDFAutoQueueEntry.EnumQueueEntryStatus;
import org.cip4.jdflib.core.AttributeName;
import org.cip4.jdflib.core.ElemInfoTable;
import org.cip4.jdflib.core.ElementInfo;
import org.cip4.jdflib.core.ElementName;
import org.cip4.jdflib.core.KElement;
import org.cip4.jdflib.core.VElement;
import org.cip4.jdflib.core.VString;
import org.cip4.jdflib.datatypes.JDFAttributeMap;
import org.cip4.jdflib.datatypes.JDFAttributeMapArray;
import org.cip4.jdflib.datatypes.VJDFAttributeMap;
import org.cip4.jdflib.ifaces.INodeIdentifiable;
import org.cip4.jdflib.jmf.JDFMessage.EnumType;
import org.cip4.jdflib.node.JDFNode;
import org.cip4.jdflib.node.JDFNode.EnumActivation;
import org.cip4.jdflib.node.NodeIdentifier;
import org.cip4.jdflib.resource.JDFModulePhase;
import org.cip4.jdflib.resource.JDFModuleStatus;
import org.cip4.jdflib.util.ContainerUtil;
import org.cip4.jdflib.util.JDFDate;
import org.cip4.jdflib.util.StringUtil;

// ----------------------------------
/**
 * describes the actual status of jobs in a device
 *
 * Note that the old EnumStatus local class has been move to @see JDFNode.EnumNodeStatus
 */
public class JDFJobPhase extends JDFAutoJobPhase implements INodeIdentifiable
{
	private static final long serialVersionUID = 1L;

	/**
	 * Constructor for JDFJobPhase
	 *
	 * @param myOwnerDocument
	 * @param qualifiedName
	 */
	public JDFJobPhase(final CoreDocumentImpl myOwnerDocument, final String qualifiedName)
	{
		super(myOwnerDocument, qualifiedName);
	}

	/**
	 * Constructor for JDFJobPhase
	 *
	 * @param myOwnerDocument
	 * @param myNamespaceURI
	 * @param qualifiedName
	 */
	public JDFJobPhase(final CoreDocumentImpl myOwnerDocument, final String myNamespaceURI, final String qualifiedName)
	{
		super(myOwnerDocument, myNamespaceURI, qualifiedName);
	}

	/**
	 * Constructor for JDFJobPhase
	 *
	 * @param myOwnerDocument
	 * @param myNamespaceURI
	 * @param qualifiedName
	 * @param myLocalName
	 */
	public JDFJobPhase(final CoreDocumentImpl myOwnerDocument, final String myNamespaceURI, final String qualifiedName, final String myLocalName)
	{
		super(myOwnerDocument, myNamespaceURI, qualifiedName, myLocalName);
	}

	/**
	 * toString()
	 *
	 * @see org.cip4.jdflib.auto.JDFAutoJobPhase#toString()
	 * @return String
	 */
	@Override
	public String toString()
	{
		return "JDFJobPhase[  --> " + super.toString() + " ]";
	}

	private static ElemInfoTable[] elemInfoTable = new ElemInfoTable[1];
	static
	{
		elemInfoTable[0] = new ElemInfoTable(ElementName.JDF, 0x33333333);
	}

	@Override
	protected ElementInfo getTheElementInfo()
	{
		return new ElementInfo(super.getTheElementInfo(), elemInfoTable);
	}

	/**
	 * Returns detailed status information.
	 *
	 * @return String
	 */
	@Override
	public String getStatusDetails()
	{
		return getAttribute(AttributeName.STATUSDETAILS);
	}

	/**
	 * Method getQueueEntryID.
	 *
	 * @return String
	 */
	@Override
	public String getQueueEntryID()
	{
		return getInheritedStatusQuParamsAttribute(AttributeName.QUEUEENTRYID, null);
	}

	/**
	 * Method getJobID.
	 *
	 * @return String
	 */
	@Override
	public String getJobID()
	{
		return getInheritedStatusQuParamsAttribute(AttributeName.JOBID, null);
	}

	/**
	 * Method getJobID.
	 *
	 * @return String
	 */
	@Override
	public String getJobPartID()
	{
		return getInheritedStatusQuParamsAttribute(AttributeName.JOBPARTID, null);
	}

	/**
	 * get part map vector
	 *
	 * @return VJDFAttributeMap: vector of attribute maps, one for each part
	 */
	@Override
	public VJDFAttributeMap getPartMapVector()
	{
		return super.getPartMapVector();
	}

	/**
	 * get part map array
	 *
	 * @return array of attribute, one for each part
	 */
	@Override
	public JDFAttributeMapArray getPartMapArray()
	{
		return super.getPartMapArray();
	}

	/**
	 * set part to the one defined in mPart
	 *
	 * @param m attribute map for the part to set
	 */
	@Override
	public void setPartMap(final JDFAttributeMap m)
	{
		super.setPartMap(m);
	}

	/**
	 * remove the part defined in mPart
	 *
	 * @param mP attribute map for the part to remove
	 */
	@Override
	public void removePartMap(final JDFAttributeMap mP)
	{
		super.removePartMap(mP);
	}

	/**
	 * set all parts to those defined in vParts
	 *
	 * @param vP vector of attribute maps for the parts
	 */
	@Override
	public void setPartMapVector(final VJDFAttributeMap vP)
	{
		super.setPartMapVector(vP);
	}

	/**
	 * check whether the part defined in mPart is included
	 *
	 * @param mPart attribute map for the part to remove
	 * @return boolean - returns true if the part exists
	 */
	@Override
	public boolean hasPartMap(final JDFAttributeMap mPart)
	{
		return super.hasPartMap(mPart);
	}

	/**
	 * get a node, create if it doesn't exist
	 *
	 * @return the node
	 */
	public JDFNode getCreateNode()
	{
		return (JDFNode) getCreateElement_KElement(ElementName.JDF, null, 0);
	}

	/**
	 * append a node
	 *
	 * @return the appended node
	 */
	public JDFNode appendNode()
	{
		return (JDFNode) appendElementN(ElementName.JDF, 1, null);
	}

	/**
	 * apply all values of a JDF Node to this
	 *
	 * @param node the node to apply
	 */
	public void applyNode(final JDFNode node)
	{
		final NodeIdentifier ni = node == null ? new NodeIdentifier() : node.getIdentifier();

		setIdentifier(ni);
		if (node != null)
		{
			final JDFNode.EnumActivation activation = node.getActivation(true);
			if (activation != null)
			{
				setActivation(EnumActivation.getEnum(activation.getName()));
			}
			final VJDFAttributeMap vMap = ni.getPartMapVector();
			setStatus(node.getVectorPartStatus(vMap));
			setStatusDetails(node.getVectorPartStatusDetails(vMap));
		}
	}

	/**
	 * get node
	 *
	 * @return the node
	 */
	public JDFNode getNode()
	{
		return (JDFNode) getElement(ElementName.JDF, null, 0);
	}

	/**
	 * get the {@link JDFStatusQuParams} that apply to the jobphase
	 *
	 * @return
	 */
	public JDFStatusQuParams getStatusQuParams()
	{
		KElement parent = getParentNode_KElement();
		if (!(parent instanceof JDFDeviceInfo))
		{
			return null;
		}
		parent = parent.getParentNode_KElement();
		if (!(parent instanceof JDFSignal) || !EnumType.Status.equals(((JDFMessage) parent).getEnumType()))
		{
			return null;
		}
		return ((JDFMessage) parent).getStatusQuParams();

	}

	/**
	 * gets the NodeIdetifier that matches this
	 *
	 * @return
	 */
	@Override
	public NodeIdentifier getIdentifier()
	{
		final NodeIdentifier ni = new NodeIdentifier();
		ni.setTo(getJobID(), getJobPartID(), getPartMapVector());
		return ni;
	}

	/**
	 * @see org.cip4.jdflib.ifaces.INodeIdentifiable#setIdentifier(org.cip4.jdflib.node.NodeIdentifier)
	 * @param ni
	 */
	@Override
	public void setIdentifier(NodeIdentifier ni)
	{
		if (ni == null)
		{
			ni = new NodeIdentifier();
		}

		setJobID(ni.getJobID());
		setJobPartID(ni.getJobPartID());
		setPartMapVector(ni.getPartMapVector());
	}

	private String getInheritedStatusQuParamsAttribute(final String key, final String nameSpaceURI)
	{
		final String val = getAttribute(key, nameSpaceURI, null);
		if (val != null)
		{
			return val;
		}
		final JDFStatusQuParams sqp = getStatusQuParams();
		if (sqp == null)
		{
			return null;
		}
		return sqp.getAttribute(key, nameSpaceURI, null);
	}

	/**
	 * creates a new ModuleStatus in this based on the values in mp generally used to create messages from audits
	 *
	 * @param mp the modulephase to copy
	 * @return the new ModuleStatus element
	 *
	 */
	public JDFModuleStatus createModuleStatusFromModulePhase(final JDFModulePhase mp)
	{
		if (mp == null)
		{
			return null;
		}
		final JDFModuleStatus ms = appendModuleStatus();
		ms.copyAttribute(AttributeName.MODULETYPE, mp);
		ms.copyAttribute(AttributeName.MODULEINDEX, mp);
		ms.copyAttribute(AttributeName.MODULEID, mp);

		return ms;
	}

	/**
	 * return the differential amount produced between this phase and lastphase
	 *
	 * @param lastphase the phase
	 * @return
	 */
	public double getAmountDifference(final JDFJobPhase lastphase)
	{
		if (isSamePhase(lastphase, true))
		{
			return getPhaseAmount() - lastphase.getPhaseAmount();
		}
		return getPhaseAmount();
	}

	/**
	 * return the differential waste amount produced between this phase and lastphase
	 *
	 * @param lastphase
	 * @return
	 */
	public double getWasteDifference(final JDFJobPhase lastphase)
	{
		if (isSamePhase(lastphase, true))
		{
			return getPhaseWaste() - lastphase.getPhaseWaste();
		}
		return getPhaseWaste();
	}

	/**
	 * returns true if this is the same phase, i.e. the
	 *
	 * @param lastphase the phase to compare with
	 * @param bExact if true, use startTime as hook, else compare stati
	 * @return
	 */
	public boolean isSamePhase(final JDFJobPhase lastphase, final boolean bExact)
	{
		if (lastphase == null)
		{
			return false;
		}
		if (bExact)
		{
			final JDFDate startTime = getPhaseStartTime();
			final JDFDate lastStartTime = lastphase.getPhaseStartTime();
			return startTime != null && startTime.equals(lastStartTime);
		}
		if (!ContainerUtil.equals(getStatus(), lastphase.getStatus()))
		{
			return false;
		}
		if (!ContainerUtil.equals(StringUtil.getNonEmpty(getStatusDetails()), StringUtil.getNonEmpty(lastphase.getStatusDetails())))
		{
			return false;
		}
		if (!ContainerUtil.equals(StringUtil.getNonEmpty(getDescriptiveName()), StringUtil.getNonEmpty(lastphase.getDescriptiveName())))
		{
			return false;
		}
		if (!ContainerUtil.equals(getIdentifier(), lastphase.getIdentifier()))
		{
			return false;
		}
		if (!ContainerUtil.matches(getCostCenter(), lastphase.getCostCenter()))
		{
			return false;
		}
		if (!ContainerUtil.equals(getPartMapVector(), lastphase.getPartMapVector()))
		{
			return false;
		}
		if (!ContainerUtil.equals(getMISDetails(), lastphase.getMISDetails()))
		{
			return false;
		}
		final VString ignore = new VString(new String[] { ElementName.PART, ElementName.MISDETAILS, ElementName.COSTCENTER });
		final VElement childrenIgnoreList = getChildrenIgnoreList(ignore, true, null);
		final VElement lastchildrenIgnoreList = lastphase.getChildrenIgnoreList(ignore, true, null);
		if (childrenIgnoreList.size() > 0 || lastchildrenIgnoreList.size() > 0)
		{
			if (childrenIgnoreList.size() != lastchildrenIgnoreList.size())
			{
				return false;
			}
			else
			{
				for (int i = 0; i < childrenIgnoreList.size(); i++)
				{
					if (!childrenIgnoreList.get(i).isEqual(lastchildrenIgnoreList.get(i)))
					{
						return false;
					}
				}
			}
		}
		return true;
	}

	/**
	 * creates a new phasetime that spans lastphase and this phase

	 * assume that amounts are correctly handled id starttimes are identical
	 *
	 * @param lastphase the phase to merge
	 * @return true if successful
	 */
	public boolean mergeLastPhase(final JDFJobPhase lastphase)
	{
		if (!isSamePhase(lastphase, false))
		{
			return false;
		}
		final JDFDate startTime = lastphase.getPhaseStartTime();
		if (!ContainerUtil.equals(getPhaseStartTime(), startTime))
		{
			setPhaseStartTime(startTime);
			final double amount = getPhaseAmount() + lastphase.getPhaseAmount();
			if (amount != 0)
			{
				setPhaseAmount(amount);
			}
			final double waste = getPhaseWaste() + lastphase.getPhaseWaste();
			if (waste != 0)
			{
				setPhaseWaste(waste);
			}
		}
		return true;
	}

	/**
	 * returns the phase amount, defaults to amount if not specified
	 */
	@Override
	public double getPhaseAmount()
	{
		if (hasAttribute(AttributeName.PHASEAMOUNT))
		{
			return super.getPhaseAmount();
		}
		return super.getAmount();
	}

	/**
	 * returns the phase starttime, defaults to starttime if not specified
	 */
	@Override
	public JDFDate getPhaseStartTime()
	{
		if (hasAttribute(AttributeName.PHASESTARTTIME))
		{
			return super.getPhaseStartTime();
		}
		return super.getStartTime();
	}

	/**
	 * returns the phase waste amount, defaults to waste if not specified
	 */
	@Override
	public double getPhaseWaste()
	{
		if (hasAttribute(AttributeName.PHASEWASTE))
		{
			return super.getPhaseWaste();
		}
		return super.getWaste();
	}

	/**
	 * @return the queueentry status that corresponds to the status of this
	 */
	public EnumQueueEntryStatus getQueueEntryStatus()
	{
		return EnumNodeStatus.getQueueEntryStatus(getStatus());
	}

	/**
	 * also checks parent deviceinfo if empty
	 *
	 * @see org.cip4.jdflib.auto.JDFAutoJobPhase#getSpeed()
	 */
	@Override
	public double getSpeed()
	{
		final String speed = getNonEmpty(AttributeName.SPEED);
		if (speed == null)
		{
			final KElement parent = getParentNode_KElement();
			if (parent instanceof JDFDeviceInfo)
			{
				return ((JDFDeviceInfo) parent).getSpeed();
			}
			else
			{
				return 0.0;
			}
		}
		else
		{
			return super.getSpeed();
		}
	}

	@Override
	public void setPercentCompleted(double value)
	{
		if (value < 0)
			throw new IllegalArgumentException("Invalid PercentCompleted (0-100); " + value);
		else if (value > 100)
			value = 100;
		super.setPercentCompleted(value);
	}
}