Package org.cip4.jdflib.jmf

Class JDFResourceCmdParams

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.JDFAutoResourceCmdParams
org.cip4.jdflib.jmf.JDFResourceCmdParams
All Implemented Interfaces:
Serializable, Cloneable, INodeIdentifiable, IStreamWriter, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo
public class JDFResourceCmdParams extends JDFAutoResourceCmdParams implements INodeIdentifiable
class that wraps a ResourceCmdParams element
See Also:

  • Constructor Details

    • JDFResourceCmdParams

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

    • JDFResourceCmdParams

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

    • JDFResourceCmdParams

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

  • Method Details

    • getTheElementInfo

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

    • toString

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

    • getCreateResource

      public JDFResource getCreateResource(String resName)
      get resource defined by resName, create if it doesn't exist
      Parameters:
      resName - name of the resource to get/create
      Returns:
      JDFResource the element

    • getResource

      public JDFResource getResource(String resName)
      get resource defined by resNam
      Parameters:
      resName - name of the resource to get, if null get the one and only resource
      Returns:
      JDFResource the element, null if none exists

    • appendResource

      public JDFResource appendResource(String resName)
      Append Resource
      Parameters:
      resName - name of the resource to append
      Returns:
      JDFResource the element

    • getUnknownElements

      public VString getUnknownElements(boolean bIgnorePrivate, int nMax)
      return the vector of unknown element nodenames

      default: GetInvalidElements(true, 999999)
      !!! Do not change the signature of this method

      Overrides:
      getUnknownElements in class JDFElement
      Parameters:
      bIgnorePrivate - used by JDFElement during the validation
      nMax - maximum number of elements to get
      Returns:
      Vector - vector of unknown element nodenames

    • getPartMapVector

      public VJDFAttributeMap getPartMapVector()
      get part map vector
      Overrides:
      getPartMapVector in class JDFElement
      Returns:
      VJDFAttributeMap: vector of attribute maps, one for each part

    • setPartMapVector

      public void setPartMapVector(VJDFAttributeMap vParts)
      set all parts to those defined by vParts
      Overrides:
      setPartMapVector in class JDFElement
      Parameters:
      vParts - vector of attribute maps for the parts

    • setPartMap

      public void setPartMap(JDFAttributeMap mPart)
      set all parts to those define by mPart
      Overrides:
      setPartMap in class JDFElement
      Parameters:
      mPart - attribute map for the part to set

    • removePartMap

      public void removePartMap(JDFAttributeMap mPart)
      remove the part defined by mPart
      Overrides:
      removePartMap in class JDFElement
      Parameters:
      mPart - attribute map for the part to remove

    • hasPartMap

      public boolean hasPartMap(JDFAttributeMap mPart)
      check whether the part defined in mPart is included
      Overrides:
      hasPartMap in class JDFElement
      Parameters:
      mPart - attribute map to look for
      Returns:
      boolean - returns true if the part exists

    • applyResourceCommand

      public void applyResourceCommand(JDFNode parentNode)
      apply the parameters in this to all appropriate resources in parentNode or one of parentNode's children if no matching resource exists in the node, Usage MUST be set in this JDFResourceCmdParams, otherwise it is not possible to correctly link the newly created resource
      Parameters:
      parentNode - the node to search in

    • getIdentifier

      public NodeIdentifier getIdentifier()
      gets the NodeIdetifier that matches this
      Specified by:
      getIdentifier in interface INodeIdentifiable
      Returns:
      NodeIdentifier the matching NodeIdentifier

    • setUsage

      public void setUsage(JDFResourceLink.EnumUsage enumVar)
      (5) set attribute Usage
      Overrides:
      setUsage in class JDFAutoResourceCmdParams
      Parameters:
      enumVar - the enumVar to set the attribute to

    • getUsage

      public JDFResourceLink.EnumUsage getUsage()
      (9) get attribute Usage
      Overrides:
      getUsage in class JDFAutoResourceCmdParams
      Returns:
      the value of the attribute

    • setIdentifier

      public void setIdentifier(NodeIdentifier ni)
      Specified by:
      setIdentifier in interface INodeIdentifiable
      Parameters:
      ni -
      See Also:

    • getResource

      public JDFResource getResource()
      Description copied from class: JDFAutoResourceCmdParams
      (24) const get element Resource
      Overrides:
      getResource in class JDFAutoResourceCmdParams
      Returns:
      JDFResource the element

    • getCreateResource

      public JDFResource getCreateResource()
      Description copied from class: JDFAutoResourceCmdParams
      (25) getCreateResource
      Overrides:
      getCreateResource in class JDFAutoResourceCmdParams
      Returns:
      JDFResource the element