org.cip4.jdflib.pool.JDFResourcePool Maven / Gradle / Ivy
Show all versions of JDFLibJ Show documentation
/*
* 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
*
* Note that the cardinality is not updated and that the pool should be used for version checks only
*
* @return ElemInfoTable[] the resourcelinkpools elemeninfotable
*/
public static ElemInfoTable[] getLinkInfoTable()
{
final ElemInfoTable[] elemInfoTableLink = new ElemInfoTable[elemInfoTable.length];
for (int i = 0; i < elemInfoTableLink.length; i++)
{
elemInfoTableLink[i] = new ElemInfoTable(elemInfoTable[i].getElementName() + JDFConstants.LINK, elemInfoTable[i].getValidityStatus());
}
return elemInfoTableLink;
}
/**
* toString
*
* @return String
*/
@Override
public String toString()
{
return "JDFResourcePool[ --> " + super.toString() + " ]";
}
/**
* GetResIds - returns a set of all IDs of the resources that are in this pool
*
* @return Vector - all IDs of the pool childs
*/
public VString getResIds()
{
final VString setID = new VString();
final VElement nl = getPoolChildren(null, null, null);
final int l = nl.size();
for (int i = 0; i < l; i++)
{
final String s = ((JDFResource) nl.elementAt(i)).getAttribute(AttributeName.ID);
if (s.equals(JDFConstants.EMPTYSTRING))
{
continue;
}
setID.add(s);
}
return setID;
}
/**
* Method GetResource.
*
* default: GetResource(name, 0, JDFConstants.EMPTYSTRING)
*
* @param strName name of the resource to look for
* @param i the index of the child, or -1 to create a new one
* @param nameSpaceURI the namespace to search in
*
* @return JDFResource: the resource you were looking for, null if not found
*/
public JDFResource getResource(final String strName, final int i, final String nameSpaceURI)
{
final KElement poolChild = getPoolChild(i, strName, null, nameSpaceURI);
if (poolChild != null)
{
return (JDFResource) poolChild;
}
return null;
}
/**
* append an existing resource by moving it here
*
* @param res name of the resource to append
*
* @return JDFResource: the appended resource
*/
public JDFResource appendResource(final JDFResource res)
{
return (JDFResource) moveElement(res, null);
}
/**
* append a resource
*
* default: AppendResource(name, resClass, null)
*
* @param strName name of the resource to append
* @param resClass class of the resource to append
* @param nameSpaceURI the namespace for the resource
*
* @return JDFResource: the appended resource
*/
public JDFResource appendResource(final String strName, final JDFResource.EnumResourceClass resClass, final String nameSpaceURI)
{
final KElement appElement = appendElement(strName, nameSpaceURI);
if (appElement instanceof JDFResource)
{
final JDFResource r = (JDFResource) appElement;
if (!r.hasAttribute(AttributeName.CLASS) && resClass != null)
{
r.setResourceClass(resClass);
}
return r;
}
return null;
}
/**
* copies a resource recursively, optionally fixes status flags and locks in the source resource
*
* default: copyResource(r, null, new VJDFAttributeMap(), null)
*
* @param r the resource to copy into this
* @param copyStatus rw or ro
* @param vParts part map vector of the partitions to copy
* @param spawnID the spawnID of the spawning that initiated the copy
* @return VString: vector of resource names that have been copied
* @deprecated use JDFNode.copySpawnedResources
*
*
*/
@SuppressWarnings("unchecked")
@Deprecated
public VString copyResource(final JDFResource r, final JDFResource.EnumSpawnStatus copyStatus, final VJDFAttributeMap vParts, final String spawnID)
{
final Vector ss = getResIds();
final VString v = new VString();
// r is not yet here copy r
if (!ss.contains(r.getID()))
{
JDFResource rNew = null;
// if spawning, fix stati and locks
if (copyStatus == JDFResource.EnumSpawnStatus.SpawnedRO)
{
// copy the complete resource as RO - no need to reduce
// partitions
r.appendSpawnIDs(spawnID);
rNew = (JDFResource) copyElement(r, null);
rNew.setLocked(true);
r.setSpawnStatus(copyStatus);
}
else if (copyStatus == JDFResource.EnumSpawnStatus.SpawnedRW)
{
if (vParts.size() == 0)
{ // just copy the whole thing - no parts specified
r.appendSpawnIDs(spawnID);
rNew = (JDFResource) copyElement(r, null);
r.setSpawnStatus(copyStatus);
}
else
{
rNew = (JDFResource) copyElement(r, null);
rNew.reducePartitions(vParts);
// reduce any unneeded leaves
// loop over all part maps to get best matching resource
for (int i = 0; i < vParts.size(); i++)
{
final JDFResource pLeaf = r.getPartition(vParts.elementAt(i), null);
final JDFResource pNewLeaf = rNew.getPartition(vParts.elementAt(i), null);
if (pLeaf != null)
{
pLeaf.setSpawnStatus(copyStatus);
pLeaf.appendSpawnIDs(spawnID);
}
if (pNewLeaf != null)
{
pNewLeaf.appendSpawnIDs(spawnID);
}
}
}
}
if (rNew != null)
{
v.addElement(rNew.getID());
}
}
final VString vs = r.getHRefs(null, false, true);
// add recursively copied resources
for (int i = 0; i < vs.size(); i++)
{
final String id = vs.elementAt(i);
// the referenced resource is in this pool - continue
if (ss.contains(id))
{
continue;
}
// the referenced resource has already been merged in - continue
if (v.contains(id))
{
continue;
}
JDFResource next = (JDFResource) getDocRoot().getTarget(id, AttributeName.ID);
if (next == null)
{
// 071101 RP added r is by definition in the original document
// which also contains the rrefs elements
next = (JDFResource) r.getDocRoot().getTarget(id, AttributeName.ID);
// and now all those interlinked resources
final VString vv = copyResource(next, copyStatus, vParts, spawnID);
v.addAll(vv);
}
}
return v;
}
/**
* Method GetPoolChildren Gets all children with the attribute name,mAttrib, nameSpaceURI out of the pool
*
* @param strName - name of the child
* @param mAttrib - a attribute to search for
* @param nameSpaceURI
* @return VElement - a vector with all elements in the pool matching the conditions
*
* default: GetPoolChildren(null, null, null)
*/
public VElement getPoolChildren(final String strName, final JDFAttributeMap mAttrib, final String nameSpaceURI)
{
return getPoolChildren_JDFResourcePool(strName, mAttrib, nameSpaceURI);
}
/**
* Method getPoolChildren_JDFResourcePool
* Gets all children with the attributes name, mAttrib, nameSpaceURI from the pool
*
* @param strName name of the child
* @param mAttrib attribute to search for
* @param nameSpaceURI namespace to search in
* @return VElement - a vector with all elements in the pool matching the conditions
*/
private VElement getPoolChildren_JDFResourcePool(final String strName, final JDFAttributeMap mAttrib, final String nameSpaceURI)
{
final VElement v = getPoolChildrenGeneric(strName, mAttrib, nameSpaceURI);
for (int i = v.size() - 1; i >= 0; i--)
{
if (!(v.elementAt(i) instanceof JDFResource))
{
v.removeElementAt(i);
}
}
return v;
}
/**
* Method getPoolChild
* get a child resource from the pool matching the parameters
*
* default: GetPoolChild(i, null, null, null)
*
* @param i the index of the child or -1 to make a new one.
* @param strName the name of the element
* @param mAttrib the attribute of the element
* @param nameSpaceURI the namespace to search in
* @return JDFResource: the pool child matching the conditions above
*/
public JDFResource getPoolChild(final int i, final String strName, final JDFAttributeMap mAttrib, final String nameSpaceURI)
{
return getPoolChild_JDFResourcePool(i, strName, mAttrib, nameSpaceURI);
}
/**
* Method getPoolChild_JDFResourcePool
* get a child resource from the pool matching the parameters
*
* @param i the index of the child or -1 to make a new one.
* @param strName the name of the element
* @param mAttrib the attribute of the element
* @param nameSpaceURI the namespace to search in
* @return JDFResource: the pool child matching the above conditions
*/
private JDFResource getPoolChild_JDFResourcePool(final int i, final String strName, final JDFAttributeMap mAttrib, final String nameSpaceURI)
{
int iLocal = i;
final VElement v = getPoolChildren(strName, mAttrib, nameSpaceURI);
if (iLocal < 0)
{
iLocal = v.size() + iLocal;
if (iLocal < 0)
{
return null;
}
}
if (v.size() <= iLocal)
{
return null;
}
final JDFResource jdfResource = (JDFResource) v.elementAt(iLocal);
return jdfResource;
}
/**
* return a vector of unknown element nodenames
*
* default: GetUnknownElements(true, 99999999)
*
* @param bIgnorePrivate ignores private elements. !Must be here to provide correct validation
* @param nMax - max entries in vector
* @return Vector of unknown element nodenames
*/
@Override
public VString getUnknownElements(final boolean bIgnorePrivate, final int nMax)
{
return getUnknownPoolElements(JDFElement.EnumPoolType.ResourcePool, nMax);
}
/**
* returns a the resource with ID=id, if it is in this pool
*
* @param id the ID of the requested resource
* @return JDFResource: the resource, empty element if it does not exist
*/
public JDFResource getResourceByID(final String id)
{
final XMLDocUserData userData = getXMLDocUserData();
if (userData != null)
{
KElement kRet = userData.getTarget(id);
if (kRet != null && kRet.getParentNode_KElement() != this)
{
kRet = null; // it is somewhere else, not a child of this!
}
if (kRet != null && (kRet instanceof JDFResource))
{
return (JDFResource) kRet;
}
}
KElement e = getFirstChildElement();
while (e != null)
{
final Attr attr = e.getAttributeNode(AttributeName.ID);
if (attr != null)
{
if (userData != null)
{
userData.setTarget(e, attr.getValue());
}
if (id.equals(attr.getValue()))
{
break;
}
}
e = e.getNextSiblingElement();
}
return (e instanceof JDFResource) ? (JDFResource) e : null;
}
/**
* get refElements
*
* @param vDoneRefs used internally for recursion
* @param bRecurse if true, also return recursively linked IDs
* @return HashSet: the vector of referenced resource IDs
*/
@Override
public HashSet getAllRefs(HashSet vDoneRefs, final boolean bRecurse)
{
final VElement vResources = getPoolChildren(null, null, null);
final int size = vResources.size();
for (int i = 0; i < size; i++)
{
final JDFResource r = (JDFResource) vResources.elementAt(i);
vDoneRefs = r.getResourceRoot().getAllRefs(vDoneRefs, bRecurse);
}
return vDoneRefs;
}
// ////////////////////////////////////////////////////////////////////
/**
* get all completely unlinked resources
*
* @return V the vector of unlinked resources.
*/
public VElement getUnlinkedResources()
{
final VElement v = getPoolChildren(null, null, null);
if (v == null || v.size() == 0)
{
return null;
}
for (int i = v.size() - 1; i >= 0; i--)
{
final JDFResource r = (JDFResource) v.elementAt(i);
final VElement v2 = r.getLinksAndRefs(true, true);
if (v2 != null)
{
v.removeElementAt(i);
}
}
return v.size() == 0 ? null : v;
}
}