org.cip4.jdflib.jmf.JDFJMF 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 family and type typ
*
* @param family the Message family - Query, Acknowledge, Command, Response, Registration or Signal
* @param typ the messages @Type value, null if unknown
* @return the newly created message
*/
public static JDFJMF createJMF(final JDFMessage.EnumFamily family, final JDFMessage.EnumType typ)
{
if (family == null)
{
throw new JDFException("createJMF: creating undefined message family");
}
final JDFJMF jmf = new JDFDoc(ElementName.JMF).getJMFRoot();
jmf.appendMessageElement(family, typ);
return jmf;
}
/**
* append a message element to this
*
* @param family the Message family - Query, Acknowledge, Command, Response, Registration or Signal
* @param typ the messages @Type value, null if unknown
* @return the newly created message
*/
public JDFMessage appendMessageElement(final JDFMessage.EnumFamily family, final JDFMessage.EnumType typ)
{
if (family == null)
{
throw new JDFException("appendMessageElement: creating undefined message family");
}
final String sFamily = family.getName();
final JDFMessage m = (JDFMessage) appendElement(sFamily, null);
if (typ != null)
{
m.setType(typ);
}
return m;
}
/**
* get the ith message element of family type family
*
* @param family
* @param i
* @return
* @deprecated since 060619, use getMessageElement (JDFMessage.EnumFamily family, JDFMessage.EnumType typ, int i)
*/
@Deprecated
public JDFMessage getMessageElement(final JDFMessage.EnumFamily family, final int i)
{
return getMessageElement(family, null, i);
}
/**
* get the ith message element of family type family
*
* @param family the Message family - Query, Acknowledge, Command, Response, Registration or Signal
* @param typ the messages @Type value, null if unknown
* @param i the i'th message element to get, if i<0, get from back
* @return the matching message, null if none are found
*/
public JDFMessage getMessageElement(final JDFMessage.EnumFamily family, final JDFMessage.EnumType typ, int i)
{
if (i < 0) // search from back
{
JDFMessage message = null;
final VElement v = getMessageVector(family, typ);
if (v != null)
{
final int siz = v.size();
i = siz + i;
message = (JDFMessage) (i >= 0 ? v.get(i) : null);
}
return message;
}
final String typString = typ == null ? null : typ.getName();
final String familyString = family == null ? null : family.getName();
KElement e = getElement(familyString, null, 0);
int n = 0;
while (e != null)
{
if (e instanceof JDFMessage)
{
final JDFMessage m = (JDFMessage) e;
if (typString == null || typString.equals(m.getType()))
{
if (n++ >= i)
{
return m;
}
}
}
e = e.getNextSiblingElement(familyString, null);
}
return null;
}
/**
* get a vector of all messages in this JMF
*
* @return VElement all message elements
* @deprecated use getMessageVector (null, null)
*/
@Deprecated
public VElement getMessageVector()
{
return getMessageVector(null, null);
}
/**
* get a vector of all messages in this JMF
*
* @param family requested message family
* @return VElement all message elements
* @deprecated use getMessageVector (family, null)
*/
@Deprecated
public VElement getMessageVector(final JDFMessage.EnumFamily family)
{
return getMessageVector(family, null);
}
/**
* get a vector of all messages in a JMF from a JDFDoc
*
* @param doc the JDFDoc to search - only valid for root JMF
* @param family requested message family
* @param typ requested message type
* @return VElement all message elements, null if no match found
*
*/
public static VElement getMessageVector(final JDFDoc doc, final JDFMessage.EnumFamily family, final JDFMessage.EnumType typ)
{
if (doc == null)
{
return null;
}
final JDFJMF jmf = doc.getJMFRoot();
if (jmf == null)
{
return null;
}
final VElement vM = jmf.getMessageVector(family, typ);
return vM.size() == 0 ? null : vM;
}
/**
* get a vector of all messages in this JMF
*
* @param family requested message family
* @param typ requested message type
* @return VElement all message elements
*
*/
public VElement getMessageVector(final JDFMessage.EnumFamily family, final JDFMessage.EnumType typ)
{
final String sFamily = (family != null) ? family.getName() : null;
final JDFAttributeMap typMap = typ == null ? null : new JDFAttributeMap(AttributeName.TYPE, typ.getName());
final VElement vM = getChildrenByTagName(sFamily, null, typMap, true, true, 0);
if (family == null) // only needed if call was generic
{
// do reverse iteration because erase invalidates
for (int i = vM.size() - 1; i >= 0; i--)
{
if (!(vM.elementAt(i) instanceof JDFMessage))
{
vM.removeElementAt(i);
}
}
}
return vM;
}
/**
*
* @param i
* @param bCreate
* @return
* @deprecated use getMessageElement or appendMessageElement
*/
@Deprecated
public JDFAcknowledge getAcknowledge(final int i, final boolean bCreate)
{
if (bCreate)
{
return (JDFAcknowledge) getCreateMessageElement(JDFMessage.EnumFamily.Acknowledge, null, i);
}
return (JDFAcknowledge) getMessageElement(JDFMessage.EnumFamily.Acknowledge, null, i);
}
/**
* Append a Command
*
* @param typ the type attribute of the appended message
* @return JDFQuery the newly created message element
*/
public JDFCommand appendCommand(final JDFMessage.EnumType typ)
{
return (JDFCommand) appendMessageElement(JDFMessage.EnumFamily.Command, typ);
}
/**
* Append a Command
*
* @param typ the type attribute of the appended message
* @return JDFQuery the newly created message element
*/
public JDFRegistration appendRegistration(final JDFMessage.EnumType typ)
{
return (JDFRegistration) appendMessageElement(JDFMessage.EnumFamily.Registration, typ);
}
/**
* Append a query
*
* @param typ the type attribute of the appended message
* @return JDFQuery: the newly created message element
*/
public JDFQuery appendQuery(final JDFMessage.EnumType typ)
{
return (JDFQuery) appendMessageElement(JDFMessage.EnumFamily.Query, typ);
}
/**
* Append a Signal
*
* @param typ the type attribute of the appended message
* @return JDFSignal: the newly created message element
*/
public JDFSignal appendSignal(final JDFMessage.EnumType typ)
{
return (JDFSignal) appendMessageElement(JDFMessage.EnumFamily.Signal, typ);
}
/**
* Append a Response
*
* @param typ the type attribute of the appended message
* @return JDFResponse the newly created message element
*/
public JDFResponse appendResponse(final JDFMessage.EnumType typ)
{
return (JDFResponse) appendMessageElement(JDFMessage.EnumFamily.Response, typ);
}
/**
* Append an Acknowledge
*
* @param typ the type attribute of the appended message
* @return JDFAcknowledge the newly created message element
*/
public JDFAcknowledge appendAcknowledge(final JDFMessage.EnumType typ)
{
return (JDFAcknowledge) appendMessageElement(JDFMessage.EnumFamily.Acknowledge, typ);
}
/**
* @return the theSenderID which is used as default when initializing new messages
*/
public static String getTheSenderID()
{
return theSenderID;
}
/**
* set the default senderID that is used to generate jmf messages
*
* @param _theSenderID the theSenderID to set
*/
public static void setTheSenderID(final String _theSenderID)
{
JDFJMF.theSenderID = _theSenderID;
}
/**
* create a new response for all messages of this if the message is any message except response correctly fills refId, type etc.
*
* @return the newly created JMF with multiple responses
*/
public JDFJMF createResponse()
{
final VElement v = getMessageVector(null, null);
final JDFJMF jmf = new JDFDoc(ElementName.JMF).getJMFRoot();
for (int i = 0; i < v.size(); i++)
{
final JDFMessage m = (JDFMessage) v.elementAt(i);
final EnumFamily family = m.getFamily();
if (family != null && EnumFamily.Response != family)
{
if (!m.hasAttribute(AttributeName.ID))
{
// crappy requests...
m.appendAnchor(null);
}
final JDFResponse r = jmf.appendResponse();
r.setQuery(m);
}
}
return jmf;
}
/**
* collect ICSVersions from all message children also removes duplicate entries from this and remove ""
*
* @return VString of all ICS versions
*/
public VString collectICSVersions()
{
final VElement v = getMessageVector(null, null);
final VString vICS = getICSVersions();
for (int i = 0; i < v.size(); i++)
{
final JDFMessage m = (JDFMessage) v.elementAt(i);
if (m.hasAttribute(AttributeName.ICSVERSIONS))
{
vICS.addAll(m.getICSVersions());
}
}
vICS.unify();
setICSVersions(vICS.size() == 0 ? null : vICS);
return vICS;
}
/**
* convert all responses that match the query q to signals
*
* @param q the query to convert
*
*/
public void convertResponses(final JDFQuery q)
{
final EnumType t = q == null ? null : q.getEnumType();
final VElement v = getMessageVector(EnumFamily.Response, t);
final String queryID = q == null ? null : q.getID();
for (int i = 0; i < v.size(); i++)
{
final JDFResponse r = (JDFResponse) v.elementAt(i);
if (queryID == null || queryID.equals(r.getrefID()))
{
final JDFSignal s = appendSignal();
moveElement(s, r); // retain ordering
s.convertResponse(r, q);
r.deleteNode();
}
}
}
/**
* get the @URL of this message if it is either a submitQueueEntry, a returnQueuentry or a resubmitqueueentry
*
* @return the String
*/
public String getSubmissionURL()
{
JDFCommand cSubmit = (JDFCommand) getMessageElement(EnumFamily.Command, EnumType.SubmitQueueEntry, 0);
if (cSubmit != null)
{
final JDFQueueSubmissionParams qsp = cSubmit.getQueueSubmissionParams(0);
return qsp == null ? null : isWildCard(qsp.getURL()) ? null : qsp.getURL();
}
cSubmit = (JDFCommand) getMessageElement(EnumFamily.Command, EnumType.ResubmitQueueEntry, 0);
if (cSubmit != null)
{
final JDFResubmissionParams rsp = cSubmit.getResubmissionParams(0);
return rsp == null ? null : isWildCard(rsp.getURL()) ? null : rsp.getURL();
}
cSubmit = (JDFCommand) getMessageElement(EnumFamily.Command, EnumType.ReturnQueueEntry, 0);
if (cSubmit != null)
{
final JDFReturnQueueEntryParams rsp = cSubmit.getReturnQueueEntryParams(0);
return rsp == null ? null : isWildCard(rsp.getURL()) ? null : rsp.getURL();
}
return null;
}
/**
* get element Acknowledge
*
* @param refID refID of the response
* @return JDFResponse the element
*
*/
public JDFAcknowledge getAcknowledge(final String refID)
{
return (JDFAcknowledge) getChildWithAttribute(ElementName.ACKNOWLEDGE, AttributeName.REFID, null, refID, 0, true);
}
/**
* (27) get element Response
*
* @param refID refID of the response
* @return JDFResponse the element
*
*/
public JDFResponse getResponse(final String refID)
{
return (JDFResponse) getChildWithAttribute(ElementName.RESPONSE, AttributeName.REFID, null, refID, 0, true);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy