com.goldencode.p2j.persist

Class DataSet.Builder

java.lang.Object

com.goldencode.p2j.persist.DataSet.Builder

Enclosing class:

DataSet

public static class DataSet.Builder
extends java.lang.Object

Builder class that helps construct a DataSet object statically, that is, using the DEFINE DATASET statement. It exposes a set of chaining methods that take each option parameters and set them into the DataSet being constructed. The chaining must finish with generate() to obtain the final DataSet object. Before returning, the generate() will do the final checks and register the object to be returned with the DataSetManager.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.ArrayList<java.lang.Runnable>	buildChain The build actions to perform.
private java.lang.Class<?>	definingType The defining type where this dataset is constructed.
private boolean	isNew This is a builder for a shared new DataSet.
private boolean	isShared This is a builder for a shared DataSet.
private java.lang.String	legacyName The legacy name of the DataSet.
private boolean	referenceOnly This is a reference of a DataSet defined in another procedure / class.
private DataSet	target The build dataset instance.

Constructor Summary

Constructors

Constructor and Description
Builder(java.lang.String legacyName, boolean isShared, boolean isNew) The constructor.

Method Summary

Modifier and Type	Method and Description
DataSet.Builder	addDataRelation(java.lang.String relName, boolean reposition, boolean nested, boolean fkHidden, boolean inactive, boolean recursive, Buffer parent, Buffer child, DataSet.FieldPair... relationFieldPairs) Configure a data relation.
DataSet.Builder	addParentIdRelation(java.lang.String relName, Buffer parentBuffer, Buffer childBuffer, java.lang.String parentIdField) This method chains a PARENT-ID-RELATION option to the DataSet builder.
DataSet.Builder	addParentIdRelation(java.lang.String relName, Buffer parentBuffer, Buffer childBuffer, java.lang.String parentIdField, java.lang.String[] parentFieldsBefore, java.lang.String[] parentFieldsAfter) This method chains a PARENT-ID-RELATION option to the DataSet builder.
DataSet.Builder	forBuffers(Buffer... bufs) Configures the set of buffers for the DataSet.
DataSet	generate() Validates and registers the DataSet to DataSetManager, making it valid.
DataSet.Builder	setDefiningType(java.lang.Class<?> type) Set the defining type where this dataset is constructed.
DataSet.Builder	setNamespacePrefix(java.lang.String prefix) Sets the ns prefix attribute.
DataSet.Builder	setNamespaceUri(java.lang.String namespace) Sets the namespace attribute.
DataSet.Builder	setReferenceOnly() Mark the DataSet as reference only.
DataSet.Builder	setSerializeHidden() Mark the DataSet's serialize-hidden attribute.
DataSet.Builder	setSerializeName(java.lang.String serName) Sets the serialize name attribute.
DataSet.Builder	setXmlNodeName(java.lang.String nodeName) Sets the name of the xml node attribute.
DataSet.Builder	setXmlNodeType(java.lang.String nodeType) Sets the xml node type attribute.

Methods inherited from class java.lang.Object

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

Field Detail

isShared

private final boolean isShared

This is a builder for a shared DataSet.

isNew

private final boolean isNew

This is a builder for a shared new DataSet.

legacyName

private final java.lang.String legacyName

The legacy name of the DataSet.

referenceOnly

private boolean referenceOnly

This is a reference of a DataSet defined in another procedure / class.

buildChain

private final java.util.ArrayList<java.lang.Runnable> buildChain

The build actions to perform.

target

private DataSet target

The build dataset instance.

definingType

private java.lang.Class<?> definingType

The defining type where this dataset is constructed.

Constructor Detail

Builder

public Builder(java.lang.String legacyName,
               boolean isShared,
               boolean isNew)

The constructor. Initialize the private final fields that will be used in the final step of the construction: to parametrize the registration of the DataSet.

Parameters:

legacyName - The legacy name of the DataSet.

isShared - This is a shared DataSet.

isNew - This is a new DataSet. Only in combination with isShared.

Method Detail

setDefiningType

public DataSet.Builder setDefiningType(java.lang.Class<?> type)

Set the defining type where this dataset is constructed.

Parameters:

type - The defining type.

Returns:

A reference of this object in order to help chaining.

setNamespaceUri

public DataSet.Builder setNamespaceUri(java.lang.String namespace)

Sets the namespace attribute. Corresponds to NAMESPACE-URI option from DEFINE DATASET statement.

Parameters:

namespace - The namespace for the DataSet to be constructed.

Returns:

A reference of this object in order to help chaining.

setNamespacePrefix

public DataSet.Builder setNamespacePrefix(java.lang.String prefix)

Sets the ns prefix attribute. Corresponds to NAMESPACE-PREFIX option from DEFINE DATASET statement.

Parameters:

prefix - The ns prefix for the DataSet to be constructed.

Returns:

A reference of this object in order to help chaining.

setXmlNodeName

public DataSet.Builder setXmlNodeName(java.lang.String nodeName)

Sets the name of the xml node attribute. Corresponds to XML-NODE-NAME option from DEFINE DATASET statement.

Parameters:

nodeName - The xml node name for the DataSet to be constructed.

Returns:

A reference of this object in order to help chaining.

setSerializeName

public DataSet.Builder setSerializeName(java.lang.String serName)

Sets the serialize name attribute. Corresponds to SERIALIZE-NAME option from DEFINE DATASET statement.

Parameters:

serName - The serialize name for the DataSet to be constructed.

Returns:

A reference of this object in order to help chaining.

setXmlNodeType

public DataSet.Builder setXmlNodeType(java.lang.String nodeType)

Sets the xml node type attribute. Corresponds to XML-NODE-TYPE option from DEFINE DATASET statement.

Parameters:

nodeType - The node type for the DataSet to be constructed.

Returns:

A reference of this object in order to help chaining.

setSerializeHidden

public DataSet.Builder setSerializeHidden()

Mark the DataSet's serialize-hidden attribute. Corresponds to SERIALIZE-HIDDEN option from DEFINE DATASET statement.

Returns:

A reference of this object in order to help chaining.

setReferenceOnly

public DataSet.Builder setReferenceOnly()

Mark the DataSet as reference only. Corresponds to REFERENCE-ONLY option from DEFINE DATASET statement.

Returns:

A reference of this object in order to help chaining.

forBuffers

public DataSet.Builder forBuffers(Buffer... bufs)

Configures the set of buffers for the DataSet. Corresponds to FOR option from DEFINE DATASET statement.

Parameters:

bufs - The set buffers for the DataSet to be constructed.

Returns:

A reference of this object in order to help chaining.

addDataRelation

public DataSet.Builder addDataRelation(java.lang.String relName,
                                       boolean reposition,
                                       boolean nested,
                                       boolean fkHidden,
                                       boolean inactive,
                                       boolean recursive,
                                       Buffer parent,
                                       Buffer child,
                                       DataSet.FieldPair... relationFieldPairs)

Configure a data relation. Corresponds to DATA-RELATION set of options from DEFINE DATASET statement.

Parameters:

relName - The relation name.

reposition - Specifies the relation mode as REPOSITION as opposed to the default SELECTION relation mode.

nested - If true, the child rows of a DataSet buffer are nested within their parent rows when writing a JSON representation of data or an XML representation of data or schema.

fkHidden - Specifies that foreign key fields in nested data relations are omitted when writing JSON or XML data, and that foreign key fields are optional in the XML Schema representation of the child table definition. If NESTED option is false, this option is ignored.

inactive - Setting this to true allows to have two relations between the same two DataSet temp-table buffers, but only have one relation active at a time.

recursive - Allows DataSet FILL method to load self-referencing elements.

parent - The parent buffer in this data-relation. This must be one of the buffers identified by the buffers added with forBuffers() above.

child - The child buffer in this data-relation. This must be one of the buffers identified by the buffers added with forBuffers() above.

relationFieldPairs - A set of field pairs (parent, child)*.

Returns:

A reference of this object in order to help chaining.

addParentIdRelation

public DataSet.Builder addParentIdRelation(java.lang.String relName,
                                           Buffer parentBuffer,
                                           Buffer childBuffer,
                                           java.lang.String parentIdField)

This method chains a PARENT-ID-RELATION option to the DataSet builder.

Parameters:

relName - A name for the data relation.

parentBuffer - The parent buffer.

childBuffer - The child buffer.

parentIdField - The field from child buffer of RECID type that points to a record in parent buffer.

Returns:

A reference of this object in order to help chaining.

addParentIdRelation

public DataSet.Builder addParentIdRelation(java.lang.String relName,
                                           Buffer parentBuffer,
                                           Buffer childBuffer,
                                           java.lang.String parentIdField,
                                           java.lang.String[] parentFieldsBefore,
                                           java.lang.String[] parentFieldsAfter)

This method chains a PARENT-ID-RELATION option to the DataSet builder.

Parameters:

relName - A name for the data relation.

parentBuffer - The parent buffer.

childBuffer - The child buffer.

parentIdField - The field from child buffer of RECID type that points to a record in parent buffer.

parentFieldsBefore - The list of fields from the parentBuffer temp-table record that are to be written to XML before any childBuffer temp-table records.

parentFieldsAfter - The list of fields from the parentBuffer temp-table record that are to be written to XML after all childBuffer temp-table records.

Returns:

A reference of this object in order to help chaining.

generate

public DataSet generate()

Validates and registers the DataSet to DataSetManager, making it valid.

Returns:

the parent DataSet.