org.cip4.jdflib.resource.devicecapability.JDFxor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of JDFLibJ Show documentation
CIP4 JDF Library for JDF 1.x
There is a newer version: 2.1.8.10
/*
 *
 * The CIP4 Software License, Version 1.0
 *
 *
 * Copyright (c) 2001-2010 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
 * .
 *  
 * 
 */

/**
 * @author Elena Skobchenko
 *
 * JDFxor.java
 *
 */
package org.cip4.jdflib.resource.devicecapability;

import org.apache.xerces.dom.CoreDocumentImpl;
import org.cip4.jdflib.core.ElementName;
import org.cip4.jdflib.core.JDFConstants;
import org.cip4.jdflib.core.KElement;
import org.cip4.jdflib.core.VElement;
import org.cip4.jdflib.core.VString;
import org.cip4.jdflib.datatypes.JDFAttributeMap;

/**
 * 
  * @author Rainer Prosi, Heidelberger Druckmaschinen *
 */
public class JDFxor extends JDFNodeTerm
{
	private static final long serialVersionUID = 1L;

	/**
	 * Constructor for JDFxor
	 * 
	 * @param myOwnerDocument
	 * @param qualifiedName
	 */
	public JDFxor(CoreDocumentImpl myOwnerDocument, String qualifiedName)
	{
		super(myOwnerDocument, qualifiedName);
	}

	/**
	 * Constructor for JDFxor
	 * 
	 * @param myOwnerDocument
	 * @param myNamespaceURI
	 * @param qualifiedName
	 */
	public JDFxor(CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName)
	{
		super(myOwnerDocument, myNamespaceURI, qualifiedName);
	}

	/**
	 * Constructor for JDFxor
	 * 
	 * @param myOwnerDocument
	 * @param myNamespaceURI
	 * @param qualifiedName
	 * @param myLocalName
	 */
	public JDFxor(CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName, String myLocalName)
	{
		super(myOwnerDocument, myNamespaceURI, qualifiedName, myLocalName);
	}

	/**
	 * 
	 * @see org.cip4.jdflib.core.JDFElement#toString()
	 * @return
	 */
	@Override
	public String toString()
	{
		return " JDFxor[  --> " + super.toString() + " ]";
	}

	/**
	 * 
	 * @param iSkip
	 * @return
	 */
	public JDFBooleanEvaluation getBooleanEvaluation(int iSkip)
	{
		JDFBooleanEvaluation e = (JDFBooleanEvaluation) getElement(ElementName.BOOLEANEVALUATION, JDFConstants.EMPTYSTRING, iSkip);
		return e;
	}

	/**
	 * Evaluates two or more Term elements (and, or, xor, not, Evaluation,
	 * TestRef) to determine if, as a set, they evaluate to "true" when combined
	 * in a boolean "xor" function. ! For more than two arguments, exactly one
	 * Term must evaluate to "true" for the "xor" to evaluate to "true".

	 * 
	 * Looks for Evaluations that "xor" consists of, and tests the status of
	 * every Evaluation, until the result of a whole boolean expression is
	 * determinated. Tests whether attribute map 'm' has a key specified by
	 * Evaluation/BasicPreflightTest/@Name. If 'm' has such key, checks if its
	 * value fits the testlists, specified for matching Evaluation (uses
	 * FitsValue(value))
	 * 
	 * @param m
	 *            key-value pair attribute map
	 * @return boolean - true, if boolean "xor" expression evaluates to "true"
	 */
	@Override
	public boolean fitsMap(JDFAttributeMap m)
	{
		VElement v = getChildElementVector(null, null, null, true, 0, false);
		int siz = v.size();
		int count = 0;
		for (int i = 0; i < siz; i++)
		{
			JDFTerm t = (JDFTerm) v.elementAt(i);
			if (t.fitsMap(m))
				count++;
			if (count > 1)
				return false;
		}

		return (count == 1);
	}

	/**
	 * Evaluates two or more Term elements (and, or, xor, not, Evaluation,
	 * TestRef) to determine if, as a set, they evaluate to "true" when combined
	 * in a boolean "xor" function.
	 * 
	 * @param jdf
	 *            JDFNode to test to know if the Device can accept it
	 * @param reportRoot
	 *            the report to generate; set to null if no report
	 *            is requested
	 * @return boolean - true, if boolean "xor" expression evaluates to "true"
	 */
	@Override
	public boolean fitsJDF(KElement jdf, KElement reportRoot)
	{
		KElement reportRootLocal = reportRoot;

		VElement v = getTermVector(null);
		if (reportRootLocal != null)
			reportRootLocal = reportRootLocal.appendElement("xor");

		int siz = v.size();

		int count = 0;
		for (int i = 0; i < siz; i++)
		{
			JDFTerm t = (JDFTerm) v.elementAt(i);
			if (t.fitsJDF(jdf, reportRootLocal))
				count++;

			if (count > 1 && reportRootLocal == null)
				break;
		}

		boolean b = (count == 1);
		if (reportRootLocal != null)
			reportRootLocal.setAttribute("Value", b, null);

		return b;
	}

	// ///////////////////////////////////////////////////////

	/**
	 * 
	 */
	@Override
	public VString getMissingElements(int nMax)
	{
		VString v = super.getMissingElements(nMax);
		if (v.size() >= nMax)
			return v;

		v.appendUnique(getMissingTerms(2));
		return v;
	}

	// ///////////////////////////////////////////////////////

}