Package com.pullreports.model.config

Class ReportConfiguration.Builder

Object

com.pullreports.model.config.ReportConfiguration.Builder

Direct Known Subclasses:

ReportConfiguration.ReportConfigurationBuilder

Enclosing class:

ReportConfiguration

public static class ReportConfiguration.Builder
extends Object

A ReportConfiguration.Builder follows the builder pattern to create a new ReportConfiguration instance. Set required properties via the ReportConfiguration.Builder constructor and then use setter methods to set optional properties. The build() method returns a new ReportConfiguration instance.

Schema analog: <report>

Constructor Summary

Constructors

Constructor	Description
Builder(ReportId id, String name, TableConfiguration baseTableConfiguration)

Method Summary

Modifier and Type	Method	Description
ReportConfiguration	build()
protected final ReportId	getId()
protected final String	getName()
protected final TableConfiguration	getTableConfiguration()
ReportConfiguration.Builder	setAccessControlVoter(AccessControlVoter accessControlVoter)
ReportConfiguration.Builder	setDescription(String description)
ReportConfiguration.Builder	setExportConfiguration(ExportConfiguration exportConfiguration)	Sets the given ExportConfiguration and returns this builder reference.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(ReportId id,
 String name,
 TableConfiguration baseTableConfiguration)

Method Details

build

public ReportConfiguration build()

setDescription

public ReportConfiguration.Builder setDescription(String description)

setExportConfiguration

public ReportConfiguration.Builder setExportConfiguration(ExportConfiguration exportConfiguration)

Sets the given ExportConfiguration and returns this builder reference.

Parameters:

exportConfiguration - The ExportConfiguration to set.

Returns:

this builder reference.

Throws:

com.pullreports.model.config.ReportConfiguration.ReportConfigurationException - If one of the following conditions occur:

• The argument's ExportConfiguration.getDefaultColumns() references a missing or non-exportable ColumnConfiguration.
• The argument's Table.getPrimaryKeyColumnIds() references a missing ColumnConfiguration.
• The argument's ExportConfiguration.getDefaultSortTerms() references a missing ColumnConfiguration.
• The argument's ExportConfiguration.getKmlConfiguration() references a missing ColumnConfiguration.
• The argument's ExportConfiguration.getGeojsonConfiguration() references a missing ColumnConfiguration.

setAccessControlVoter

public ReportConfiguration.Builder setAccessControlVoter(AccessControlVoter accessControlVoter)

getId

protected final ReportId getId()

getName

protected final String getName()

getTableConfiguration

protected final TableConfiguration getTableConfiguration()