com.blazebit.persistence.view.ConfigurationProperties

public final class ConfigurationProperties
extends Object

Configuration properties that can be specified via EntityViewConfiguration.setProperty(String, String).

Since:: 1.0.6
Author:: Christian Beikov

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`CREATE_EMPTY_FLAT_VIEWS`	A boolean flag that allows to specify if empty flat views should be created by default if not specified via `EmptyFlatViewCreation`.
`static String`	`DEFAULT_BATCH_SIZE`	An integer value that defines the default batch size for entity view attributes.
`static String`	`EXPECT_BATCH_CORRELATION_VALUES`	A boolean specifying if correlation value batching is expected or view root batching.
`static String`	`EXPECT_BATCH_MODE`	A mode specifying if correlation value, view root or embedded view batching is expected.
`static String`	`EXPRESSION_VALIDATION_DISABLED`	A boolean flag to make it possible to disable the expression validation.
`static String`	`MANAGED_TYPE_VALIDATION_DISABLED`	A boolean flag to make it possible to disable the managed type validation.
`static String`	`PAGINATION_BOUNDED_COUNT`	The maximum value up to which the count query should count i.e. see `PaginatedCriteriaBuilder.withBoundedCount(long)`.
`static String`	`PAGINATION_DISABLE_COUNT_QUERY`	A boolean flag that allows to disable a count query for a paginated criteria builder.
`static String`	`PAGINATION_EXTRACT_ALL_KEYSETS`	A boolean flag that allows to enable the extraction of all keysets for a paginated criteria builder.
`static String`	`PAGINATION_FORCE_USE_KEYSET`	A boolean flag that allows to force the use of the keyset for a paginated criteria builder rather than relying on firstResult/maxResults.
`static String`	`PAGINATION_HIGHEST_KEYSET_OFFSET`	The offset from the maxResults at which to find the highest keyset i.e. the highest keyset will be at position `Math.min(size, maxResults - offset)`.
`static String`	`PROXY_EAGER_LOADING`	A boolean flag to make it possible to use the generated proxies with serialization.
`static String`	`PROXY_UNSAFE_ALLOWED`	A boolean flag to make it possible to disable unsafe proxy generation.
`static String`	`STATIC_BUILDER_SCANNING_DISABLED`	A boolean flag to make it possible to disable the scanning for static builders annotated with `StaticBuilder`.
`static String`	`STATIC_IMPLEMENTATION_SCANNING_DISABLED`	A boolean flag to make it possible to disable the scanning for static implementations annotated with `StaticImplementation`.
`static String`	`STATIC_METAMODEL_SCANNING_DISABLED`	A boolean flag to make it possible to disable the scanning for static metmodels annotated with `StaticMetamodel`.
`static String`	`TEMPLATE_EAGER_LOADING`	A boolean flag to make it possible to prepare all view template caches on startup.
`static String`	`UPDATER_DISALLOW_OWNED_UPDATABLE_SUBVIEW`	A boolean flag to make it possible to disable the strict validation that disallows the use of an updatable entity view type for owned relationships.
`static String`	`UPDATER_EAGER_LOADING`	A boolean flag to make it possible to prepare the entity view updater cache on startup.
`static String`	`UPDATER_ERROR_ON_INVALID_PLURAL_SETTER`	A boolean flag that allows to switch from warnings to boot time validation errors when invalid plural attribute setters are encountered while the strict cascading check is enabled.
`static String`	`UPDATER_FLUSH_MODE`	An override for the flush mode of updatable entity views.
`static String`	`UPDATER_FLUSH_STRATEGY`	An override for the flush strategy of updatable entity views.
`static String`	`UPDATER_STRICT_CASCADING_CHECK`	A boolean flag to make it possible to disable the strict cascading check that disallows setting updatable or creatable entity views on non-cascading attributes before being associated with a cascading attribute.

Method Summary

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- PROXY_EAGER_LOADING
  
  public static final String PROXY_EAGER_LOADING
  
  A boolean flag to make it possible to use the generated proxies with serialization. When deserializing an instance the class might not have been loaded yet, so we can force loading proxy classes on startup to avoid this problem. By default the eager loading of proxies is disabled to have a better startup performance. Valid values for this property are true or false.
  
  Since:
  
  1.0.6
  
  See Also:
  
  Constant Field Values
- TEMPLATE_EAGER_LOADING
  
  public static final String TEMPLATE_EAGER_LOADING
  
  A boolean flag to make it possible to prepare all view template caches on startup. By default the eager loading of the view templates is disabled to have a better startup performance. Valid values for this property are true or false.
  
  Since:
  
  1.2.0
  
  See Also:
  
  Constant Field Values
- PROXY_UNSAFE_ALLOWED
  
  public static final String PROXY_UNSAFE_ALLOWED
  
  A boolean flag to make it possible to disable unsafe proxy generation. By default the unsafe proxies are allowed to be able to make use of the features. Valid values for this property are true or false.
  
  Since:
  
  1.0.6
  
  See Also:
  
  Constant Field Values
- EXPRESSION_VALIDATION_DISABLED
  
  public static final String EXPRESSION_VALIDATION_DISABLED
  
  A boolean flag to make it possible to disable the expression validation. By default the expression validation is enabled, but since the validation is not bullet proof, it can be disabled. Valid values for this property are true or false.
  
  Since:
  
  1.1.0
  
  See Also:
  
  Constant Field Values
- MANAGED_TYPE_VALIDATION_DISABLED
  
  public static final String MANAGED_TYPE_VALIDATION_DISABLED
  
  A boolean flag to make it possible to disable the managed type validation. By default the managed type validation is enabled, but since the validation is not bullet proof, it can be disabled. Valid values for this property are true or false.
  
  Since:
  
  1.3.0
  
  See Also:
  
  Constant Field Values
- DEFAULT_BATCH_SIZE
  
  public static final String DEFAULT_BATCH_SIZE
  
  An integer value that defines the default batch size for entity view attributes. By default the value is 1 and can be overridden either via BatchFetch.size() or by setting this property via EntityViewSetting.setProperty(java.lang.String, java.lang.Object). To specify the batch size of a specific attribute, append the attribute name after the "batch_size" like e.g. com.blazebit.persistence.view.batch_size.subProperty
  
  Since:
  
  1.2.0
  
  See Also:
  
  Constant Field Values
- EXPECT_BATCH_CORRELATION_VALUES
  
  public static final String EXPECT_BATCH_CORRELATION_VALUES
  
  A boolean specifying if correlation value batching is expected or view root batching. By default the value is true and can be overridden by setting this property via EntityViewSetting.setProperty(java.lang.String, java.lang.Object). To specify the batch expectation of a specific attribute, append the attribute name after the "batch_correlation_values" like e.g. com.blazebit.persistence.view.batch_correlation_values.subProperty
  
  Since:
  
  1.2.0
  
  See Also:
  
  Constant Field Values
- EXPECT_BATCH_MODE
  
  public static final String EXPECT_BATCH_MODE
  A mode specifying if correlation value, view root or embedded view batching is expected. By default the value is values and can be overridden by setting this property via EntityViewSetting.setProperty(java.lang.String, java.lang.Object). Valid values are
  
  values
  
  view_roots
  
  embedding_views
  
  To specify the batch expectation of a specific attribute, append the attribute name after the "batch_mode" like e.g. com.blazebit.persistence.view.batch_mode.subProperty
  Since:
  
  1.3.0
  
  See Also:
  
  Constant Field Values
- UPDATER_EAGER_LOADING
  
  public static final String UPDATER_EAGER_LOADING
  
  A boolean flag to make it possible to prepare the entity view updater cache on startup. By default the eager loading of entity view updates is disabled to have a better startup performance. Valid values for this property are true or false.
  
  Since:
  
  1.2.0
  
  See Also:
  
  Constant Field Values
- UPDATER_FLUSH_MODE
  
  public static final String UPDATER_FLUSH_MODE
  
  An override for the flush mode of updatable entity views. By default, the property is not set. This has the effect, that the flush modes configured for the respective updatable entity views are used. Valid values for this property are partial, lazy or full. To specify an override for a specific entity view, append the fully qualified entity view class name after the "flush_mode" like e.g. com.blazebit.persistence.view.updater.flush_mode.com.mypackage.views.MyView
  
  Since:
  
  1.2.0
  
  See Also:
  
  FlushMode, Constant Field Values
- UPDATER_FLUSH_STRATEGY
  
  public static final String UPDATER_FLUSH_STRATEGY
  
  An override for the flush strategy of updatable entity views. By default, the property is not set. This has the effect, that the flush strategies configured for the respective updatable entity views are used. Valid values for this property are auto, entity or query. To specify an override for a specific entity view, append the fully qualified entity view class name after the "flush_strategy" like e.g. com.blazebit.persistence.view.updater.flush_strategy.com.mypackage.views.MyView
  
  Since:
  
  1.2.0
  
  See Also:
  
  FlushStrategy, Constant Field Values
- UPDATER_DISALLOW_OWNED_UPDATABLE_SUBVIEW
  
  public static final String UPDATER_DISALLOW_OWNED_UPDATABLE_SUBVIEW
  
  A boolean flag to make it possible to disable the strict validation that disallows the use of an updatable entity view type for owned relationships. By default the use is disallowed i.e. the default value is true, but since there might be strange models out there, it possible to allow this. Valid values for this property are true or false.
  
  Since:
  
  1.3.0
  
  See Also:
  
  Constant Field Values
- UPDATER_STRICT_CASCADING_CHECK
  
  public static final String UPDATER_STRICT_CASCADING_CHECK
  
  A boolean flag to make it possible to disable the strict cascading check that disallows setting updatable or creatable entity views on non-cascading attributes before being associated with a cascading attribute. When disabled, it is possible, like in JPA, that the changes done to an updatable entity view are not flushed when it is not associated with an attribute that cascades updates. By default the use is enabled i.e. the default value is true. Valid values for this property are true or false.
  
  Since:
  
  1.4.0
  
  See Also:
  
  Constant Field Values
- UPDATER_ERROR_ON_INVALID_PLURAL_SETTER
  
  public static final String UPDATER_ERROR_ON_INVALID_PLURAL_SETTER
  
  A boolean flag that allows to switch from warnings to boot time validation errors when invalid plural attribute setters are encountered while the strict cascading check is enabled. When true, a boot time validation error is thrown when encountering an invalid setter, otherwise just a warning. This configuration has no effect when the strict cascading check is disabled. By default the use is disabled i.e. the default value is false. Valid values for this property are true or false.
  
  Since:
  
  1.4.0
  
  See Also:
  
  Constant Field Values
- PAGINATION_DISABLE_COUNT_QUERY
  
  public static final String PAGINATION_DISABLE_COUNT_QUERY
  
  A boolean flag that allows to disable a count query for a paginated criteria builder. By default the count query is enabled i.e. the default value is false. Valid values for this property are true or false.
  
  Since:
  
  1.4.0
  
  See Also:
  
  PaginatedCriteriaBuilder.withCountQuery(boolean), Constant Field Values
- PAGINATION_EXTRACT_ALL_KEYSETS
  
  public static final String PAGINATION_EXTRACT_ALL_KEYSETS
  
  A boolean flag that allows to enable the extraction of all keysets for a paginated criteria builder. By default the extraction of all keysets is disabled i.e. the default value is false. Valid values for this property are true or false.
  
  Since:
  
  1.4.0
  
  See Also:
  
  PaginatedCriteriaBuilder.withExtractAllKeysets(boolean), Constant Field Values
- PAGINATION_FORCE_USE_KEYSET
  
  public static final String PAGINATION_FORCE_USE_KEYSET
  
  A boolean flag that allows to force the use of the keyset for a paginated criteria builder rather than relying on firstResult/maxResults. This is useful if a strict keyset based pagination is necessary and the page size or the offset might vary. By default forcing keysets is disabled i.e. the default value is false. Valid values for this property are true or false.
  
  Since:
  
  1.4.0
  
  See Also:
  
  Constant Field Values
- PAGINATION_HIGHEST_KEYSET_OFFSET
  
  public static final String PAGINATION_HIGHEST_KEYSET_OFFSET
  
  The offset from the maxResults at which to find the highest keyset i.e. the highest keyset will be at position Math.min(size, maxResults - offset). Setting 1 along with a maxResults + 1 allows to look ahead one element to check if there are more elements which is useful for pagination with lazy page count or endless scrolling. By default the offset is disabled i.e. the default value is null.
  
  Since:
  
  1.5.0
  
  See Also:
  
  PaginatedCriteriaBuilder.withHighestKeysetOffset(int), Constant Field Values
- PAGINATION_BOUNDED_COUNT
  
  public static final String PAGINATION_BOUNDED_COUNT
  
  The maximum value up to which the count query should count i.e. see PaginatedCriteriaBuilder.withBoundedCount(long). By default the bounded count is disabled i.e. all rows are counted.
  
  Since:
  
  1.5.0
  
  See Also:
  
  PaginatedCriteriaBuilder.withBoundedCount(long), Constant Field Values
- STATIC_BUILDER_SCANNING_DISABLED
  
  public static final String STATIC_BUILDER_SCANNING_DISABLED
  
  A boolean flag to make it possible to disable the scanning for static builders annotated with StaticBuilder. By default the scanning is enabled i.e. the default value is false. Valid values for this property are true or false.
  
  Since:
  
  1.5.0
  
  See Also:
  
  Constant Field Values
- STATIC_IMPLEMENTATION_SCANNING_DISABLED
  
  public static final String STATIC_IMPLEMENTATION_SCANNING_DISABLED
  
  A boolean flag to make it possible to disable the scanning for static implementations annotated with StaticImplementation. By default the scanning is enabled i.e. the default value is false. Valid values for this property are true or false.
  
  Since:
  
  1.5.0
  
  See Also:
  
  Constant Field Values
- STATIC_METAMODEL_SCANNING_DISABLED
  
  public static final String STATIC_METAMODEL_SCANNING_DISABLED
  
  A boolean flag to make it possible to disable the scanning for static metmodels annotated with StaticMetamodel. By default the scanning is enabled i.e. the default value is false. Valid values for this property are true or false.
  
  Since:
  
  1.5.0
  
  See Also:
  
  Constant Field Values
- CREATE_EMPTY_FLAT_VIEWS
  
  public static final String CREATE_EMPTY_FLAT_VIEWS
  
  A boolean flag that allows to specify if empty flat views should be created by default if not specified via EmptyFlatViewCreation. By default the creation of empty flat views is enabled i.e. the default value is true. Valid values for this property are true or false.
  
  Since:
  
  1.5.0
  
  See Also:
  
  Constant Field Values

Class ConfigurationProperties

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details