• Home
• org.cip4.lib.jdf
• JDFLibJ
• 2.1.8.11
• source code
• JDFTerm.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

/*
 *
 * The CIP4 Software License, Version 1.0
 *
 *
 * Copyright (c) 2001-2019 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 .
 *
 *
 */

package org.cip4.jdflib.resource.devicecapability;

import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.apache.commons.lang.enums.ValuedEnum;
import org.apache.xerces.dom.CoreDocumentImpl;
import org.cip4.jdflib.core.ElementName;
import org.cip4.jdflib.core.JDFElement;
import org.cip4.jdflib.core.KElement;
import org.cip4.jdflib.datatypes.JDFAttributeMap;
import org.cip4.jdflib.ifaces.IDeviceCapable;
import org.w3c.dom.DOMException;

public abstract class JDFTerm extends JDFElement
{

	/**
	 *
	 */
	private static final long serialVersionUID = 6785589345368148259L;

	/**
	 * Constructor for JDFTerm
	 *
	 * @param myOwnerDocument
	 * @param qualifiedName
	 * @throws DOMException
	 */
	public JDFTerm(final CoreDocumentImpl myOwnerDocument, final String qualifiedName) throws DOMException
	{
		super(myOwnerDocument, qualifiedName);
	}

	/**
	 * Constructor for JDFTerm
	 *
	 * @param myOwnerDocument
	 * @param myNamespaceURI
	 * @param qualifiedName
	 * @throws DOMException
	 */
	public JDFTerm(final CoreDocumentImpl myOwnerDocument, final String myNamespaceURI, final String qualifiedName) throws DOMException
	{
		super(myOwnerDocument, myNamespaceURI, qualifiedName);
	}

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

	/**
	 * Evaluates the boolean expression (child Term element): checks whether it fits jdf
	 *
	 * @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 expression (child Term element) evaluates to true
	 */
	public abstract boolean fitsJDF(KElement jdf, KElement reportRoot); // const

	// JDFNode

	/**
	 * checks the xpath whether this term applies
	 *
	 * @param jdf the KElement to check
	 * @return boolean
	 */
	public abstract boolean fitsContext(KElement jdf);

	/**
	 * Tests whether this Term is compatible with the attribute map m (and, or, xor, not, Evaluation, TestRef).

	 * To determine the state of Term tests Evaluations thatdoes not consists of, this method checks if attribute map m has a key. specified by Evaluation/BasicPreflightTest/@Name If
	 * m has such key, it checks whether the value of m# fits the testlists specified for matching Evaluation (uses FitsValue(value))
	 *
	 * @param m key-value pair attribute map
	 * @return boolean - true, if boolean �not� expression evaluates to �true�
	 */
	public abstract boolean fitsMap(JDFAttributeMap m);

	public static final class EnumTerm extends ValuedEnum
	{
		private static final long serialVersionUID = 1L;
		private static int m_startValue = 0;

		@Override
		public String toString()
		{
			return getName();
		}

		protected EnumTerm(final String name)
		{
			super(name, m_startValue++);
		}

		public static EnumTerm getEnum(final String enumName)
		{
			return (EnumTerm) getEnum(EnumTerm.class, enumName);
		}

		public static EnumTerm getEnum(final int enumValue)
		{
			return (EnumTerm) getEnum(EnumTerm.class, enumValue);
		}

		public static Map getEnumMap()
		{
			return getEnumMap(EnumTerm.class);
		}

		public static List getEnumList()
		{
			return getEnumList(EnumTerm.class);
		}

		public static Iterator iterator()
		{
			return iterator(EnumTerm.class);
		}

		/**
		 * Constants EnumActivation
		 */
		public static final EnumTerm and = new EnumTerm(ElementName.AND);
		public static final EnumTerm or = new EnumTerm(ElementName.OR);
		public static final EnumTerm not = new EnumTerm(ElementName.NOT);
		public static final EnumTerm xor = new EnumTerm(ElementName.XOR);
		public static final EnumTerm BooleanEvaluation = new EnumTerm(ElementName.BOOLEANEVALUATION);
		public static final EnumTerm DateTimeEvaluation = new EnumTerm(ElementName.DATETIMEEVALUATION);
		public static final EnumTerm DurationEvaluation = new EnumTerm(ElementName.DURATIONEVALUATION);
		public static final EnumTerm EnumerationEvaluation = new EnumTerm(ElementName.ENUMERATIONEVALUATION);
		public static final EnumTerm IntegerEvaluation = new EnumTerm(ElementName.INTEGEREVALUATION);
		public static final EnumTerm IsPresentEvaluation = new EnumTerm(ElementName.ISPRESENTEVALUATION);
		public static final EnumTerm MatrixEvaluation = new EnumTerm(ElementName.MATRIXEVALUATION);
		public static final EnumTerm NameEvaluation = new EnumTerm(ElementName.NAMEEVALUATION);
		public static final EnumTerm NumberEvaluation = new EnumTerm(ElementName.NUMBEREVALUATION);
		public static final EnumTerm PDDFPathEvaluation = new EnumTerm(ElementName.PDFPATHEVALUATION);
		public static final EnumTerm RectangleEvaluation = new EnumTerm(ElementName.RECTANGLEEVALUATION);
		public static final EnumTerm ShapeEvaluation = new EnumTerm(ElementName.SHAPEEVALUATION);
		public static final EnumTerm StringEvaluation = new EnumTerm(ElementName.STRINGEVALUATION);
		public static final EnumTerm XYPairEvaluation = new EnumTerm(ElementName.XYPAIREVALUATION);
		public static final EnumTerm TestRef = new EnumTerm(ElementName.TESTREF);
	}

	/**
	 * get the parent devicecap or messageservice
	 *
	 * @return
	 */
	IDeviceCapable getDeviceCapable()
	{
		IDeviceCapable deviceCap = (IDeviceCapable) getDeepParent(ElementName.DEVICECAP, 0);
		if (deviceCap != null)
			return deviceCap;
		deviceCap = (IDeviceCapable) getDeepParent(ElementName.MESSAGESERVICE, 0);
		return deviceCap;
	}

}