Package org.cip4.jdflib.resource.devicecapability

Class JDFEvaluation

    • Constructor Detail

      • JDFEvaluation

        public JDFEvaluation​(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                     java.lang.String qualifiedName)
        constructor for JDFEvaluation
        Parameters:
        myOwnerDocument -
        qualifiedName -

      • JDFEvaluation

        public JDFEvaluation​(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                     java.lang.String myNamespaceURI,
                     java.lang.String qualifiedName)
        constructor for JDFEvaluation
        Parameters:
        myOwnerDocument -
        myNamespaceURI -
        qualifiedName -

      • JDFEvaluation

        public JDFEvaluation​(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                     java.lang.String myNamespaceURI,
                     java.lang.String qualifiedName,
                     java.lang.String myLocalName)
        constructor for JDFEvaluation
        Parameters:
        myOwnerDocument -
        myNamespaceURI -
        qualifiedName -
        myLocalName -

    • Method Detail

      • toString

        public java.lang.String toString()
        toString
        Overrides:
        toString in class KElement
        Returns:
        String
        See Also:
        Object.toString()

      • fitsMap

        public final boolean fitsMap​(JDFAttributeMap m)
        fitsMap - tests whether attribute map 'm' has a key specified by BasicPreflightTest/@Name. If this the case, it is checked whether its value fits the testlist.
        Specified by:
        fitsMap in class JDFTerm
        Parameters:
        m - key-value pair attribute map to take the value from
        Returns:
        boolean - true, if 'm' has a key specified by BasicPreflightTest/@Name and fitsValue(value) returns true

      • fitsJDF

        public boolean fitsJDF​(KElement jdf,
                       KElement reportRoot)
        fitsJDF - tests whether JDFNode 'jdf' can be accepted by the Device. Tests if the value of resource attribute, decribed with this Evaluation, fits Evaluation/@ValueList
        Specified by:
        fitsJDF in class JDFTerm
        Parameters:
        jdf - jdf node to test
        reportRoot - the report to generate; set to null if no report is requested
        Returns:
        boolean - true, if 'jdf' can be accepted by the Device

      • fitsValue

        public abstract boolean fitsValue​(java.lang.String value)
        fitsValue - checks whether the value matches the testlists specified for this Evaluation
        Parameters:
        value - value to test
        Returns:
        boolean - true, if the value matches testlists or if testlists are not specified

      • fitsValue

        public boolean fitsValue​(KElement elem)
        fitsValue - checks whether elem matches the testlists specified for this Evaluation
        Parameters:
        elem - element to test
        Returns:
        boolen - true, if the value matches testlists or if testlists are not specified

      • getListType

        public JDFAutoBasicPreflightTest.EnumListType getListType()
        gets the ListType from a corresponding State/BasicPreflightTest element
        Returns:
        JDFBasicPreflightTest::EnumListType - the value of ListType attribute

      • getEvalXPath

        protected java.lang.String getEvalXPath​(KElement jdf)
        gets the XPath to the attributes of a given JDF node
        Parameters:
        jdf - JDF node to test
        Returns:
        String - the XPath to the attributes

      • getRefTargetNamePath

        public java.lang.String getRefTargetNamePath()
        getRefTargetNamePath()
        Returns:
        String

      • getRefTargetName

        public java.lang.String getRefTargetName()
        getRefTargetName()
        Returns:
        String

      • setRefTarget

        public void setRefTarget​(JDFElement e)
        setRefTarget() set the target referencened in @rRef
        Parameters:
        e -

      • getRefTarget

        public ICapabilityElement getRefTarget()
        getRefTarget() get the target referencened in @rRef
        Returns:
        ICapabilityElement the referenced element, either state or a devcap

      • getState

        public JDFAbstractState getState()
        getState()
        Returns:
        JDFAbstractState

      • setrRef

        public void setrRef​(java.lang.String value)
        Sets String attribute rRef
        Since rRef is independent of the data type of the State element, the setter is defined here
        Parameters:
        value - the value to set the attribute to

      • getrRef

        public java.lang.String getrRef()
        Gets String attribute rRef
        Since rRef is independent of the data type of the State element,the getter is defined here
        Returns:
        String: the attribute value

      • setPath

        public void setPath​(java.lang.String value)
        Sets String attribute rRef
        Since rRef is independent of the data type of the State element, the setter is defined here
        Parameters:
        value - the value to set the attribute to

      • getPath

        public java.lang.String getPath()
        Gets String attribute Path
        Returns:
        String: the attribute value

      • getCreateBasicPreflightTest

        public JDFBasicPreflightTest getCreateBasicPreflightTest()
        Get element BasicPreflightTest. Creates it if it doesn't exist

        default: getCreateBasicPreflightTest(0

        Returns:
        JDFBasicPreflightTest: the matching element

      • getCreateBasicPreflightTest

        @Deprecated
public JDFBasicPreflightTest getCreateBasicPreflightTest​(int iSkip)
        Deprecated.
        use getCreateBasicPreflightTest()
        Gets the iSkip-th element BasicPreflightTest. If doesn't exist, creates it

        default getCreateBasicPreflightTest(0)

        Parameters:
        iSkip - number of elements to skip
        Returns:
        JDFBasicPreflightTest: the matching element

      • getBasicPreflightTest

        public JDFBasicPreflightTest getBasicPreflightTest()
        Gets element BasicPreflightTest
        Returns:
        JDFBasicPreflightTest: the matching element or null

      • getBasicPreflightTest

        @Deprecated
public JDFBasicPreflightTest getBasicPreflightTest​(int iSkip)
        Deprecated.
        use getBasicPreflightTest()
        Gets the iSkip'th element BasicPreflightTest

        default: getBasicPreflightTest(0)

        Parameters:
        iSkip - number of elements to skip
        Returns:
        JDFBasicPreflightTest: the matching element or null

      • appendBasicPreflightTest

        @Deprecated
public JDFBasicPreflightTest appendBasicPreflightTest()
        Deprecated.
        use appendBasicPreflightTest(name)
        Appends element BasicPreflightTest to the end of this
        Returns:
        JDFBasicPreflightTest: newly created BasicPreflightTest element

      • appendBasicPreflightTest

        public JDFBasicPreflightTest appendBasicPreflightTest​(java.lang.String testName)
        Appends element BasicPreflightTest to the end of this and sets @Name to name
        Parameters:
        testName - the new Name attribute of the BasicPreflightTest
        Returns:
        JDFBasicPreflightTest: newly created BasicPreflightTest element

      • getTolerance

        protected JDFXYPair getTolerance()
        tolerance is defined in all numeric evaluations - implement here!
        Returns: