org.cip4.jdflib.jmf.JDFResourceCmdParams Maven / Gradle / Ivy
Show all versions of JDFLibJ Show documentation
/*--------------------------------------------------------------------------------------------------
* The CIP4 Software License, Version 1.0
*
*
* Copyright (c) 2001-2009 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
* resName, create if it doesn't exist
*
* @param resName name of the resource to get/create
* @return JDFResource the element
*/
public JDFResource getCreateResource(final String resName)
{
final JDFResource r = null;
final KElement e = getCreateElement(resName, JDFConstants.EMPTYSTRING, 0);
if (!(e instanceof JDFResource))
{
throw new JDFException("JDFResourceCmdParams.getCreateResource tried to create a JDFElement instead of a JDFResource");
}
return r;
}
/**
* get resource defined by resNam
*
* @param resName name of the resource to get, if null get the one and only resource
* @return JDFResource the element, null if none exists
*/
public JDFResource getResource(final String resName)
{
if (resName != null)
{
final KElement e = getElement(resName, null, 0);
if (e instanceof JDFResource)
{
return (JDFResource) e;
}
}
else
{
final String resName2 = getResourceName();
if (resName2 != null && !resName2.equals(""))
{
return getResource(resName2);
}
KElement e2 = getFirstChildElement();
while (e2 != null)
{
if (e2 instanceof JDFResource)
{
return (JDFResource) e2;
}
e2 = e2.getNextSiblingElement();
}
}
return null;
}
/**
* Append Resource
*
* @param resName name of the resource to append
* @return JDFResource the element
*/
public JDFResource appendResource(final String resName)
{
final KElement e = appendElement(resName, null);
if (!(e instanceof JDFResource))
{
throw new JDFException("JDFResourceCMDParams.appendResource tried to return a JDFElement instead of a JDFResource");
}
return (JDFResource) e;
}
/**
* return the vector of unknown element nodenames
*
* default: GetInvalidElements(true, 999999)
* !!! Do not change the signature of this method
*
* @param bIgnorePrivate used by JDFElement during the validation
* @param nMax maximum number of elements to get
*
* @return Vector - vector of unknown element nodenames
*/
@Override
public VString getUnknownElements(final boolean bIgnorePrivate, final int nMax)
{
return getUnknownPoolElements(JDFElement.EnumPoolType.ResourcePool, nMax);
}
/**
* 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 defined by 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 define 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 by mPart
*
* @param mPart attribute map for the part to remove
*/
@Override
public void removePartMap(final JDFAttributeMap mPart)
{
super.removePartMap(mPart);
}
/**
* check whether the part defined in 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);
}
/**
* apply the parameters in this to all appropriate resources in parentNode or one of parentNode's children if no matching resource exists in the node, Usage
* MUST be set in this JDFResourceCmdParams, otherwise it is not possible to correctly link the newly created resource
*
* @param parentNode the node to search in
*/
public void applyResourceCommand(final JDFNode parentNode)
{
new ApplyCommand().applyResourceCommand(parentNode);
}
/**
* gets the NodeIdetifier that matches this
*
* @return {@link NodeIdentifier} the matching NodeIdentifier
*/
@Override
public NodeIdentifier getIdentifier()
{
return new NodeIdentifier(getJobID(), getJobPartID(), getPartMapVector());
}
/*
* --------------------------------------------------------------------- Methods for Attribute Usage
* ---------------------------------------------------------------------
*/
/**
* (5) set attribute Usage
* @param enumVar the enumVar to set the attribute to
*/
@Override
public void setUsage(final JDFResourceLink.EnumUsage enumVar)
{
setAttribute(AttributeName.USAGE, enumVar == null ? null : enumVar.getName(), null);
}
/**
* (9) get attribute Usage
* @return the value of the attribute
*/
@Override
public JDFResourceLink.EnumUsage getUsage()
{
return JDFResourceLink.EnumUsage.getEnum(getAttribute(AttributeName.USAGE, null, null));
}
/**
* @see org.cip4.jdflib.ifaces.INodeIdentifiable#setIdentifier(org.cip4.jdflib.node.JDFNode.NodeIdentifier)
* @param ni
*/
@Override
public void setIdentifier(final NodeIdentifier ni)
{
NodeIdentifier niLocal = ni;
if (niLocal == null)
{
niLocal = new NodeIdentifier();
}
setJobID(niLocal.getJobID());
setJobPartID(niLocal.getJobPartID());
setPartMapVector(niLocal.getPartMapVector());
}
}