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 newReportConfiguration
instance. Set required properties via the ReportConfiguration.Builder constructor and then use setter methods to set optional properties. Thebuild()
method returns a new ReportConfiguration instance.Schema analog: <report>
-
-
Constructor Summary
Constructors Constructor Description Builder(ReportId id, String name, TableConfiguration baseTableConfiguration)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ReportConfiguration
build()
protected ReportId
getId()
protected String
getName()
protected TableConfiguration
getTableConfiguration()
ReportConfiguration.Builder
setAccessControlVoter(AccessControlVoter accessControlVoter)
ReportConfiguration.Builder
setDescription(String description)
ReportConfiguration.Builder
setExportConfiguration(ExportConfiguration exportConfiguration)
Sets the givenExportConfiguration
and returns this builder reference.
-
-
-
Constructor Detail
-
Builder
public Builder(ReportId id, String name, TableConfiguration baseTableConfiguration)
-
-
Method Detail
-
build
public ReportConfiguration build()
-
setDescription
public ReportConfiguration.Builder setDescription(String description)
-
setExportConfiguration
public ReportConfiguration.Builder setExportConfiguration(ExportConfiguration exportConfiguration)
Sets the givenExportConfiguration
and returns this builder reference.- Parameters:
exportConfiguration
- TheExportConfiguration
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-exportableColumnConfiguration
. - The argument's
Table.getPrimaryKeyColumnIds()
references a missingColumnConfiguration
. - The argument's
ExportConfiguration.getDefaultSortTerms()
references a missingColumnConfiguration
. - The argument's
ExportConfiguration.getKmlConfiguration()
references a missingColumnConfiguration
. - The argument's
ExportConfiguration.getGeojsonConfiguration()
references a missingColumnConfiguration
.
- The argument's
-
setAccessControlVoter
public ReportConfiguration.Builder setAccessControlVoter(AccessControlVoter accessControlVoter)
-
getId
protected final ReportId getId()
-
getName
protected final String getName()
-
getTableConfiguration
protected final TableConfiguration getTableConfiguration()
-
-