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.

Author:

s.meissner, m.hartmann

Constructor Summary

Constructors

Constructor and Description
XJdfBuilder() Default constructor.
XJdfBuilder(String jobID) Custom Constructor.
XJdfBuilder(String jobID, String category) Custom Constructor.
XJdfBuilder(String jobID, String category, String descriptiveName) Custom Constructor.
XJdfBuilder(String jobID, String category, String descriptiveName, String relatedJobID) Custom Constructor.
XJdfBuilder(XJDF xjdf) Custom Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAudit(Audit audit) Append Audit node to XJDF Document.
void	addComment(String comment) Append Comment to XJDF Document.
void	addGeneralID(GeneralID generalId) Append GeneralID node to XJDF Document.
void	addParameter(List<ParameterType> parameterTypes) Append Parameter list to xJdf Document.
void	addParameter(List<ParameterType> parameterTypes, String processUsage) Append Parameter List to xJdf Document.
void	addParameter(Parameter parameter) Append Parameter node to xJdf Document.
void	addParameter(Parameter parameter, String processUsage) Append Parameter node to xJdf Document.
void	addParameter(ParameterType parameterType) Append Parameter node to xJdf Document.
void	addParameter(ParameterType parameterType, Part part) Append Parameter node to xJdf Document.
void	addParameter(ParameterType parameterType, Part part, String processUsage) Append Parameter node to xJdf Document.
void	addParameter(ParameterType parameterType, String processUsage) Append Parameter node to xJdf Document.
void	addParameterSet(ParameterSet parameterSet) Add a parameterSet to the underlying xjdf.
void	addProduct(Product product) Append Product node to xJdf Document.
void	addResource(Resource resource, String processUsage) Append Resource node to xJdf Document.
Resource	addResource(ResourceType resourceType, Part part) Append Resource node to xJdf Document.
Resource	addResource(ResourceType resourceType, Part part, String processUsage) Append Resource node to xJdf Document.
void	addResourceSet(ResourceSet resourceSet) Add a resourceSet to the underlying xjdf.
XJDF	getXJdf() Getter for xJdf attribute.

Methods inherited from class org.cip4.lib.xjdf.builder.AbstractNodeBuilder

build, getNode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XJdfBuilder

public XJdfBuilder()

Default constructor.

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 Detail

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.

addAudit

public final void addAudit(Audit audit)

Append Audit node to XJDF Document.

Parameters:

audit - Audit object to append.

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.

addParameter

public final void addParameter(ParameterType parameterType)

Append Parameter node to xJdf Document.

Parameters:

parameterType - Parameter object to append.

addParameter

public final void addParameter(ParameterType parameterType,
                String processUsage)

Append Parameter node to xJdf Document.

Parameters:

parameterType - Parameter object to append.

processUsage - ProcessUsage of parameter.

addParameter

public final void addParameter(List<ParameterType> parameterTypes)

Append Parameter list to xJdf Document.

Parameters:

parameterTypes - Parameter objects to append.

addParameter

public final void addParameter(List<ParameterType> parameterTypes,
                String processUsage)

Append Parameter List to xJdf Document.

Parameters:

parameterTypes - Parameter objects to append.

processUsage - ProcessUsage of parameter.

addParameter

public final void addParameter(ParameterType parameterType,
                Part part)

Append Parameter node to xJdf Document.

Parameters:

parameterType - Parameter object to append.

part - Partitioning definitions.

addParameter

public void addParameter(ParameterType parameterType,
                Part part,
                String processUsage)

Append Parameter node to xJdf Document.

Parameters:

parameterType - Parameter object to append.

part - Partitioning definitions.

processUsage - ProcessUsage of parameter.

addParameter

public void addParameter(Parameter parameter)

Append Parameter node to xJdf Document.

Parameters:

parameter - Parameter node to append to.

addParameter

public final void addParameter(Parameter parameter,
                String processUsage)

Append Parameter node to xJdf Document.

Parameters:

parameter - Parameter node to append to.

processUsage - ProcessUsage of parameter.

addParameterSet

public final void addParameterSet(ParameterSet parameterSet)

Add a parameterSet to the underlying xjdf. TODO: Merge added sets with matching existing sets.

Parameters:

parameterSet - ParameterSet to add to the xjdf.

addResource

public final Resource addResource(ResourceType resourceType,
                   Part part)

Append Resource node to xJdf Document.

Parameters:

resourceType - Resource object to append.

part - Partitioning definitions.

Returns:

Resource that was added.

addResource

public final Resource addResource(ResourceType resourceType,
                   Part part,
                   String processUsage)

Append Resource node to xJdf Document.

Parameters:

resourceType - 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 - ParameterSet to add to the xjdf.