org.cip4.jdflib.resource.devicecapability.JDFEvaluation 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-2023 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
* value matches the testlists specified for this Evaluation
*
* @param value value to test
* @return boolean - true, if the value matches testlists or if testlists are not specified
*/
abstract public boolean fitsValue(String value);
/**
* fitsValue - checks whether elem matches the testlists specified for this Evaluation
*
* @param elem element to test
* @return boolen - true, if the value matches testlists or if testlists are not specified
*/
public boolean fitsValue(KElement elem)
{
// TODO implement in subclasses for spans
return elem != null;
}
/**
* gets the ListType from a corresponding State/BasicPreflightTest element
*
* @return JDFBasicPreflightTest::EnumListType - the value of ListType attribute
*/
public JDFBasicPreflightTest.EnumListType getListType()
{
final JDFAbstractState state = getState();
if (state != null)
{
return state.getListType();
}
final JDFBasicPreflightTest basicPreflightTest = getBasicPreflightTest();
return basicPreflightTest == null ? null : basicPreflightTest.getListType();
}
/**
* gets the XPath to the attributes of a given JDF node
*
* @param jdf JDF node to test
* @return String - the XPath to the attributes
*/
protected String getEvalXPath(KElement jdf)
{
final ICapabilityElement stateDC = getRefTarget();
if (stateDC == null)
return null;
VString vPath = null;
boolean bElement = false;
String attName = null;
if (stateDC instanceof JDFDevCap)
{
if (!(this instanceof JDFIsPresentEvaluation)) // only ispresent may
// reference a
// devcap, all
// others must
// reference a state
return null;
bElement = true;
final JDFDevCap dc = (JDFDevCap) stateDC;
vPath = dc.getNamePathVector(true);
// fix up for the fact that ispresent for a resource is actually a
// link
if (vPath != null)
{
for (int i = 0; i < vPath.size(); i++)
{
String path = vPath.get(i);
VString tokens = StringUtil.tokenize(path, "/", false);
if (tokens.size() == 3 && tokens.get(1).equals(ElementName.RESOURCEPOOL))
{
tokens.set(1, ElementName.RESOURCELINKPOOL);
tokens.set(2, tokens.get(2) + "Link");
vPath.set(i, StringUtil.setvString(tokens, "/", null, null));
}
}
}
}
else if (stateDC instanceof JDFDevCaps)
{
if (!(this instanceof JDFIsPresentEvaluation)) // only ispresent may
// reference a
// devcap, all
// others must
// reference a state
return null;
bElement = true;
final JDFDevCaps dc = (JDFDevCaps) stateDC;
vPath = dc.getNamePathVector();
// fix up for the fact that ispresent for a resource is actually a
// link
if (vPath != null)
{
for (int i = 0; i < vPath.size(); i++)
{
String path = vPath.get(i);
VString tokens = StringUtil.tokenize(path, "/", false);
if (tokens.size() == 3 && tokens.get(1).equals(ElementName.RESOURCEPOOL))
{
tokens.set(1, ElementName.RESOURCELINKPOOL);
String link = tokens.get(2) + "Link";
EnumUsage lu = dc.getLinkUsage();
if (lu != null)
link += "[@Usage=\"" + lu.getName() + "\"]";
tokens.set(2, link);
vPath.set(i, StringUtil.setvString(tokens, "/", null, null));
}
}
}
}
else
{
// we have found our state -> take its xPath and look for
// corresponding elem in JDFNode, we test
final JDFAbstractState state = (JDFAbstractState) stateDC;
if (state.getListType().equals(EnumListType.Span))
{
vPath = state.getNamePathVector(true);
bElement = true;
}
else
{
final KElement kdc = state.getParentNode_KElement();
if (kdc instanceof IDeviceCapable)
{
vPath = ((IDeviceCapable) kdc).getNamePathVector();
}
else if (kdc instanceof ICapabilityElement)
{
vPath = ((ICapabilityElement) kdc).getNamePathVector();
}
attName = state.getName();
}
}
if (vPath != null)
{
for (int i = 0; i < vPath.size(); i++)
{
String xPath = vPath.get(i);
int slash = xPath.length();
String finalS = null;
do
{
String xPath2 = xPath.substring(0, slash);
if (jdf.matchesPath(xPath2, true))
finalS = "." + xPath.substring(slash);
slash = xPath2.lastIndexOf("/");
}
while (slash >= 0 && finalS == null);
if (finalS != null && !bElement)
{
finalS += "/@" + attName;
}
if (finalS != null)
return finalS;
}
}
return null;
}
/**
* getRefTargetNamePath()
*
* @return String
*/
public String getRefTargetNamePath()
{
ICapabilityElement e = getRefTarget();
if (e instanceof JDFAbstractState)
{
return ((JDFAbstractState) e).getNamePath();
}
else if (e instanceof JDFDevCap)
{
return ((JDFDevCap) e).getNamePath(true);
}
else if (e instanceof JDFDevCaps)
{
return ((JDFDevCaps) e).getName();
}
return null;
}
/**
* getRefTargetName()
*
* @return String
*/
public String getRefTargetName()
{
ICapabilityElement e = getRefTarget();
if (e instanceof JDFAbstractState)
{
return ((JDFAbstractState) e).getName();
}
else if (e instanceof JDFDevCap)
{
return ((JDFDevCap) e).getName();
}
else if (e instanceof JDFDevCaps)
{
return ((JDFDevCaps) e).getName();
}
return null;
}
/**
* setRefTarget() set the target referencened in @rRef
*
* @param e
*
*/
public void setRefTarget(JDFElement e)
{
JDFDeviceCap deviceCap = (JDFDeviceCap) getDeepParent(ElementName.DEVICECAP, 0);
if (deviceCap == null)
throw new JDFException("setRefTarget, called in dangling evaluation");
if (!(e instanceof JDFAbstractState) && !(e instanceof JDFDevCap))
throw new JDFException("setRefTarget, called for illegal target type");
final String id = e.appendAnchor(null);
setrRef(id);
}
/**
* getRefTarget() get the target referencened in @rRef
*
* @return ICapabilityElement the referenced element, either state or a devcap
*/
public ICapabilityElement getRefTarget()
{
IDeviceCapable deviceCap = getDeviceCapable();
if (deviceCap == null)
return null;
return deviceCap.getTargetCap(getrRef());
}
/**
* getState()
*
* @return JDFAbstractState
*/
public JDFAbstractState getState()
{
ICapabilityElement ic = getRefTarget();
if (ic instanceof JDFAbstractState)
return (JDFAbstractState) ic;
return null;
}
/*
* // Attribute Getter / Setter
*/
/**
* Sets String attribute rRef
* Since rRef is independent of the data type of the State element, the setter is defined here
*
* @param value the value to set the attribute to
*/
public void setrRef(String value)
{
setAttribute(AttributeName.RREF, value);
}
/**
* Gets String attribute rRef
* Since rRef is independent of the data type of the State element,the getter is defined here
*
* @return String: the attribute value
*/
public String getrRef()
{
return getAttribute(AttributeName.RREF, null, "");
}
/**
* Sets String attribute rRef
* Since rRef is independent of the data type of the State element, the setter is defined here
*
* @param value the value to set the attribute to
*/
public void setPath(String value)
{
setAttribute(AttributeName.PATH, value);
}
/**
* Gets String attribute Path
*
* @return String: the attribute value
*/
public String getPath()
{
return getAttribute(AttributeName.PATH, null, "");
}
/*
* // Element Getter / Setter
*/
// @{
/**
* Get element BasicPreflightTest. Creates it if it doesn't exist
*
* default: getCreateBasicPreflightTest(0
*
* @return JDFBasicPreflightTest: the matching element
*/
public JDFBasicPreflightTest getCreateBasicPreflightTest()
{
return (JDFBasicPreflightTest) getCreateElement(ElementName.BASICPREFLIGHTTEST, null, 0);
}
/**
* Gets the iSkip-th element BasicPreflightTest. If doesn't exist, creates it
*
* default getCreateBasicPreflightTest(0)
*
* @param iSkip number of elements to skip
* @return JDFBasicPreflightTest: the matching element
* @deprecated use getCreateBasicPreflightTest()
*/
@Deprecated
public JDFBasicPreflightTest getCreateBasicPreflightTest(int iSkip)
{
return (JDFBasicPreflightTest) getCreateElement(ElementName.BASICPREFLIGHTTEST, JDFConstants.EMPTYSTRING, iSkip);
}
/**
* Gets element BasicPreflightTest
*
* @return JDFBasicPreflightTest: the matching element or null
*/
public JDFBasicPreflightTest getBasicPreflightTest()
{
return (JDFBasicPreflightTest) getElement(ElementName.BASICPREFLIGHTTEST, null, 0);
}
/**
* Gets the iSkip'th element BasicPreflightTest
*
* default: getBasicPreflightTest(0)
*
* @param iSkip number of elements to skip
* @return JDFBasicPreflightTest: the matching element or null
* @deprecated use getBasicPreflightTest()
*/
@Deprecated
public JDFBasicPreflightTest getBasicPreflightTest(int iSkip)
{
return (JDFBasicPreflightTest) getElement(ElementName.BASICPREFLIGHTTEST, JDFConstants.EMPTYSTRING, iSkip);
}
/**
* Appends element BasicPreflightTest to the end of this
*
* @return JDFBasicPreflightTest: newly created BasicPreflightTest element
* @deprecated use appendBasicPreflightTest(name)
*/
@Deprecated
public JDFBasicPreflightTest appendBasicPreflightTest()
{
return (JDFBasicPreflightTest) appendElementN(ElementName.BASICPREFLIGHTTEST, 1, null);
}
/**
* Appends element BasicPreflightTest to the end of this and sets @Name to name
*
* @param testName the new Name attribute of the BasicPreflightTest
* @return JDFBasicPreflightTest: newly created BasicPreflightTest element
*/
public JDFBasicPreflightTest appendBasicPreflightTest(String testName)
{
JDFBasicPreflightTest pft = (JDFBasicPreflightTest) appendElementN(ElementName.BASICPREFLIGHTTEST, 1, null);
if (pft == null)
return null;
if (testName != null)
pft.setName(testName);
return pft;
}
/**
* tolerance is defined in all numeric evaluations - implement here!
*
* @return
*/
protected JDFXYPair getTolerance()
{
try
{
return new JDFXYPair(getAttribute(AttributeName.TOLERANCE, null, "0 0"));
}
catch (DataFormatException e)
{
throw new JDFException("JDFEvaluation.getTolerance: Attribute Tolerance is not applicable to create JDFXYPair");
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy