org.cip4.jdflib.jmf.JDFQueueEntry Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of JDFLibJ Show documentation
Show all versions of JDFLibJ Show documentation
CIP4 JDF Library for JDF 1.x
/*
*
* 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
* , INodeIdentifiable
{
/**
* @author Dr. Rainer Prosi, Heidelberger Druckmaschinen AG
*
* Apr 29, 2009
*/
public static class QueueEntryComparator implements Comparator
{
/**
* getEnum is too slow for heavily repetitive calls
*/
public QueueEntryComparator()
{
super();
if (fastStat == null)
{
final HashMap fastStat2 = new HashMap();
final Iterator it = EnumQueueEntryStatus.iterator();
while (it.hasNext())
{
final EnumQueueEntryStatus eqs = it.next();
fastStat2.put(eqs.getName(), new MyInteger(eqs.getValue()));
}
fastStat = fastStat2;
}
}
private static HashMap fastStat = null;
/**
* @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
* @param o1
* @param o2
* @return
*/
@Override
public int compare(final KElement o1, final KElement o2)
{
if (o1 == null)
{
return -1;
}
if (o2 == null)
{
return 1;
}
final int i = o1.getNodeName().compareTo(o2.getNodeName());
if (i != 0)
{
return i;
}
if ((o1 instanceof JDFQueueEntry) && (o2 instanceof JDFQueueEntry))
{
final JDFQueueEntry q1 = (JDFQueueEntry) o1;
final JDFQueueEntry q2 = (JDFQueueEntry) o2;
final MyInteger m1 = fastStat.get(q1.getAttribute(AttributeName.STATUS, null, null));
final MyInteger m2 = fastStat.get(q2.getAttribute(AttributeName.STATUS, null, null));
int s1 = (m1 == null) ? 0 : m1.i;
int s2 = (m2 == null) ? 0 : m2.i;
if (s1 != s2)
{
return s1 - s2;
}
if (q1.isCompleted())
{
final String d1 = q1.getAttribute(AttributeName.ENDTIME, null, null);
final String d2 = q2.getAttribute(AttributeName.ENDTIME, null, null);
final int d = ContainerUtil.compare(d2, d1);
if (d != 0)
{
return d;
}
}
else
{
s1 = q1.getPriority();
s2 = q2.getPriority();
if (s1 != s2)
{
return s2 - s1;
}
}
String d1 = q1.getAttribute(AttributeName.STARTTIME, null, "999999");
String d2 = q2.getAttribute(AttributeName.STARTTIME, null, "999999");
int d = ContainerUtil.compare(d1, d2);
if (d != 0)
{
return d;
}
d1 = q1.getAttribute(AttributeName.SUBMISSIONTIME, null, null);
d2 = q2.getAttribute(AttributeName.SUBMISSIONTIME, null, null);
d = ContainerUtil.compare(d1, d2);
if (d != 0)
{
return d;
}
d1 = q1.getAttribute(AttributeName.QUEUEENTRYID, null, null);
d2 = q2.getAttribute(AttributeName.QUEUEENTRYID, null, null);
d = ContainerUtil.compare(d1, d2);
if (d != 0)
{
return d;
}
return new SimpleNodeComparator().compare(q1, q2);
}
return 0;
}
}
private static final long serialVersionUID = 1L;
/**
* Constructor for JDFQueueEntry
*
* @param myOwnerDocument
* @param qualifiedName
*/
public JDFQueueEntry(final CoreDocumentImpl myOwnerDocument, final String qualifiedName)
{
super(myOwnerDocument, qualifiedName);
}
/**
* Constructor for JDFQueueEntry
*
* @param myOwnerDocument
* @param myNamespaceURI
* @param qualifiedName
*/
public JDFQueueEntry(final CoreDocumentImpl myOwnerDocument, final String myNamespaceURI, final String qualifiedName)
{
super(myOwnerDocument, myNamespaceURI, qualifiedName);
}
/**
* Constructor for JDFQueueEntry
*
* @param myOwnerDocument
* @param myNamespaceURI
* @param qualifiedName
* @param myLocalName
*/
public JDFQueueEntry(final CoreDocumentImpl myOwnerDocument, final String myNamespaceURI, final String qualifiedName, final String myLocalName)
{
super(myOwnerDocument, myNamespaceURI, qualifiedName, myLocalName);
}
/**
* toString()
*
* @return String
*/
@Override
public String toString()
{
return "JDFQueueEntry[ --> " + super.toString() + " ]";
}
/**
* get part map vector
*
* @return VJDFAttributeMap: vector of attribute maps, one for each part
*/
@Override
public VJDFAttributeMap getPartMapVector()
{
return super.getPartMapVector();
}
/**
* set all parts to those define in vParts
*
* @param vParts vector of attribute maps for the parts
*/
@Override
public void setPartMapVector(final VJDFAttributeMap vParts)
{
super.setPartMapVector(vParts);
}
/**
* set all parts to those defined by mPart
*
* @param mPart attribute map for the part to set
*/
@Override
public void setPartMap(final JDFAttributeMap mPart)
{
super.setPartMap(mPart);
}
/**
* remove the part defined in mPart
*
* @param mPart attribute map for the part to remove
*/
@Override
public void removePartMap(final JDFAttributeMap mPart)
{
super.removePartMap(mPart);
}
/**
* return true if this qe matches the input node identifier
*
* @param ni
* @return
*/
public boolean matchesNodeIdentifier(final NodeIdentifier ni)
{
if (ni == null)
{
return false;
}
final NodeIdentifier niThis = getIdentifier();
return niThis.matches(ni);
}
/**
* return true if this qe matches the input QueueFilter
*
* @param filter
* @return
* @deprecated use QueueFilter.matches
*/
@Deprecated
public boolean matchesQueueFilter(final JDFQueueFilter filter)
{
if (filter == null)
{
return true;
}
return filter.matches(this);
}
/**
* check whether the part defined by mPart is included
*
* @param mPart attribute map to look for
* @return boolean - returns true if the part exists
*/
@Override
public boolean hasPartMap(final JDFAttributeMap mPart)
{
return super.hasPartMap(mPart);
}
/**
* @see org.cip4.jdflib.auto.JDFAutoQueueEntry#setPriority(int)
* @param value
*/
@Override
public void setPriority(final int value)
{
final int oldVal = hasAttribute(AttributeName.PRIORITY) ? getPriority() : -1;
if (isAutomated() && value != oldVal)
{
final JDFQueue queue = (JDFQueue) getParentNode_KElement();
synchronized (queue)
{
super.setPriority(value);
queue.sortChild(this);
}
}
else if (value != oldVal) // non automated
{
super.setPriority(value);
}
}
/**
* sort this into the queue based on current values assumes presorted queue
*
* @param oldVal - the previous sort value, use -1 to sort from back
* @deprecated call JDFQueue.sortChildren()
*/
@Deprecated
public void sortQueue(final int oldVal)
{
final JDFQueue queue = (JDFQueue) getParentNode_KElement();
queue.sortChildren();
}
/**
* @return true if the parent queue is automated
*/
private boolean isAutomated()
{
final KElement e = getParentNode_KElement();
if (e instanceof JDFQueue)
{
return ((JDFQueue) e).isAutomated();
}
return false;
}
/**
* sets the QueueEntry/@Status if the queue is automated, also resorts the queue to reflect the new Status and sets the Queue/@Status based on the maximum number of
* concurrently running jobs also sets StartTime and EndTime appropriately if the queue is automated
*
* @param value the queuentry status to set
*
* @see org.cip4.jdflib.auto.JDFAutoQueueEntry#setQueueEntryStatus(org.cip4.jdflib.auto.JDFAutoQueueEntry.EnumQueueEntryStatus)
*/
@Override
public void setQueueEntryStatus(final EnumQueueEntryStatus value)
{
final EnumQueueEntryStatus oldVal = getQueueEntryStatus();
if (isAutomated() && !ContainerUtil.equals(oldVal, value))
{
final JDFQueue queue = (JDFQueue) getParentNode_KElement();
synchronized (queue)
{
super.setQueueEntryStatus(value);
if (isCompleted())
{
if (!hasAttribute(AttributeName.ENDTIME))
{
super.setEndTime(new JDFDate());
}
queue.cleanup();
}
else if (EnumQueueEntryStatus.Running.equals(value))
{
if (!hasAttribute(AttributeName.STARTTIME))
{
super.setStartTime(new JDFDate());
}
removeAttribute(AttributeName.ENDTIME);
}
else if (EnumQueueEntryStatus.Suspended.equals(value))
{
if (!hasAttribute(AttributeName.ENDTIME))
{
super.setEndTime(new JDFDate());
}
}
// in case cleanup removed this from queue, we don't want to reintroduce it through sorting
if (!EnumQueueEntryStatus.Removed.equals(value) && queue.equals(getParentNode_KElement()))
{
queue.sortChild(this);
}
queue.setStatusFromEntries();
}
}
else if (!ContainerUtil.equals(oldVal, value)) // non automated
{
super.setQueueEntryStatus(value);
}
}
/**
* gets the NodeIdetifier that matches this
*
* @return
*/
@Override
public NodeIdentifier getIdentifier()
{
final NodeIdentifier ni = new NodeIdentifier();
ni.setTo(getJobID(), getJobPartID(), getPartMapVector());
return ni;
}
/**
* gets the NodeIdentifier that matches this
*
* @param ni
*
*
*/
@Override
public void setIdentifier(final NodeIdentifier ni)
{
if (ni == null)
{
return;
}
setPartMapVector(ni.getPartMapVector());
setJobID(ni.getJobID());
setJobPartID(ni.getJobPartID());
}
/**
* get the next sibling queueentry
*
* @return
*/
public JDFQueueEntry getNextQueueEntry()
{
return getNextSiblingElement(JDFQueueEntry.class);
}
/**
* get the previous sibling queueentry
*
* @return
*/
public JDFQueueEntry getPreviousQueueEntry()
{
return (JDFQueueEntry) getPreviousSiblingElement(ElementName.QUEUEENTRY, null);
}
/**
* get the vector of valid next @Status values for this queue entry based on the current status based on the table of valid queue entry transitions
*
* @return Vector the vector of valid new stati
*/
@SuppressWarnings("unchecked")
public Vector getNextStatusVector()
{
final Vector v = new Vector();
final EnumQueueEntryStatus qesThis = getQueueEntryStatus();
if (qesThis == null)
{
final Iterator it = EnumQueueEntryStatus.iterator();
while (it.hasNext())
{
v.add(it.next());
}
}
else if (EnumQueueEntryStatus.Running.equals(qesThis))
{
v.add(EnumQueueEntryStatus.Running);
v.add(EnumQueueEntryStatus.Suspended);
v.add(EnumQueueEntryStatus.PendingReturn);
v.add(EnumQueueEntryStatus.Completed);
v.add(EnumQueueEntryStatus.Aborted);
}
else if (EnumQueueEntryStatus.Waiting.equals(qesThis))
{
v.add(EnumQueueEntryStatus.Running);
v.add(EnumQueueEntryStatus.Waiting);
v.add(EnumQueueEntryStatus.Held);
v.add(EnumQueueEntryStatus.Removed);
v.add(EnumQueueEntryStatus.PendingReturn);
v.add(EnumQueueEntryStatus.Aborted);
}
else if (EnumQueueEntryStatus.Held.equals(qesThis))
{
v.add(EnumQueueEntryStatus.Waiting);
v.add(EnumQueueEntryStatus.Held);
v.add(EnumQueueEntryStatus.Removed);
v.add(EnumQueueEntryStatus.PendingReturn);
v.add(EnumQueueEntryStatus.Aborted);
}
else if (EnumQueueEntryStatus.Removed.equals(qesThis))
{
v.add(EnumQueueEntryStatus.Removed);
}
else if (EnumQueueEntryStatus.Suspended.equals(qesThis))
{
v.add(EnumQueueEntryStatus.Waiting);
v.add(EnumQueueEntryStatus.Running);
v.add(EnumQueueEntryStatus.Suspended);
v.add(EnumQueueEntryStatus.Completed);
v.add(EnumQueueEntryStatus.Aborted);
}
else if (EnumQueueEntryStatus.PendingReturn.equals(qesThis))
{
v.add(EnumQueueEntryStatus.PendingReturn);
v.add(EnumQueueEntryStatus.Completed);
v.add(EnumQueueEntryStatus.Aborted);
}
else if (EnumQueueEntryStatus.Completed.equals(qesThis))
{
v.add(EnumQueueEntryStatus.Waiting);
v.add(EnumQueueEntryStatus.Removed);
v.add(EnumQueueEntryStatus.PendingReturn);
v.add(EnumQueueEntryStatus.Completed);
v.add(EnumQueueEntryStatus.Aborted);
}
else if (EnumQueueEntryStatus.Aborted.equals(qesThis))
{
v.add(EnumQueueEntryStatus.Waiting);
v.add(EnumQueueEntryStatus.Removed);
v.add(EnumQueueEntryStatus.PendingReturn);
v.add(EnumQueueEntryStatus.Aborted);
}
return v;
}
/**
* @return true if this entry is completed
* @since 110420 removed suspended from the list as suspended is NOT a completed end state
*/
public boolean isCompleted()
{
final String status = getAttribute(AttributeName.STATUS, null, null);
return "Completed".equals(status) || "Removed".equals(status) || "Aborted".equals(status);
}
/**
* return a value based on QueueEntryStatus and Priority to sort the queue
*
* @return int a priority for sorting - low = back
*/
@Deprecated
public int getSortPriority()
{
return getSortPriority(getQueueEntryStatus(), getPriority());
}
/**
* return a value based on QueueEntryStatus and Priority to sort the queue the status is the major order whereas the priority is used to order within regions of identical
* status
*
* @param status
* @param priority
*
* @return int a priority for sorting - low value = back of queue, high value = front of queue
*/
@Deprecated
public static int getSortPriority(final EnumQueueEntryStatus status, final int priority)
{
int sort = (status == null) ? 0 : 10000 - 1000 * status.getValue();
sort += priority;
return sort;
}
/**
* populates this queuentry with the relevant parameters extracted from a JDF jobid, partmap, jobpartid etc.
*
* @param jdf
*/
public void setFromJDF(final JDFNode jdf)
{
if (jdf == null)
{
return;
}
setJobID(jdf.getJobID(true));
setJobPartID(jdf.getJobPartID(false));
setPartMapVector(jdf.getPartMapVector());
if (!hasAttribute(AttributeName.DESCRIPTIVENAME))
setDescriptiveName(StringUtil.getNonEmpty(jdf.getDescriptiveName()));
if (!hasAttribute(AttributeName.PRIORITY))
{
final JDFNodeInfo ni = jdf.getInheritedNodeInfo("@" + AttributeName.PRIORITY);
if (ni != null)
{
copyAttribute(AttributeName.PRIORITY, ni, null, null, null);
}
}
this.eraseEmptyAttributes(true);
}
/**
* @param arg0
* @return
* @see java.lang.Comparable#compareTo(java.lang.Object)
*/
@Override
public int compareTo(final KElement arg0)
{
return new QueueEntryComparator().compare(this, arg0);
}
/**
* @see org.cip4.jdflib.auto.JDFAutoQueueEntry#setEndTime(org.cip4.jdflib.util.JDFDate)
* @param value
*/
@Override
public void setEndTime(final JDFDate value)
{
setSortDate(AttributeName.ENDTIME, value == null ? null : value.getDateTimeISO());
}
/**
* @see org.cip4.jdflib.auto.JDFAutoQueueEntry#setStartTime(org.cip4.jdflib.util.JDFDate)
* @param value
*/
@Override
public void setStartTime(final JDFDate value)
{
setSortDate(AttributeName.STARTTIME, value == null ? null : value.getDateTimeISO());
}
/**
* @param attName
* @param value
*/
private void setSortDate(final String attName, String value)
{
if (value == null)
value = new JDFDate().getDateTimeISO();
final String oldVal = getAttribute(attName, null, null);
if (!ContainerUtil.equals(oldVal, value))
{
super.setAttribute(attName, value);
final JDFQueue queue = isAutomated() ? (JDFQueue) getParentNode_KElement() : null;
if (queue != null)
{
synchronized (queue)
{
super.setAttribute(attName, value);
queue.sortChild(this);
}
}
}
}
/**
* @see org.cip4.jdflib.auto.JDFAutoQueueEntry#setSubmissionTime(org.cip4.jdflib.util.JDFDate)
* @param value
*/
@Override
public void setSubmissionTime(final JDFDate value)
{
setSortDate(AttributeName.SUBMISSIONTIME, value == null ? null : value.getDateTimeISO());
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy