org.cip4.jdflib.resource.process.JDFUsageCounter 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-2012 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
 * .
 *
 *
 *//**
	*
	* Copyright (c) 2001 Heidelberger Druckmaschinen AG, All Rights Reserved.
	*
	* JDFUsageCounter.java
	*
	* Last changes
	*
	*/
package org.cip4.jdflib.resource.process;

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

import org.apache.commons.lang.enums.ValuedEnum;
import org.apache.xerces.dom.CoreDocumentImpl;
import org.cip4.jdflib.auto.JDFAutoUsageCounter;
import org.cip4.jdflib.core.AttributeName;
import org.cip4.jdflib.util.StringUtil;
import org.w3c.dom.DOMException;

/**
 * 
 *
 * @author rainer prosi
 * @date Jan 10, 2012
 */
public class JDFUsageCounter extends JDFAutoUsageCounter
{
	private static final long serialVersionUID = 1L;

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

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

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

	// **************************************** Methods
	// *********************************************
	/**
	 * toString
	 * 
	 * @return String
	 */
	@Override
	public String toString()
	{
		return "JDFUsageCounter[  --> " + super.toString() + " ]";
	}

	/**
	 * 
	 * 
	 * @author rainerprosi
	 * @date Jan 10, 2012
	 */
	public static class EnumCounterType extends ValuedEnum
	{
		private static final long serialVersionUID = 1L;
		private static int m_startValue = 0;

		private EnumCounterType(String name)
		{
			super(name, m_startValue++);
		}

		/**
		 * 
		 * 
		 * @param enumName
		 * @return
		 */
		public static EnumCounterType getEnum(String enumName)
		{
			return (EnumCounterType) getEnum(EnumCounterType.class, enumName);
		}

		/**
		 * 
		 * 
		 * @param enumValue
		 * @return
		 */
		public static EnumCounterType getEnum(int enumValue)
		{
			return (EnumCounterType) getEnum(EnumCounterType.class, enumValue);
		}

		/**
		 * 
		 * TODO Please insert comment!
		 * 
		 * @return
		 */
		public static Map getEnumMap()
		{
			return getEnumMap(EnumCounterType.class);
		}

		/**
		 * 
		 * 
		 * @return
		 */
		public static List getEnumList()
		{
			return getEnumList(EnumCounterType.class);
		}

		/**
		 * 
		 * 
		 * @return
		 */
		public static Iterator iterator()
		{
			return iterator(EnumCounterType.class);
		}

		/** */
		public static final EnumCounterType Blank = new EnumCounterType("Blank");
		/** */
		public static final EnumCounterType Insert = new EnumCounterType("Insert");
		/** */
		public static final EnumCounterType InsertPrefuser = new EnumCounterType("InsertPrefuser");
		/** */
		public static final EnumCounterType OneSided = new EnumCounterType("OneSided");
		/** */
		public static final EnumCounterType TwoSided = new EnumCounterType("TwoSided");
		/** */
		public static final EnumCounterType NormalSize = new EnumCounterType("NormalSize");
		/** */
		public static final EnumCounterType LargeSize = new EnumCounterType("LargeSize");
		/** */
		public static final EnumCounterType Black = new EnumCounterType("Black");
		/** */
		public static final EnumCounterType HighlightColor = new EnumCounterType("HighlightColor");
		/** */
		public static final EnumCounterType Color = new EnumCounterType("Color");
		/** */
		public static final EnumCounterType Separation = new EnumCounterType("Separation");
		/** */
		public static final EnumCounterType Varnish = new EnumCounterType("Varnish");
		/** */
		public static final EnumCounterType User = new EnumCounterType("User");
		/** */
		public static final EnumCounterType Auxiliary = new EnumCounterType("Auxiliary");
		/** */
		public static final EnumCounterType Impressions = new EnumCounterType("Impressions");
		/** */
		public static final EnumCounterType Clicks = new EnumCounterType("Clicks");
		/** */
		public static final EnumCounterType pt = new EnumCounterType("pt");
	}

	/*
	 * --------------------------------------------------------------------- Methods for Attribute CounterTypes
	 * ---------------------------------------------------------------------
	 */
	/**
	 * (5) set attribute CounterTypes
	 * 
	 * @param enumVar : the enumVar to set the attribute to
	 */
	public void setCounterTypes(EnumCounterType enumVar)
	{
		setAttribute(AttributeName.COUNTERTYPES, enumVar, null);
	}

	/**
	 * (5) set attribute CounterTypes
	 * 
	 * @param vVar vector of EnumCounterType : the enumVar to set the attribute to
	 */
	public void setCounterTypes(Vector vVar)
	{
		final String s = StringUtil.setvString(vVar);
		setAttribute(AttributeName.COUNTERTYPES, s, null);
	}

	/**
	 * append a countertype to attribute CounterTypes
	 * 
	 * @param cType EnumCounterType : the enumVar to set the attribute to
	 */
	public void appendCounterType(EnumCounterType cType)
	{
		if (cType != null)
		{
			appendAttribute(AttributeName.COUNTERTYPES, cType.getName(), null, null, true);
		}
	}

	/**
	 * (9) get attribute Scope
	 * 
	 * @return the value of the attribute
	 */
	public Vector getEnumCounterTypes()
	{
		return (Vector) getEnumerationsAttribute(AttributeName.COUNTERTYPES, null, EnumCounterType.Auxiliary, false);
	}

	/**
	 * also checks for matching counterID or CounteType mangled with "_", e.g. UsageCounter:ID_CounterA UsageCounter:Black_SingleSided etc.
	 */
	@Override
	public boolean matchesString(String namedResLink)
	{
		if (namedResLink == null)
			return false;
		final String counterID = getCounterID();
		if (!isWildCard(counterID))
		{
			String idString = getLocalName() + ":" + counterID;
			if (idString.equals(namedResLink))
				return true;
		}
		String ct = StringUtil.setvString(getCounterTypes(), "_", null, null);
		if (!isWildCard(ct) && namedResLink.equals(getLocalName() + ":" + ct))
			return true;
		return super.matchesString(namedResLink);
	}

}