Package org.cip4.lib.xjdf.builder

Class XJdfBuilder

java.lang.Object
org.cip4.lib.xjdf.builder.AbstractNodeBuilder<XJDF>
org.cip4.lib.xjdf.builder.XJdfBuilder
public class XJdfBuilder extends AbstractNodeBuilder<XJDF>
Implementation of a XJdf builder class.

  • Constructor Details

    • XJdfBuilder

      public XJdfBuilder()

    • XJdfBuilder

      public XJdfBuilder(String jobID)
      Custom Constructor. Creates a new instance of XJdfBuilder which already contains values for attributes Category (='Web2Print') and JobID.
      Parameters:
      jobID - Value of attribute JobID.

    • XJdfBuilder

      public XJdfBuilder(String jobID, String category)
      Custom Constructor. Creates a new instance of XJdfBuilder which already contains values for attributes Category, JobID.
      Parameters:
      jobID - Value of attribute JobID.
      category - Value of attribute Category.

    • XJdfBuilder

      public XJdfBuilder(String jobID, String category, String descriptiveName)
      Custom Constructor. Creates a new instance of XJdfBuilder which already contains values for attributes Category, JobID, DescriptiveName.
      Parameters:
      jobID - Value of attribute JobID.
      category - Value of attribute Category.
      descriptiveName - Value of attribute DescriptiveName.

    • XJdfBuilder

      public XJdfBuilder(String jobID, String category, String descriptiveName, String relatedJobID)
      Custom Constructor. Creates a new instance of XJdfBuilder which already contains values for attributes Category, JobID, DescriptiveName and RelatedJobID.
      Parameters:
      jobID - Value of attribute JobID.
      category - Value of attribute Category.
      descriptiveName - Value of attribute DescriptiveName.
      relatedJobID - Value of attribute RelatedJobID.

    • XJdfBuilder

      public XJdfBuilder(XJDF xjdf)
      Custom Constructor. Creates a new instance of XJdfBuilder based on a existing XJDF Document.
      Parameters:
      xjdf - XJDF Document for modify.

  • Method Details

    • getXJdf

      public XJDF getXJdf()
      Getter for xJdf attribute.
      Returns:
      the xJdf

    • addComment

      public final void addComment(String comment)
      Append Comment to XJDF Document.
      Parameters:
      comment - Comment to append to.

    • addGeneralID

      public final void addGeneralID(GeneralID generalId)
      Append GeneralID node to XJDF Document.
      Parameters:
      generalId - GeneralID object to append.

    • addProduct

      public final void addProduct(Product product)
      Append Product node to xJdf Document.
      Parameters:
      product - Product object to append.

    • addAudit

      public final void addAudit(Audit audit)
      Append a Audit to the XJDF Document.
      Parameters:
      audit - The audit to be attended append.

    • addResource

      public final void addResource(SpecificResource specificResource)
      Append Resource node to xJdf Document.
      Parameters:
      specificResource - Resource object to append.

    • addResource

      public final void addResource(SpecificResource specificResource, String processUsage)
      Append Resource node to xJdf Document.
      Parameters:
      specificResource - Resource object to append.
      processUsage - ProcessUsage of resource.

    • addResource

      public final void addResource(List<SpecificResource> specificResources)
      Append Resource list to xJdf Document.
      Parameters:
      specificResources - Resource objects to append.

    • addResource

      public final void addResource(List<SpecificResource> specificResources, String processUsage)
      Append Resource List to xJdf Document.
      Parameters:
      specificResources - Resource objects to append.
      processUsage - ProcessUsage of resource.

    • addResource

      public final Resource addResource(SpecificResource specificResource, Part part)
      Append Resource node to xJdf Document.
      Parameters:
      specificResource - Resource object to append.
      part - Partitioning definitions.
      Returns:
      Resource that was added.

    • addResource

      public final Resource addResource(SpecificResource specificResource, Part part, String processUsage)
      Append Resource node to xJdf Document.
      Parameters:
      specificResource - Resource object to append.
      part - Partitioning definitions.
      processUsage - ProcessUsage of resource.
      Returns:
      Resource that was added.

    • addResource

      public void addResource(Resource resource, String processUsage)
      Append Resource node to xJdf Document.
      Parameters:
      resource - Resource node to append to.
      processUsage - ProcessUsage of resource.

    • addResourceSet

      public final void addResourceSet(ResourceSet resourceSet)
      Add a resourceSet to the underlying xjdf. TODO: Merge added sets with matching existing sets.
      Parameters:
      resourceSet - ResourceSet to add to the xjdf.