Package org.cip4.jdflib.jmf

Class JDFResourceInfo

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.JDFAutoResourceInfo
org.cip4.jdflib.jmf.JDFResourceInfo
All Implemented Interfaces:
Serializable, Cloneable, IAmountPoolContainer, IMatches, IStreamWriter, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo
public class JDFResourceInfo extends JDFAutoResourceInfo implements IAmountPoolContainer, IMatches
See Also:

  • Constructor Details

    • JDFResourceInfo

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

    • JDFResourceInfo

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

    • JDFResourceInfo

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

  • Method Details

    • createResourceInfo

      public static JDFResourceInfo createResourceInfo(JDFMessage parent, JDFResourceLink resourceLink, boolean copyResource)
      create a resourceInfo in parent based on resourceLink
      Parameters:
      parent -
      resourceLink -
      copyResource - if true, also copy the referenced resource
      Returns:

    • getTheElementInfo

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

    • toString

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

    • getCreateResource

      public JDFResource getCreateResource(String resName)
      get the resource defined by resName if null get the resource specified in @ResourceName
      Parameters:
      resName - name of the resource to get/create
      Returns:
      JDFCostCenter The element

    • getResource

      public JDFResource getResource(String resName)
      get resource defined by resName
      Parameters:
      resName - name of the resource to get
      Returns:
      JDFResource: the element

    • getResourceVector

      public VElement getResourceVector()
      get all resources
      Returns:
      VElement: the vector of resources

    • appendResource

      public JDFResource appendResource(String resName)
      append resource
      Parameters:
      resName - name of the resource to append, if null get the resource specified in @ResourceName
      Returns:

    • getUnknownElements

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

      default: getUnknownElements(true, 999999)

      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

    • getInvalidElements

      public VString getInvalidElements(JDFElement.EnumValidationLevel level, boolean bIgnorePrivate, int nMax)
      Method getInvalidElements

      default: GetInvalidElements(level, true, 999999)

      Overrides:
      getInvalidElements in class JDFElement
      Parameters:
      level - validation level
      bIgnorePrivate -
      nMax - maximum number of elements to get
      Returns:
      VString - vector of names of invalid elements

    • getPartMapArray

      public JDFAttributeMapArray getPartMapArray()
      get part map array
      Overrides:
      getPartMapArray in class JDFElement
      Returns:
      array of attribute, one for each part

    • getPartMapVector

      public VJDFAttributeMap getPartMapVector()
      get part map vector
      Specified by:
      getPartMapVector in interface IAmountPoolContainer
      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 defined 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 in 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

    • setLink

      public void setLink(JDFResourceLink resourceLink, boolean copyResource)
      fill a ResourceInfo from resourceLink
      Parameters:
      resourceLink -
      copyResource - if true, also copy the referenced resource

    • setLink

      public void setLink(JDFResourceLink resourceLink, JDFResourceQuParams rqp)
      sets all relevant parameters of this to the values specified in resourceLink or its linked resource or JDF node
      Parameters:
      resourceLink - the resourceLink to extract the information from
      rqp - parameters

    • setProcessUsage

      public void setProcessUsage(JDFNode.EnumProcessUsage processUsage)
      set ProcessUsage to the enum processusage
      Parameters:
      processUsage -

    • getProductID

      public String getProductID()
      if a Resource is available, return it's ProductID
      if no productID is available, return null
      Overrides:
      getProductID in class JDFAutoResourceInfo
      Returns:
      the value of the attribute
      See Also:

    • getResourceID

      public String getResourceID()
      if a Resource is available, return it's ID
      Overrides:
      getResourceID in class JDFAutoResourceInfo
      Returns:
      the value of the attribute
      See Also:

    • getResourceName

      public String getResourceName()
      if a Resource is available, return it's name, null if none is available
      Overrides:
      getResourceName in class JDFAutoResourceInfo
      Returns:
      the value of the attribute
      See Also:

    • getResStatus

      public JDFResource.EnumResStatus getResStatus()
      if a Resource is available, return it's status
      Overrides:
      getResStatus in class JDFAutoResourceInfo
      Returns:
      the value of the attribute
      See Also:

    • getLinkRoot

      public JDFResource getLinkRoot()
      getLinkRoot - gets the root resource of the target based on ResourceName, if available
      Specified by:
      getLinkRoot in interface IAmountPoolContainer
      Returns:
      JDFResource

    • setActualAmount

      public void setActualAmount(double value, JDFAttributeMap mPart)
      Set attribute ActualAmount in the AmountPool or in the link, depending on the value of mPart
      Parameters:
      value - the value to set ActualAmount to
      mPart - the part map of AmountPool/PartAmount

    • setAmount

      public void setAmount(double value, JDFAttributeMap mPart)
      setAmount in PartAmount or in this if partAmount=null
      Parameters:
      value - amount to set
      mPart - partition map to set amount for

    • setAmountPoolAttribute

      public void setAmountPoolAttribute(String attrib, String value, String nameSpaceURI, JDFAttributeMap mPart)
      sets the attribute occurence in the appropriate PartAmount when called for a resourceLink and creates the AmountPool and/or PartAmount if it is not yet there
      Parameters:
      attrib - the attribute name
      value - value to set in string form.
      nameSpaceURI - the XML-namespace
      mPart - defines which part of this ResourceLink the Amount belongs to, if empty set the ResourceLink root attribute
      Throws:
      JDFException - when called directly on a PartAmount
      Since:
      071103

    • setAmountPoolAttribute

      public void setAmountPoolAttribute(String attrib, String value, String nameSpaceURI, VJDFAttributeMap vPart)
      sets the attribute occurence in the appropriate PartAmount when called for a resourceLink and creates the AmountPool and/or PartAmount(s) if they are not yet there
      Parameters:
      attrib - the attribute name
      value - value to set in string form.
      nameSpaceURI - the XML-namespace
      vPart - defines which part of this ResourceLink the Amount belongs to, if empty set the ResourceLink root attribute.
      Throws:
      JDFException - when called directly on a PartAmount
      Since:
      060630

    • getAmountPoolAttribute

      public String getAmountPoolAttribute(String attrib, String nameSpaceURI, JDFAttributeMap mPart, int iSkip)
      returns the attribute occurence in PartAmount, or the default in the ResourceLink
      Parameters:
      attrib - the attribute name
      nameSpaceURI - the XML-namespace
      mPart - defines which part of this ResourceLink the Amount belongs to. If empty get the ResourceLink root attribute.
      iSkip -
      Returns:
      value of attribute found, null if not available
      Since:
      071103

    • getAmountPoolAttribute

      public String getAmountPoolAttribute(String attrib, String nameSpaceURI, VJDFAttributeMap vPart)
      returns the attribute occurence in PartAmount, or the default in the ResourceLink
      Parameters:
      attrib - the attribute name
      nameSpaceURI - the XML-namespace
      vPart - defines which part of this ResourceLink the Amount belongs to. If null get the ResourceLink root attribute.
      Returns:
      value of attribute found, null if not available
      Since:
      071103

    • getAmountPoolDouble

      public double getAmountPoolDouble(String attName, JDFAttributeMap mPart)
      get the sum of all matching AmountPool/PartAmount/@attName as a double PartAmounts match if all attributes match those in PartAmount, i.e. mPart is a submap of the searche PartAmount elements
      Parameters:
      attName - the Attribute name , e.g Amount, ActualAmount
      mPart -
      Returns:
      double - the element
      Throws:
      JDFException - if the element can not be cast to double

    • getAmountPoolDouble

      public double getAmountPoolDouble(String attName, VJDFAttributeMap vPart)
      get the exactly matching AmountPool/PartAmount/@AttName as a double
      Parameters:
      attName -
      vPart -
      Returns:
      double -
      Throws:
      JDFException - if the element can not be cast to double

    • getAmountPoolSumDouble

      public double getAmountPoolSumDouble(String attName, VJDFAttributeMap vPart)
      Parameters:
      attName -
      vPart -
      Returns:

    • matches

      public boolean matches(Object subset)
      do i match a resource name, type or resourcequparams? if object==null; return true
      Specified by:
      matches in interface IMatches
      Parameters:
      subset - the object to filter against
      Returns:
      true if it matches
      See Also:

    • matchersRQP

      protected boolean matchersRQP(String resourceName, JDFResourceQuParams rqp)
      the matching against rqp is not completely implemented
      Parameters:
      resourceName -
      rqp -
      Returns: