DataViewBuilder

Method Summary
DataViewBuilder	appendColumn(String dataSetAlias, String columnAlias, String defaultValue) Appends the specified runtime column with default value. The DataSet must have already been included and the alias cannot conflict with any other alias. Returns this.
DataViewBuilder	appendSystem(SystemDataView systemDataView, String systemAlias, String columnAlias) Joins the SystemView to this view on columnAlias. Use systemAlias in subsequent DataViewRecord.get calls to access the SystemDataView columns. For example, db.appendSystem(view,'sys','profileId') would be accessed by ${rec.get('sys','firstName')}. Note, this does not permit filtering on SystemDataView columns.
DataViewBuilder	concatColumn(String dataSetAlias, String column) Adds the column to the concatination sequence. Returns this.
DataViewBuilder	concatText(String text) Adds the text to the concatination sequence. Returns this.
DataViewBuilder	distinct(boolean distinct) Enable/disable distinct records and returns this.
DataViewBuilder	endConcat(String columnAlias) Ends the concatination sequence and adds the entire sequence referenced by columnAlias. Returns this.
DataViewCriteria	getCriteria(String dataSetAlias) Returns the criteria for the specified DataSet in view. Dataset with such alias must have already been included.
DataViewBuilder	includeColumn(String dataSetAlias, String column, String columnAlias) Includes the specified column. System columns must be aliased with a different name. The DataSet must have already been included. Returns this.
DataViewBuilder	includeColumns(String dataSetAlias) Includes all non system columns from the specified DataSet. The DataSet must have already been included. Returns this.
DataViewBuilder	includeDataSet(DataSet dataSet, String dataSetAlias) Includes the specified DataSet. Returns this.
DataViewBuilder	includeDataSet(String dataSet, String dataSetAlias) Includes the specified DataSet. Returns this.
DataViewBuilder	innerJoin(String leftDataSetAlias, String leftColumn, String rightDataSetAlias, String rightColumn) Creates an inner join (all from both DataSets that match) on the two DataSets and specified columns. Both DataSets must have already been included. Returns this.
DataViewBuilder	leftJoin(String leftDataSetAlias, String leftColumn, String rightDataSetAlias, String rightColumn) Creates a left join (all records from left and matching records from right) on the two DataSets and specified columns. Both DataSets must have already been included. Returns this.
DataViewBuilder	reset() Clears all settings so this builder can be re-used to create a new DataView and returns this.
DataViewBuilder	startConcat() Begins a column concatination sequence. After calling this method you must make one or more calls to concatColumn followed by endConcat. The DataSet must have already been included. Returns this.
DataView	toDataView(String name) Converts this builder to a DataView which can then be queried.
String	toString() Returns a description of this object.
DataViewBuilder	union() Constructs a union and returns this. Subsequent calls to this builder are now against the additional DataSets to be added to the union. Field names from all included views must be in the same order and of the same type.
DataViewBuilder	unionDistinct() Constructs a distinct union and returns this. Subsequent calls to this builder are now against the additional DataSets to be added to the union. Field names from all included views must be in the same order and of the same type.

Method Detail

---

DataViewBuilder appendColumn(String dataSetAlias, String columnAlias, String defaultValue)

Appends the specified runtime column with default value. The DataSet must have already been included and the alias cannot conflict with any other alias. Returns this.

Parameters:

• String   dataSetAlias Required parameter.
• String   columnAlias Required parameter.
• String   defaultValue Required parameter. Maximum allowed size of parameter: 20

Returns:  DataViewBuilder

Since: 09-29-2010

---

DataViewBuilder appendSystem(SystemDataView systemDataView, String systemAlias, String columnAlias)

Joins the SystemView to this view on columnAlias. Use systemAlias in subsequent DataViewRecord.get calls to access the SystemDataView columns. For example, db.appendSystem(view,'sys','profileId') would be accessed by ${rec.get('sys','firstName')}. Note, this does not permit filtering on SystemDataView columns.

Parameters:

• SystemDataView   systemDataView Required parameter.
• String   systemAlias Required parameter.
• String   columnAlias Required parameter.

Returns:  DataViewBuilder

Since: 10-26-2010

---

DataViewBuilder concatColumn(String dataSetAlias, String column)

Adds the column to the concatination sequence. Returns this.

Parameters:

• String   dataSetAlias Required parameter.
• String   column Required parameter.

Returns:  DataViewBuilder

Since: 09-29-2010

---

DataViewBuilder concatText(String text)

Adds the text to the concatination sequence. Returns this.

Parameters:

• String   text Required parameter.

Returns:  DataViewBuilder

Since: 09-29-2010

---

DataViewBuilder distinct(boolean distinct)

Enable/disable distinct records and returns this.

Parameters:

• boolean   distinct

Returns:  DataViewBuilder

Since: 09-29-2010

---

DataViewBuilder endConcat(String columnAlias)

Ends the concatination sequence and adds the entire sequence referenced by columnAlias. Returns this.

Parameters:

• String   columnAlias Required parameter.

Returns:  DataViewBuilder

Since: 09-29-2010

---

DataViewCriteria getCriteria(String dataSetAlias)

Returns the criteria for the specified DataSet in view. Dataset with such alias must have already been included.

Parameters:

• String   dataSetAlias  - DataSet alias in the dataview. Required parameter.

Returns:  DataViewCriteria

Since: 10-29-2010

---

DataViewBuilder includeColumn(String dataSetAlias, String column, String columnAlias)

Includes the specified column. System columns must be aliased with a different name. The DataSet must have already been included. Returns this.

Parameters:

• String   dataSetAlias Required parameter.
• String   column Required parameter.
• String   columnAlias Required parameter.

Returns:  DataViewBuilder

Since: 09-29-2010

---

DataViewBuilder includeColumns(String dataSetAlias)

Includes all non system columns from the specified DataSet. The DataSet must have already been included. Returns this.

Parameters:

• String   dataSetAlias Required parameter.

Returns:  DataViewBuilder

Since: 09-29-2010

---

DataViewBuilder includeDataSet(DataSet dataSet, String dataSetAlias)

Includes the specified DataSet. Returns this.

Parameters:

• DataSet   dataSet Required parameter.
• String   dataSetAlias Required parameter.

Returns:  DataViewBuilder

Since: 09-29-2010

---

DataViewBuilder includeDataSet(String dataSet, String dataSetAlias)

Includes the specified DataSet. Returns this.

Parameters:

• String   dataSet Required parameter.
• String   dataSetAlias Required parameter.

Returns:  DataViewBuilder

Since: 09-29-2010

---

DataViewBuilder innerJoin(String leftDataSetAlias, String leftColumn, String rightDataSetAlias, String rightColumn)

Creates an inner join (all from both DataSets that match) on the two DataSets and specified columns. Both DataSets must have already been included. Returns this.

Parameters:

• String   leftDataSetAlias Required parameter.
• String   leftColumn Required parameter.
• String   rightDataSetAlias Required parameter.
• String   rightColumn Required parameter.

Returns:  DataViewBuilder

Since: 09-29-2010

---

DataViewBuilder leftJoin(String leftDataSetAlias, String leftColumn, String rightDataSetAlias, String rightColumn)

Creates a left join (all records from left and matching records from right) on the two DataSets and specified columns. Both DataSets must have already been included. Returns this.

Parameters:

• String   leftDataSetAlias Required parameter.
• String   leftColumn Required parameter.
• String   rightDataSetAlias Required parameter.
• String   rightColumn Required parameter.

Returns:  DataViewBuilder

Since: 09-29-2010

---

DataViewBuilder reset()

Clears all settings so this builder can be re-used to create a new DataView and returns this.

Returns:  DataViewBuilder

Since: 09-29-2010

---

DataViewBuilder startConcat()

Begins a column concatination sequence. After calling this method you must make one or more calls to concatColumn followed by endConcat. The DataSet must have already been included. Returns this.

Returns:  DataViewBuilder

Since: 09-29-2010

---

DataView toDataView(String name)

Converts this builder to a DataView which can then be queried.

Parameters:

• String   name Required parameter.

Returns:  DataView

Since: 09-29-2010

---

String toString()

Returns a description of this object.

Returns:  String

Since: 10-05-2010

---

DataViewBuilder union()

Constructs a union and returns this. Subsequent calls to this builder are now against the additional DataSets to be added to the union. Field names from all included views must be in the same order and of the same type.

Returns:  DataViewBuilder

Since: 09-29-2010

---

DataViewBuilder unionDistinct()

Constructs a distinct union and returns this. Subsequent calls to this builder are now against the additional DataSets to be added to the union. Field names from all included views must be in the same order and of the same type.

Returns:  DataViewBuilder

Since: 10-19-2010