org.cip4.jdflib.resource.devicecapability.JDFStringState 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-2018 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 Loc of the iSkip'th element Value
*
* @param iSkip number of Value elements to skip (iSkip=0 -> first Value element)
* @param jSkip number of Loc subelements of iSkip'th Value element to skip (jSkip=0 -> first Loc element)
* @return JDFLoc: the matching Loc element
*/
@Override
public JDFLoc getValueLocLoc(final int iSkip, final int jSkip)
{
final JDFValue val = (JDFValue) getElement(ElementName.VALUE, null, iSkip);
final JDFLoc loc = (JDFLoc) val.getElement(ElementName.LOC, null, jSkip);
return loc;
}
/**
* Appends element Loc to the end of the iSkip'th subelement Value
*
* @param iSkip number of Value elements to skip (iSkip=0 -> first Value element)
* @return JDFLoc: newly created Loc element
*/
@Override
public JDFLoc appendValueLocLoc(final int iSkip)
{
final JDFValue val = getValue(iSkip);
if (val == null)
return null;
return val.appendLoc();
}
/**
* Sets the AllowedValue attribute of the iSkip'th subelement Value
*
* @param value value to set the attribute to
*/
public void appendValueAllowedValue(final String value)
{
final JDFValue e = (JDFValue) appendElement(ElementName.VALUE, null);
e.setAllowedValue(value);
}
/**
* Gets the AllowedValue attribute of the iSkip'th subelement Value
*
* @param iSkip the number of Value elements to skip
* @return String: the attribute value
*/
public final String getValueAllowedValue(final int iSkip)
{
final JDFValue e = (JDFValue) getElement(ElementName.VALUE, null, iSkip);
if (e == null)
return null;
return e.getAllowedValue();
}
/**
* Sets the ValueUsage attribute of the i-th subelement Value
*
* @param int iSkip: the number of Value elements to skip
* @param EnumFitsValue value: value to set the attribute to
*/
public void setValueValueUsage(final int iSkip, final EnumFitsValue value)
{
final JDFValue e = (JDFValue) getElement(ElementName.VALUE, null, iSkip);
e.setValueUsage(EnumValueUsage.getEnum(value.getName()));
}
/**
* Gets the value of attribute ValueUsage of the iSkip'th subelement Value
*
* @param iSkip the number of Value elements to skip
* @return EnumFitsValue: the attribute value
*/
public final EnumFitsValue getValueValueUsage(final int iSkip)
{
final JDFValue e = (JDFValue) getElement(ElementName.VALUE, null, iSkip);
return EnumFitsValue.getEnum(e.getValueUsage().getName());
}
/*
* (non-Javadoc)
*
* @see org.cip4.jdflib.resource.devicecapability.JDFAbstractState#addValue(java .lang.String, org.cip4.jdflib.datatypes.JDFBaseDataTypes.EnumFitsValue)
*/
@Override
public void addValue(final String value, final EnumFitsValue testlists)
{
if (fitsValue(value, testlists))
return;
if (testlists == null || EnumFitsValue.Allowed.equals(testlists))
{
final JDFValue v = appendValue();
v.setAllowedValue(value);
if (testlists != null)
v.setValueUsage(EnumValueUsage.Allowed);
}
if (EnumFitsValue.Present.equals(testlists))
{
final JDFValue v = appendValue();
v.setAllowedValue(value);
if (testlists != null)
v.setValueUsage(EnumValueUsage.Present);
}
}
/*
* // FitsValue Methods
*/
/**
* fitsValue - checks whether value matches the Allowed/Present test lists specified for this State
*
* @param value value to test
* @param testlists the test lists the value has to match. In this State the test lists are ValueList AND ValueMod.
* Choose one of two values: FitsValue_Allowed or FitsValue_Present. (Defaults to Allowed)
*
* @return boolean - true, if value matches testlists or if AllowedValueList and AllowedValueMod are not specified
*/
@Override
public final boolean fitsValue(final String value, final EnumFitsValue testlists)
{
return (fitsLength(value, testlists) && fitsRegExp(value, testlists) && fitsValueElem(value, testlists));
}
/**
* fitsValueElem - checks whether str matches the subelement Value specified for this State
*
* @param str string to test
* @param valueusage switches between Allowed and Present configuration in subelement Value
*
* @return boolean - true, if str matches subelement Value or no corresponding value elements exist
*/
private final boolean fitsValueElem(final String str, final EnumFitsValue valuelist)
{
if (str == null)
return false;
final VElement v = getChildElementVector(ElementName.VALUE, null, null, true, 0, false);
final int siz = v.size();
boolean hasValue = false;
for (int i = 0; i < siz; i++)
{
final JDFValue elm = (JDFValue) v.elementAt(i);
if (elm.hasAttribute(AttributeName.VALUEUSAGE))
{
final EnumFitsValue valueUsage = getValueValueUsage(i);
if (valuelist.equals(valueUsage))
{
final String value = getValueAllowedValue(i);
hasValue = true;
if (str.equals(value))
return true; // we have found it
}
}
else
{
hasValue = true;
final String value = getValueAllowedValue(i);
if (str.equals(value))
return true; // we have found it
}
}
return !hasValue;
}
@Override
public void setAllowedLength(final JDFIntegerRange value)
{
super.setAllowedLength(value);
}
@Override
public JDFIntegerRange getAllowedLength()
{
return super.getAllowedLength();
}
@Override
public void setPresentLength(final JDFIntegerRange value)
{
super.setPresentLength(value);
}
@Override
public JDFIntegerRange getPresentLength()
{
return super.getPresentLength();
}
/*
* (non-Javadoc)
*
* @see org.cip4.jdflib.ifaces.ICapabilityElement#getEvaluationType()
*/
@Override
public EnumTerm getEvaluationType()
{
return EnumTerm.StringEvaluation;
}
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy