All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.cip4.jdflib.util.MultiModuleStatusCounter Maven / Gradle / Ivy

There is a newer version: 2.1.8.10
Show newest version
/*
 *
 * The CIP4 Software License, Version 1.0
 *
 *
 * Copyright (c) 2001-2024 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
 * .
 *  
 * 
 */
package org.cip4.jdflib.util;

import java.util.ArrayList;

import org.cip4.jdflib.auto.JDFAutoDeviceInfo.EnumDeviceStatus;
import org.cip4.jdflib.core.AttributeName;
import org.cip4.jdflib.core.ElementName;
import org.cip4.jdflib.core.JDFDoc;
import org.cip4.jdflib.core.KElement;
import org.cip4.jdflib.core.StringArray;
import org.cip4.jdflib.core.VElement;
import org.cip4.jdflib.jmf.JDFDeviceInfo;
import org.cip4.jdflib.jmf.JDFJMF;
import org.cip4.jdflib.jmf.JDFResponse;

/**
 * @author prosirai module combining statuscounter simply update the child status counters regularly. call getStatusResponse to generate a new Response based on the data in the
 *         statuscounters
 * 
 */
public class MultiModuleStatusCounter
{
	private final ArrayList counters = new ArrayList();
	private StatusCounter deviceCounter;

	/**
	 * 
	 */
	public MultiModuleStatusCounter()
	{
		this(null);
	}

	/**
	 * 
	 */
	public MultiModuleStatusCounter(final StatusCounter deviceCounter)
	{
		super();
		this.deviceCounter = deviceCounter;
	}

	/**
	 * add a statuscounter representing a set of modules or jobphases to this device status counter
	 * 
	 * @param sc the statuscounter to add
	 */
	public synchronized void addModule(final StatusCounter sc)
	{
		if (sc != null)
		{
			if (deviceCounter == null)
				deviceCounter = sc;
			else
				counters.add(sc);
		}
	}

	/**
	 * remove a statuscounter representing a set of modules to this device status counter
	 * 
	 * @param sc the statuscounter to add
	 */
	public synchronized void removeModule(final StatusCounter sc)
	{
		if (sc != null)
		{
			counters.remove(sc);
			if (counters.isEmpty())
			{
				deviceCounter.setActiveNode(null, null, null);
			}
		}
	}

	/**
	 * return the jmf root of the status jmf that contains all modules, null if no modules are active
	 * 
	 * @return
	 */
	public JDFDoc getStatusResponse()
	{
		if (counters.isEmpty() && deviceCounter == null)
			return null;

		final JDFDoc d = deviceCounter.getDocJMFPhaseTime().clone();
		final JDFJMF jmf = d.getJMFRoot();
		final int maxresp = getNumResponses();
		JDFResponse response = jmf.getResponse(0);
		for (int i = 0; i < maxresp; i++)
		{
			response = copyResponse(jmf, response, i);
		}
		return d;
	}

	synchronized JDFResponse copyResponse(final JDFJMF jmf, JDFResponse response, final int i)
	{
		if (i > 0)
		{
			response = copyResponse(jmf, response);
		}
		final JDFDeviceInfo di = response.getDeviceInfo(0);
		for (final StatusCounter counter : counters)
		{
			copyPhaseTime(i, di, counter);
		}
		return response;
	}

	void copyPhaseTime(final int i, final JDFDeviceInfo di, final StatusCounter counter)
	{
		final JDFDoc docJMFPhaseTime = counter.getDocJMFPhaseTime();
		if (docJMFPhaseTime != null)
		{
			final JDFJMF jmfRoot = docJMFPhaseTime.getJMFRoot();
			final int nResp = jmfRoot.numChildElements(ElementName.RESPONSE, null);
			if (nResp > 0)
			{
				final JDFDeviceInfo di2 = jmfRoot.getResponse(Math.min(i, nResp - 1)).getDeviceInfo(0);
				final VElement phases = di2.getChildElementVector(ElementName.JOBPHASE, null, null, true, -1, false);
				for (int j = 0; j < phases.size(); j++)
					di.copyElement(phases.elementAt(j), null);
				di.setDeviceStatus(getDeviceStatus());
				di.setStatusDetails(getStatusDetails());
				di.removeAttribute(AttributeName.IDLESTARTTIME);
			}
		}
	}

	JDFResponse copyResponse(final JDFJMF jmf, JDFResponse response)
	{
		final JDFResponse response2 = jmf.appendResponse();
		response2.setAttributes(response);
		final JDFDeviceInfo di2 = response2.appendDeviceInfo();
		di2.setAttributes(response.getDeviceInfo(0));
		response2.setID(KElement.uniqueID(0));
		response = response2;
		return response;
	}

	synchronized int getNumResponses()
	{
		int maxresp = 0;
		for (final StatusCounter counter : counters)
		{
			final JDFDoc docJMFPhaseTime = counter.getDocJMFPhaseTime();
			if (docJMFPhaseTime != null)
			{
				final JDFJMF jmfRoot = docJMFPhaseTime.getJMFRoot();
				final int nResp = jmfRoot.numChildElements(ElementName.RESPONSE, null);
				maxresp = Math.max(maxresp, nResp);
			}
		}
		return maxresp;
	}

	String getStatusDetails()
	{
		final StatusCounter maxModule = getMaxModule();
		return maxModule == null ? EnumDeviceStatus.Idle.getName() : maxModule.getStatusDetails();
	}

	public int size()
	{
		return counters.size();
	}

	/**
	 * @return the amalgamated device status
	 */
	public EnumDeviceStatus getDeviceStatus()
	{
		final StatusCounter maxModule = getMaxModule();
		return maxModule == null ? EnumDeviceStatus.Idle : maxModule.getStatus();
	}

	/**
	 * @return the amalgamated device status
	 */
	public synchronized StatusCounter getMaxModule()
	{
		EnumDeviceStatus maxStatus = EnumDeviceStatus.Idle;
		StatusCounter ret = deviceCounter;
		for (final StatusCounter counter : counters)
		{
			if (maxStatus.getValue() < EnumUtil.getValue(counter.getStatus()))
			{
				maxStatus = counter.getStatus();
				ret = counter;
			}
		}
		return ret;
	}

	public StatusCounter getDeviceCounter()
	{
		return deviceCounter;
	}

	@Override
	public String toString()
	{
		return "MultiModuleStatusCounter [counters=" + getJobIDS() + ", deviceCounter=" + deviceCounter.shortString() + "]";
	}

	public StringArray getJobIDS()
	{
		final StringArray b = new StringArray();
		for (final StatusCounter c : counters)
		{
			b.add(c.getJobID());
		}
		return b;
	}
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy