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

Method Summary

Methods

Modifier and Type	Method and Description
XJdfBuilder	addGeneralID(GeneralID generalId) Append GeneralID node 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.
static XJdfBuilder	newInstance() Create and return a new instance of XJdfBuilder.
static XJdfBuilder	newInstance(String jobID) Create and return a new instance of XJdfBuilder which already contains values for attributes Category (='Web2Print') and JobID.
static XJdfBuilder	newInstance(String jobID, String category) Create and return a new instance of XJdfBuilder which already contains values for attributes Category, JobID.
static XJdfBuilder	newInstance(String jobID, String category, String descriptiveName) Create and return a new instance of XJdfBuilder which already contains values for attributes Category, JobID, DescriptiveName.
static XJdfBuilder	newInstance(String jobID, String category, String descriptiveName, String relatedJobID) Create and return a new instance of XJdfBuilder which already contains values for attributes Category, JobID, DescriptiveName and RelatedJobID.

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

Method Detail

newInstance

public static XJdfBuilder newInstance()

Create and return a new instance of XJdfBuilder.

Returns:

New XJdfBuilder instance.

newInstance

public static XJdfBuilder newInstance(String jobID)

Create and return a new instance of XJdfBuilder which already contains values for attributes Category (='Web2Print') and JobID.

Parameters:

jobID - Value of attribute JobID.

Returns:

New instance of XJDFBuilder which already contains values for defined attributes.

newInstance

public static XJdfBuilder newInstance(String jobID,
                      String category)

Create and return a new instance of XJdfBuilder which already contains values for attributes Category, JobID.

Parameters:

jobID - Value of attribute JobID.

category - Value of attribute Category.

Returns:

New instance of XJDFBuilder which already contains values for defined attributes.

newInstance

public static XJdfBuilder newInstance(String jobID,
                      String category,
                      String descriptiveName)

Create and return 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.

Returns:

New instance of XJDFBuilder which already contains values for defined attributes.

newInstance

public static XJdfBuilder newInstance(String jobID,
                      String category,
                      String descriptiveName,
                      String relatedJobID)

Create and return 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.

Returns:

New instance of XJDFBuilder which already contains values for defined attributes.

getXJdf

protected XJDF getXJdf()

Getter for xJdf attribute.

Returns:

the xJdf

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(ParameterType parameter,
                       Part part)

Append Parameter node to xJdf Document.

Parameters:

parameter - Parameter object to append.

part - Partitioning definitions.

Returns:

The current XJdfBuilder instance.