Class PersistenceTemplateDataViewDefaults
java.lang.Object
com.inet.report.adhoc.server.api.dataview.PersistenceTemplateDataViewDefaults
- All Implemented Interfaces:
- com.inet.plugin.NamedExtension,- TemplateDataViewDefaults
@JsonData
public class PersistenceTemplateDataViewDefaults
extends Object
implements TemplateDataViewDefaults
A TemplateDataViewDefaults that can be saved in the persistence.
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classDefine a joinNested classes/interfaces inherited from interface com.inet.report.adhoc.server.api.dataview.TemplateDataViewDefaultsTemplateDataViewDefaults.Column
- 
Field SummaryFields inherited from interface com.inet.report.adhoc.server.api.dataview.TemplateDataViewDefaultsACCESS_LIST_KEY, CHART_CATEGORY, CHART_DATA_FIELDS, CROSSTAB_COLUMNS, CROSSTAB_DATA, CROSSTAB_GROUPS, CROSSTAB_ROWS, FILTER_DEFINITION, TABLE_COLUMNS, TABLE_GROUPS, TABLE_SORTING, TEMPLATESOURCE_COLUMNS_KEY, TEMPLATESOURCE_DATASOURCE, TEMPLATESOURCE_JOINS_KEY, TEMPLATESOURCE_KEY, TEMPLATESOURCE_TABLES_KEY
- 
Constructor SummaryConstructorsConstructorDescriptionPersistenceTemplateDataViewDefaults(@Nonnull com.inet.id.GUID id, @Nonnull String name, String description, @Nonnull DataViewAccessList accessList, @Nonnull Map<com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<?>, String> properties) Create the saved defaults of a data view.
- 
Method SummaryModifier and TypeMethodDescription@Nonnull DataViewcreateDataView(@Nonnull com.inet.report.Engine engine, @Nullable DataFilter filter) Create a DataView.booleanAUTO-GENERATED@Nonnull DataViewAccessListThe groups and/or users that have access to this template.@Nonnull List<@Nonnull TemplateDataViewDefaults.Column>The list of available columns.@Nullable StringGet a optional description, can be localized@Nonnull String@Nonnull com.inet.id.GUIDgetID()Returns unique ID of the template.Get the saved properties from the template<T> @Nullable StringgetString(@Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<T> key) Get a default valueinthashCode()AUTO-GENERATEDMethods inherited from class java.lang.Objectclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.inet.report.adhoc.server.api.dataview.TemplateDataViewDefaultsapplySpecialFormat, get, getDisplayName, getFilterSuggestions, hasAccess, setSelectionFormula
- 
Constructor Details- 
PersistenceTemplateDataViewDefaultspublic PersistenceTemplateDataViewDefaults(@Nonnull @Nonnull com.inet.id.GUID id, @Nonnull @Nonnull String name, String description, @Nonnull @Nonnull DataViewAccessList accessList, @Nonnull @Nonnull Map<com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<?>, String> properties) Create the saved defaults of a data view. In the properties you can use the follow keys:for all components - TEMPLATESOURCE_KEY
- FILTER_DEFINITION
 - TABLE_COLUMNS
- TABLE_GROUPS
- TABLE_SORTING
 - CROSSTAB_COLUMNS
- CROSSTAB_ROWS
- CROSSTAB_DATA
- CROSSTAB_GROUPS
 - CHART_CATEGORY
- CHART_DATA_FIELDS
 - Parameters:
- id- ID of the template, which is used as save key.
- name- the unique display name
- description- optional description
- accessList- the the user/groups with access
- properties- the properties
- Since:
- 25.4
 
 
- 
- 
Method Details- 
getID@Nonnull public @Nonnull com.inet.id.GUID getID()Returns unique ID of the template.- Specified by:
- getIDin interface- TemplateDataViewDefaults
- Returns:
- uniqueID of the template.
 
- 
getProperties@Nonnull public @Nonnull Map<com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<?>,String> getProperties()Get the saved properties from the template- Returns:
- the properties
- Since:
- 25.4
 
- 
getExtensionName- Specified by:
- getExtensionNamein interface- com.inet.plugin.NamedExtension
 
- 
getDescriptionGet a optional description, can be localized- Specified by:
- getDescriptionin interface- TemplateDataViewDefaults
- Returns:
- the description
 
- 
getString@Nullable public <T> @Nullable String getString(@Nonnull @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<T> key) Get a default value- Specified by:
- getStringin interface- TemplateDataViewDefaults
 
- 
getAccessListThe groups and/or users that have access to this template.- Specified by:
- getAccessListin interface- TemplateDataViewDefaults
- Returns:
- user with permissions
 
- 
getAvailableColumnsThe list of available columns. It must contains minimum one field.- Specified by:
- getAvailableColumnsin interface- TemplateDataViewDefaults
- Returns:
- the columns
 
- 
createDataView@Nonnull public @Nonnull DataView createDataView(@Nonnull @Nonnull com.inet.report.Engine engine, @Nullable @Nullable DataFilter filter) Create a DataView. This means to add data definition to the given Engine- Specified by:
- createDataViewin interface- TemplateDataViewDefaults
- Parameters:
- engine- sub/main engine for a specific renderer format
- filter- the saved filter definition
- Returns:
- the DataView
 
- 
hashCodepublic int hashCode()AUTO-GENERATED
- 
equalsAUTO-GENERATED
 
-