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

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.

Method Summary

Methods

Modifier and Type	Method and Description
XJdfBuilder	addComment(String comment) Append Comment to XJDF Document.
XJdfBuilder	addGeneralID(GeneralID generalId) Append GeneralID node to xJdf Document.
XJdfBuilder	addParameter(List<ParameterType> parameters) Append Parameter List to xJdf Document.
XJdfBuilder	addParameter(ParameterType parameter) Append Parameter node to xJdf Document.
XJdfBuilder	addParameter(ParameterType parameter, Part part) Append Parameter node to xJdf Document.
XJdfBuilder	addProduct(Product product) Append Product node to xJdf Document.
protected 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.

Method Detail

getXJdf

protected XJDF getXJdf()

Getter for xJdf attribute.

Returns:

the xJdf

addComment

public XJdfBuilder addComment(String comment)

Append Comment to XJDF Document.

Parameters:

comment - Comment to append to.

Returns:

The current XJdfBuilder instance.

addGeneralID

public XJdfBuilder addGeneralID(GeneralID generalId)

Append GeneralID node to xJdf Document.

Parameters:

generalId - GeneralID object to append.

Returns:

The current XJdfBuilder instance.

addProduct

public XJdfBuilder addProduct(Product product)

Append Product node to xJdf Document.

Parameters:

product - Product object to append.

Returns:

The current XJdfBuilder instance.

addParameter

public XJdfBuilder addParameter(ParameterType parameter)

Append Parameter node to xJdf Document.

Parameters:

parameter - Parameter object to append.

Returns:

The current XJdfBuilder instance.

addParameter

public XJdfBuilder addParameter(List<ParameterType> parameters)

Append Parameter List to xJdf Document.

Parameters:

parameter - Parameter object to append.

Returns:

The current XJdfBuilder instance.

addParameter

public XJdfBuilder addParameter(ParameterType parameter,
                       Part part)

Append Parameter node to xJdf Document.

Parameters:

parameter - Parameter object to append.

part - Partitioning definitions.

Returns:

The current XJdfBuilder instance.