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 Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Define a joinNested classes/interfaces inherited from interface com.inet.report.adhoc.server.api.dataview.TemplateDataViewDefaults
TemplateDataViewDefaults.Column
-
Field Summary
Fields inherited from interface com.inet.report.adhoc.server.api.dataview.TemplateDataViewDefaults
ACCESS_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 Summary
ConstructorsConstructorDescriptionPersistenceTemplateDataViewDefaults
(@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 Summary
Modifier and TypeMethodDescription@Nonnull DataView
createDataView
(@Nonnull com.inet.report.Engine engine, @Nullable DataFilter filter) Create a DataView.boolean
AUTO-GENERATED@Nonnull DataViewAccessList
The groups and/or users that have access to this template.@Nonnull List<@Nonnull TemplateDataViewDefaults.Column>
The list of available columns.@Nullable String
Get a optional description, can be localized@Nonnull String
@Nonnull com.inet.id.GUID
getID()
Returns unique ID of the template.Get the saved properties from the template<T> @Nullable String
getString
(@Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<T> key) Get a default valueint
hashCode()
AUTO-GENERATEDMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.inet.report.adhoc.server.api.dataview.TemplateDataViewDefaults
applySpecialFormat, get, getDisplayName, getFilterSuggestions, hasAccess, setSelectionFormula
-
Constructor Details
-
PersistenceTemplateDataViewDefaults
public 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 namedescription
- optional descriptionaccessList
- the the user/groups with accessproperties
- the properties- Since:
- 25.4
-
-
Method Details
-
getID
@Nonnull public @Nonnull com.inet.id.GUID getID()Returns unique ID of the template.- Specified by:
getID
in interfaceTemplateDataViewDefaults
- 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:
getExtensionName
in interfacecom.inet.plugin.NamedExtension
-
getDescription
Get a optional description, can be localized- Specified by:
getDescription
in interfaceTemplateDataViewDefaults
- 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:
getString
in interfaceTemplateDataViewDefaults
-
getAccessList
The groups and/or users that have access to this template.- Specified by:
getAccessList
in interfaceTemplateDataViewDefaults
- Returns:
- user with permissions
-
getAvailableColumns
The list of available columns. It must contains minimum one field.- Specified by:
getAvailableColumns
in interfaceTemplateDataViewDefaults
- 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:
createDataView
in interfaceTemplateDataViewDefaults
- Parameters:
engine
- sub/main engine for a specific renderer formatfilter
- the saved filter definition- Returns:
- the DataView
-
hashCode
public int hashCode()AUTO-GENERATED -
equals
AUTO-GENERATED
-