Package org.cip4.jdflib.resource.devicecapability

Class JDFDevCap

java.lang.Object
org.apache.xerces.dom.NodeImpl
org.apache.xerces.dom.ChildNode
org.apache.xerces.dom.ParentNode
org.apache.xerces.dom.ElementImpl
org.apache.xerces.dom.ElementNSImpl
org.cip4.jdflib.core.KElement
org.cip4.jdflib.core.JDFElement
org.cip4.jdflib.auto.JDFAutoDevCap
org.cip4.jdflib.resource.devicecapability.JDFDevCap
All Implemented Interfaces:
Serializable, Cloneable, ICapabilityElement, IStreamWriter, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo
public class JDFDevCap extends JDFAutoDevCap implements ICapabilityElement
See Also:

  • Constructor Details

    • JDFDevCap

      public JDFDevCap(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String qualifiedName)
      Constructor for JDFDevCap
      Parameters:
      myOwnerDocument -
      qualifiedName -

    • JDFDevCap

      public JDFDevCap(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName)
      Constructor for JDFDevCap
      Parameters:
      myOwnerDocument -
      myNamespaceURI -
      qualifiedName -

    • JDFDevCap

      public JDFDevCap(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName, String myLocalName)
      Constructor for JDFDevCap
      Parameters:
      myOwnerDocument -
      myNamespaceURI -
      qualifiedName -
      myLocalName -

  • Method Details

    • getTheElementInfo

      protected ElementInfo getTheElementInfo()
      Overrides:
      getTheElementInfo in class JDFAutoDevCap
      Returns:
      the elementinfo

    • getTheAttributeInfo

      protected AttributeInfo getTheAttributeInfo()
      Overrides:
      getTheAttributeInfo in class JDFAutoDevCap
      Returns:

    • toString

      public String toString()
      toString()
      Overrides:
      toString in class KElement
      Returns:
      String
      See Also:

    • init

      public boolean init()
      all devcap elements should have an id
      Overrides:
      init in class JDFElement
      Returns:
      boolean true always
      See Also:

    • setDevCapRefs

      public void setDevCapRefs(VString value)
      set attribute DevCapRefs
      Overrides:
      setDevCapRefs in class JDFAutoDevCap
      Parameters:
      value - the value to set the attribute to

    • setID

      public void setID(String value)
      set attribute ID
      Overrides:
      setID in class JDFAutoDevCap
      Parameters:
      value - the value to set the attribute to

    • getID

      public String getID()
      get String attribute ID
      Overrides:
      getID in class JDFAutoDevCap
      Returns:
      String: the value of the attribute

    • getIDPrefix

      protected String getIDPrefix()
      Description copied from class: KElement
      getIDPrefix
      Overrides:
      getIDPrefix in class KElement
      Returns:
      the default ID prefix of non-overwritten JDF elements

    • getAvailability

      public JDFDeviceCap.EnumAvailability getAvailability()
      getAvailability - gets typesafe enumerated attribute Availability
      Specified by:
      getAvailability in interface ICapabilityElement
      Overrides:
      getAvailability in class JDFAutoDevCap
      Returns:
      EnumAvailability: the enumeration value of the attribute

    • getDevCap

      public JDFDevCap getDevCap(int iSkip)
      get iSkip'th element DevCap
      Parameters:
      iSkip - number of elements to skip (0 -> get first element)
      Returns:
      the value of the attribute

    • getCreateDevCap

      public JDFDevCap getCreateDevCap(int iSkip)
      get iSkip'th element DevCap, create if it doesn't exist
      Parameters:
      iSkip - number of elements to skip
      Returns:
      the value of the attribute

    • appendDevCap

      public JDFDevCap appendDevCap()
      append element DevCap
      Returns:
      the appended element

    • appendDevCapRefs

      public void appendDevCapRefs(JDFDevCap dc)
      append dc/@ID to the value of devCap/@ID
      Parameters:
      dc - the devCap to append

    • appendDevCapRefs

      public void appendDevCapRefs(String dcID)
      append dc/@ID to the value of devCap/@ID
      Parameters:
      dcID -

    • getBooleanState

      public JDFBooleanState getBooleanState(int iSkip)
      gets the iSkip'th existing BooleanState
      Parameters:
      iSkip - number of elements to skip (0 -> get first element)
      Returns:
      JDFBooleanState: the existing BooleanState

    • getBooleanState

      public JDFBooleanState getBooleanState(String nam)
      gets an existing BooleanState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended BooleanState
      Returns:
      JDFBooleanState: the existing BooleanState

    • getCreateBooleanState

      @Deprecated public JDFBooleanState getCreateBooleanState(int iSkip)
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • getCreateBooleanState

      public JDFBooleanState getCreateBooleanState(String nam)
      gets a NumberState with @Name="name", appends it if it does not exist
      Parameters:
      nam - the name attribute of the newly appended NumberState
      Returns:
      JDFNumberState: the existing or newly appended NumberState

    • appendBooleanState

      @Deprecated public JDFBooleanState appendBooleanState()
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • appendBooleanState

      public JDFBooleanState appendBooleanState(String nam)
      appends a BooleanState with @Name="name"
      Parameters:
      nam - the name attribute of the newly appended BooleanState
      Returns:
      JDFBooleanState: the newly appended BooleanState

    • getIntegerState

      public JDFIntegerState getIntegerState(int iSkip)
      gets the iSkip'th existing IntegerState
      Parameters:
      iSkip - number of elements to skip (0 -> get first element)
      Returns:
      JDFIntegerState: the existing IntegerState

    • getIntegerState

      public JDFIntegerState getIntegerState(String nam)
      gets an existing IntegerState with @Name="name"
      Parameters:
      nam - the name attribute of the newly appended IntegerState
      Returns:
      JDFIntegerState: the existing IntegerState

    • getCreateIntegerState

      @Deprecated public JDFIntegerState getCreateIntegerState(int iSkip)
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • getCreateIntegerState

      public JDFIntegerState getCreateIntegerState(String nam)
      gets an IntegerState with @Name="name", appends it if it does not yet exist
      Parameters:
      nam - the name attribute of the newly appended IntegerState
      Returns:
      JDFIntegerState: the existing or newly appended IntegerState

    • appendIntegerState

      public JDFIntegerState appendIntegerState()
      append an IntegerState with no name set
      Returns:
      JDFIntegerState: the newly appended IntegerState

    • appendIntegerState

      public JDFIntegerState appendIntegerState(String nam)
      appends an IntegerState with @Name="name"
      Parameters:
      name - the Name attribute of the newly appended IntegerState
      Returns:
      JDFIntegerState: the newly appended IntegerState

    • getNumberState

      public JDFNumberState getNumberState(int iSkip)
      gets the iSkip'th existing NumberState
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFNumberState: the existing NumberState

    • getNumberState

      public JDFNumberState getNumberState(String nam)
      gets an existing NumberState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended NumberState
      Returns:
      JDFNumberState: the existing NumberState

    • getCreateNumberState

      @Deprecated public JDFNumberState getCreateNumberState(int iSkip)
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • getCreateNumberState

      public JDFNumberState getCreateNumberState(String nam)
      gets a NumberState with @Name="name", appends it if it does not yet exist
      Parameters:
      nam - the Name attribute of the newly appended NumberState
      Returns:
      JDFNumberState: the existing or newly appended NumberState

    • appendNumberState

      public JDFNumberState appendNumberState(String nam)
      appends a NumberState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended NumberState
      Returns:
      JDFNumberState: the newly appended NumberState

    • appendNumberState

      @Deprecated public JDFNumberState appendNumberState()
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • getEnumerationState

      public JDFEnumerationState getEnumerationState(int iSkip)
      gets the iSkip'th existing EnumerationState
      Parameters:
      iSkip - number of elements to skip (0 -> get first element)
      Returns:
      JDFEnumerationState: the existing EnumerationState

    • getEnumerationState

      public JDFEnumerationState getEnumerationState(String nam)
      gets an existing EnumerationState with @Name="name"
      Parameters:
      name - the Name attribute of the newly appended EnumerationState
      Returns:
      JDFEnumerationState: the existing EnumerationState

    • getCreateEnumerationState

      @Deprecated public JDFEnumerationState getCreateEnumerationState(int iSkip)
      Deprecated.
      gets the iSkip'th existing EnumerationState, creates it if it doesn't exist
      Parameters:
      iSkip - number of elements to skip (0 -> get first element)
      Returns:
      JDFEnumerationState: the existing EnumerationState

    • getCreateEnumerationState

      public JDFEnumerationState getCreateEnumerationState(String nam)
      gets a EnumerationState with @Name="name", appends it if it does not exist
      Parameters:
      nam - the name attribute of the newly appended EnumerationState
      Returns:
      JDFEnumerationState the existing or newly appended EnumerationState

    • appendEnumerationState

      @Deprecated public JDFEnumerationState appendEnumerationState()
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • appendEnumerationState

      public JDFEnumerationState appendEnumerationState(String nam)
      appends a NumberState with @Name="name"
      Parameters:
      nam - the name attribute of the newly appended NumberState
      Returns:
      JDFNumberState: the newly appended NumberState

    • getNameState

      public JDFNameState getNameState(int iSkip)
      gets the iSkip'th existing NameState
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFNameState: the existing NameState

    • getNameState

      public JDFNameState getNameState(String nam)
      gets an existing NameState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended NameState
      Returns:
      JDFNameState: the existing NameState

    • getCreateNameState

      @Deprecated public JDFNameState getCreateNameState(int iSkip)
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • getCreateNameState

      public JDFNameState getCreateNameState(String nam)
      gets a NameState with @Name="name", appends it if it does not exist
      Parameters:
      nam - the name attribute of the newly appended NameState
      Returns:
      JDFNameState: the existing or newly appended NameState

    • appendNameState

      @Deprecated public JDFNameState appendNameState()
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • appendNameState

      public JDFNameState appendNameState(String nam)
      appends a NameState with @Name="name"
      Parameters:
      nam - the name attribute of the newly appended NameState
      Returns:
      JDFNameState: the newly appended NameState

    • getStringState

      public JDFStringState getStringState(int iSkip)
      gets the iSkip'th existing StringState
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFStringState: the existing StringState

    • getStringState

      public JDFStringState getStringState(String nam)
      gets an existing StringState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended StringState
      Returns:
      JDFStringState: the existing StringState

    • getCreateStringState

      @Deprecated public JDFStringState getCreateStringState(int iSkip)
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • getCreateStringState

      public JDFStringState getCreateStringState(String nam)
      gets a StringState with @Name="name", appends it if it does not yet exist
      Parameters:
      nam - the Name attribute of the newly appended StringState
      Returns:
      JDFStringState: the existing or newly appended StringState

    • appendStringState

      @Deprecated public JDFStringState appendStringState()
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • appendStringState

      public JDFStringState appendStringState(String nam)
      appends a StringState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended StringState
      Returns:
      JDFStringState: the newly appended StringState

    • getXYPairState

      public JDFXYPairState getXYPairState(int iSkip)
      gets the iSkip'th existing XYPairState
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFXYPairState: the existing XYPairState

    • getXYPairState

      public JDFXYPairState getXYPairState(String nam)
      gets an existing XYPairState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended XYPairState
      Returns:
      JDFXYPairState: the existing XYPairState

    • getCreateXYPairState

      @Deprecated public JDFXYPairState getCreateXYPairState(int iSkip)
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • getCreateXYPairState

      public JDFXYPairState getCreateXYPairState(String nam)
      gets a XYPairState with @Name="name", appends it if it does not yet exist
      Parameters:
      nam - the Name attribute of the newly appended XYPairState
      Returns:
      JDFXYPairState: the existing or newly appended XYPairState

    • appendXYPairState

      @Deprecated public JDFXYPairState appendXYPairState()
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • appendXYPairState

      public JDFXYPairState appendXYPairState(String nam)
      appends a XYPairState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended XYPairState
      Returns:
      JDFXYPairState: the newly appended XYPairState

    • getShapeState

      public JDFShapeState getShapeState(int iSkip)
      gets the iSkip'th existing ShapeState
      Parameters:
      iSkip - number of elements to skip (0 -> get first element)
      Returns:
      JDFShapeState the existing ShapeState

    • getShapeState

      public JDFShapeState getShapeState(String nam)
      gets an existing ShapeState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended ShapeState
      Returns:
      JDFShapeState: the existing ShapeState

    • getCreateShapeState

      @Deprecated public JDFShapeState getCreateShapeState(int iSkip)
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • getCreateShapeState

      public JDFShapeState getCreateShapeState(String nam)
      gets a ShapeState with @Name="name", appends it if it does not yet exist
      Parameters:
      nam - the Name attribute of the newly appended ShapeState
      Returns:
      JDFShapeState: the existing or newly appended ShapeState

    • appendShapeState

      @Deprecated public JDFShapeState appendShapeState()
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • appendShapeState

      public JDFShapeState appendShapeState(String nam)
      appends a ShapeState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended ShapeState
      Returns:
      JDFShapeState: the newly appended ShapeState

    • getMatrixState

      public JDFMatrixState getMatrixState(int iSkip)
      gets the iSkip'th existing MatrixState
      Parameters:
      iSkip - number of elements to skip (0 -> get first element)
      Returns:
      JDFMatrixState the existing MatrixState

    • getMatrixState

      public JDFMatrixState getMatrixState(String nam)
      gets an existing MatrixState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended MatrixState
      Returns:
      JDFMatrixState: the existing MatrixState

    • getCreateMatrixState

      @Deprecated public JDFMatrixState getCreateMatrixState(int iSkip)
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • getCreateMatrixState

      public JDFMatrixState getCreateMatrixState(String nam)
      gets a MatrixState with @Name="name", appends it if it does not yet exist
      Parameters:
      nam - the Name attribute of the newly appended MatrixState
      Returns:
      JDFMatrixState: the existing or newly appended MatrixState

    • appendMatrixState

      @Deprecated public JDFMatrixState appendMatrixState()
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • appendMatrixState

      public JDFMatrixState appendMatrixState(String nam)
      appends a MatrixState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended MatrixState
      Returns:
      JDFMatrixState: the newly appended MatrixState

    • getDateTimeState

      public JDFDateTimeState getDateTimeState(int iSkip)
      gets the iSkip'th existing DateTimeState
      Parameters:
      iSkip - number of elements to skip (0 -> get first element)
      Returns:
      JDFDateTimeState the existing DateTimeState

    • getDateTimeState

      public JDFDateTimeState getDateTimeState(String nam)
      gets an existing DateTimeState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended DateTimeState
      Returns:
      JDFDateTimeState: the existing DateTimeState

    • getCreateDateTimeState

      @Deprecated public JDFDateTimeState getCreateDateTimeState(int iSkip)
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • getCreateDateTimeState

      public JDFDateTimeState getCreateDateTimeState(String nam)
      gets a DateTimeState with @Name="name", appends it if it does not yet exist
      Parameters:
      nam - the Name attribute of the newly appended DateTimeState
      Returns:
      JDFDateTimeState: the existing or newly appended DateTimeState

    • appendDateTimeState

      @Deprecated public JDFDateTimeState appendDateTimeState()
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • appendDateTimeState

      public JDFDateTimeState appendDateTimeState(String nam)
      appends a DateTimeState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended DateTimeState
      Returns:
      JDFDateTimeState: the newly appended DateTimeState

    • getDurationState

      public JDFDurationState getDurationState(int iSkip)
      gets the iSkip'th existing DurationState
      Parameters:
      iSkip - number of elements to skip (0 -> get first element)
      Returns:
      JDFDurationState the existing DurationState

    • getDurationState

      public JDFDurationState getDurationState(String nam)
      gets an existing DurationState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended DurationState
      Returns:
      JDFDurationState: the existing DurationState

    • getCreateDurationState

      @Deprecated public JDFDurationState getCreateDurationState(int iSkip)
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • getCreateDurationState

      public JDFDurationState getCreateDurationState(String nam)
      gets a DurationState with @Name="name", appends it if it does not yet exist
      Parameters:
      nam - the Name attribute of the newly appended DurationState
      Returns:
      JDFDurationState: the existing or newly appended DurationState

    • appendDurationState

      @Deprecated public JDFDurationState appendDurationState()
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • appendDurationState

      public JDFDurationState appendDurationState(String nam)
      appends a DurationState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended DurationState
      Returns:
      JDFDurationState: the newly appended DurationState

    • getPDFPathState

      public JDFPDFPathState getPDFPathState(int iSkip)
      gets the iSkip'th existing PDFPathState
      Parameters:
      iSkip - number of elements to skip (0 -> get first element)
      Returns:
      JDFPDFPathState: the existing PDFPathState

    • getPDFPathState

      public JDFPDFPathState getPDFPathState(String nam)
      gets an existing PDFPathState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended PDFPathState
      Returns:
      JDFPDFPathState: the existing PDFPathState

    • getCreatePDFPathState

      @Deprecated public JDFPDFPathState getCreatePDFPathState(int iSkip)
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • getCreatePDFPathState

      public JDFPDFPathState getCreatePDFPathState(String nam)
      gets a PDFPathState with @Name="name", appends it if it does not yet exist
      Parameters:
      nam - the Name attribute of the newly appended PDFPathState
      Returns:
      JDFPDFPathState: the existing or newly appended PDFPathState

    • appendPDFPathState

      @Deprecated public JDFPDFPathState appendPDFPathState()
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • appendPDFPathState

      public JDFPDFPathState appendPDFPathState(String nam)
      appends a PDFPathState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended PDFPathState
      Returns:
      JDFPDFPathState: the newly appended PDFPathState

    • getRectangleState

      public JDFRectangleState getRectangleState(int iSkip)
      gets the iSkip'th existing RectangleState
      Parameters:
      iSkip - number of elements to skip (0 -> get first element)
      Returns:
      JDFRectangleState: the existing RectangleState

    • getRectangleState

      public JDFRectangleState getRectangleState(String nam)
      gets an existing RectangleState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended RectangleState
      Returns:
      JDFRectangleState: the existing RectangleState

    • getCreateRectangleState

      @Deprecated public JDFRectangleState getCreateRectangleState(int iSkip)
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • getCreateRectangleState

      public JDFRectangleState getCreateRectangleState(String nam)
      gets a RectangleState with @Name="name", appends it if it does not yet exist
      Parameters:
      nam - the Name attribute of the newly appended RectangleState
      Returns:
      JDFRectangleState: the existing or newly appended RectangleState

    • appendRectangleState

      @Deprecated public JDFRectangleState appendRectangleState()
      Deprecated.
      use method with parameter (string) instead
      Returns:

    • appendRectangleState

      public JDFRectangleState appendRectangleState(String nam)
      appends a RectangleState with @Name="name"
      Parameters:
      nam - the Name attribute of the newly appended RectangleState
      Returns:
      JDFRectangleState: the newly appended RectangleState

    • getDevCapVector

      public final VElement getDevCapVector(VElement devCaps, boolean bDirect)
      Gets of this the Vector of all direct child DevCap elements plus the referenced (by attribute DevCapRefs) reusable DevCap elements, that are located in DevCapPool
      Parameters:
      devCaps -
      bDirect -
      Returns:
      VElement - vector of all direct child DevCap elements plus the referenced reusable DevCap elements, that are located in DevCapPool.

    • stateReport

      public final KElement stateReport(KElement e, JDFBaseDataTypes.EnumFitsValue testlists, JDFElement.EnumValidationLevel level, boolean ignoreExtensions, boolean bRecurse, KElement parentReport)
      Tests if the attributes and subelements of the given element match the corresponding States and DevCap subelements of this DevCap.
      Composes a detailed report of the found errors in XML form. If XMLDoc equals null - there are no errors
      Parameters:
      e - element to test
      testlists - FitsValue_Allowed or FitsValue_Present testlists that are specified for the State elements. (Will be used in fitsValue method of the State element)
      level - validation level
      Returns:
      XMLDoc - XMLDoc output of the error messages. If XMLDoc is null there are no errors.
      Element e fits the corresponding States and DevCap subelements of this DevCap.

    • getNamePath

      public final String getNamePath(boolean bRecurse)
      Gets the NamePath of this DevCap in form "DevCapsName/SubelemName1/SubelemName2/..."
      If this DevCap is located in DevCapPool and not in a DevCaps - it describes the reusable resource and DevCap root will have the attribute "Name" = value of DevCaps/@Name, but will have no info about DevCaps/@Context or DevCaps/@LinkUsage

      default: getNamePath(false)

      Parameters:
      bRecurse - if true, returns "DevCapsName/SubelemName1/SubelemName2/..."
      Returns:
      String - NamePath of this DevCap

    • getNamePathVector

      public VString getNamePathVector()
      Specified by:
      getNamePathVector in interface ICapabilityElement
      Returns:

    • getNamePathVector

      public final VString getNamePathVector(boolean bRecurse)
      Gets the NamePath of this DevCap in form "DevCapsName/SubelemName1/SubelemName2/..."
      If this DevCap is located in DevCapPool and not in a DevCaps - it describes the reusable resource and DevCap root will have the attribute "Name" = value of DevCaps/@Name, but will have no info about DevCaps/@Context or DevCaps/@LinkUsage
      Parameters:
      bRecurse - if true, returns "DevCapsName/SubelemName1/SubelemName2/..."
      Returns:
      String - NamePath of this DevCap, null if no name is specified default: getNamePath(true)

    • getName

      public String getName()
      gets String attribute Name, inherits from devcap or devcaps if necessary
      Overrides:
      getName in class JDFAutoDevCap
      Returns:
      String - the value of the attribute

    • getStates

      public VElement getStates(boolean bDirect, String id)
      return the vector of all states
      Parameters:
      bDirect - if false, recurse into child elements, else return only direct child states
      id - ID attribute of the requested string
      Returns:
      VElement

    • setMaxOccurs

      public void setMaxOccurs(int value)
      Sets attribute MaxOccurs, also handles unbounded
      Overrides:
      setMaxOccurs in class JDFAutoDevCap
      Parameters:
      value - the value to set the attribute to

    • getMaxOccurs

      public int getMaxOccurs()
      Gets integer attribute MaxOccurs, also handles unbounded
      Overrides:
      getMaxOccurs in class JDFAutoDevCap
      Returns:
      int: the attribute value

    • getMatchingElementsFromParent

      public VElement getMatchingElementsFromParent(KElement parent, VElement vDevCap)
      gets the matching elements in the node that match this
      Parameters:
      node - the node to search in
      testValidity - if true, recusively check for validity of the elements, else only get children by name
      Returns:
      VElement - the element vector of matching elements, null if none were found

    • getAllMatchingElementsFromParent

      public VElement getAllMatchingElementsFromParent(KElement parent)
      gets the matching elements in the node that match the nodename of this
      Parameters:
      node - the node to search in
      Returns:
      VElement - the element vector of matching elements, null if none were found

    • setDefaultsFromCaps

      public boolean setDefaultsFromCaps(KElement element, boolean bAll)
      sets the element and attribute defaults
      Parameters:
      element - the element that is defaulted
      bAll - if false, only add if minOccurs>=1 and required=true or a default exists
      Returns:
      ignored

    • getInvalidAttributes

      public VString getInvalidAttributes(JDFElement.EnumValidationLevel level, boolean bIgnorePrivate, int nMax)
      Description copied from class: JDFElement
      get invalid attributes
      Overrides:
      getInvalidAttributes in class JDFElement
      Parameters:
      level - validation level
      bIgnorePrivate - if true, do not worry about attributes in other namespaces
      nMax - maximum size of the returned vector
      Returns:
      VString - a vector of invalid attribute names

    • getModulePool

      public JDFModulePool getModulePool()
      Description copied from interface: ICapabilityElement
      get the ModulePool that contains ModuleCap elements referenced by this
      Specified by:
      getModulePool in interface ICapabilityElement
      Returns:
      JDFModulePool the pool

    • getCreateModulePool

      public JDFModulePool getCreateModulePool()
      Description copied from interface: ICapabilityElement
      get the ModulePool that contains ModuleCap elements referenced by this create one, if it does not exist
      Specified by:
      getCreateModulePool in interface ICapabilityElement
      Returns:
      JDFModulePool the pool

    • getModuleAvailability

      public JDFDeviceCap.EnumAvailability getModuleAvailability()
      get the availability of this devcaps based on the list of installed modules in ModuleRefs and ModulePool
      Returns:

    • appendModuleRef

      public JDFModuleCap appendModuleRef(String id)
      Description copied from interface: ICapabilityElement
      append moduleRef to moduleRefs, if it does not exist, set the availability to module and ensure that the appropriate modulecap exists
      Specified by:
      appendModuleRef in interface ICapabilityElement
      Returns:
      JDFModuleCap the Modulecap that id refers tp

    • getEvaluationType

      public JDFTerm.EnumTerm getEvaluationType()
      Description copied from interface: ICapabilityElement
      get the type of evaluation that is appropriate for this ICapabilityElement
      Specified by:
      getEvaluationType in interface ICapabilityElement
      Returns:
      EnumTerm the type of evaluation