Class CoreModuleExtender
java.lang.Object
org.apache.cayenne.configuration.runtime.CoreModuleExtender
A builder of extensions for
CoreModule
.- Since:
- 5.0
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAdapterDetector
(Class<? extends DbAdapterDetector> adapterDetectorType) Adds a custom DbAdapterDetectoraddAdapterDetector
(DbAdapterDetector adapterDetector) Adds a custom DbAdapterDetectoraddDefaultExtendedType
(Class<? extends ExtendedType<?>> type) Adds a default adapter-agnostic ExtendedType.addDefaultExtendedType
(ExtendedType<?> type) Adds a default adapter-agnostic ExtendedType.addExtendedTypeFactory
(Class<? extends ExtendedTypeFactory> factoryType) Adds an ExtendedTypeFactory used for dynamic extended type creation.Adds an ExtendedTypeFactory used for dynamic extended type creation.addListener
(Object listener) Registers an annotated event listener.addListenerType
(Class<?> listenerType) Registers an annotated event listener of a given typeaddPkGenerator
(Class<? extends DbAdapter> adapter, Class<? extends PkGenerator> pkGeneratorType) Adds a custom PK generator per DbAdapteraddPkGenerator
(Class<? extends DbAdapter> adapter, PkGenerator pkGenerator) Adds a custom PK generator per DbAdapteraddProjectLocation
(String location) Adds a custom project location.addQueryFilter
(Class<? extends DataChannelQueryFilter> queryFilterType) Adds a custom query filter to the end of the existing filter listaddQueryFilter
(DataChannelQueryFilter queryFilter) Adds a custom query filter to the end of the existing filter listaddSyncFilter
(Class<? extends DataChannelSyncFilter> syncFilterType) Adds a custom sync filter.addSyncFilter
(Class<? extends DataChannelSyncFilter> syncFilterType, boolean includeInTransaction) Adds a custom sync filter.addSyncFilter
(DataChannelSyncFilter syncFilter) Adds a custom sync filter.addSyncFilter
(DataChannelSyncFilter syncFilter, boolean includeInTransaction) Adds a custom sync filter.addUserExtendedType
(Class<? extends ExtendedType<?>> type) Adds an adapter-agnostic ExtendedType.addUserExtendedType
(ExtendedType<?> type) Adds an adapter-agnostic ExtendedType.addValueObjectType
(Class<? extends ValueObjectType<?, ?>> type) Adds a customValueObjectType
.addValueObjectType
(ValueObjectType<?, ?> type) Adds a customValueObjectType
.Sets transaction management to either external.protected CoreModuleExtender
setProperty
(String key, Object value) Sets Cayenne runtime property.snapshotCacheSize
(int size) Sets max size of snapshot cache.Configures the stack to synchronize data between ObjectContexts.
-
Constructor Details
-
CoreModuleExtender
-
-
Method Details
-
initAllExtensions
-
setProperty
Sets Cayenne runtime property. Property names known to Cayenne are defined in theConstants
interface. -
syncContexts
Configures the stack to synchronize data between ObjectContexts. This is false by default. -
externalTransactions
Sets transaction management to either external. By default, transactions are internally managed by Cayenne. -
snapshotCacheSize
Sets max size of snapshot cache.- Parameters:
size
- max size of snapshot cache
-
addProjectLocation
Adds a custom project location. -
addPkGenerator
public CoreModuleExtender addPkGenerator(Class<? extends DbAdapter> adapter, PkGenerator pkGenerator) Adds a custom PK generator per DbAdapter -
addPkGenerator
public CoreModuleExtender addPkGenerator(Class<? extends DbAdapter> adapter, Class<? extends PkGenerator> pkGeneratorType) Adds a custom PK generator per DbAdapter -
addQueryFilter
Adds a custom query filter to the end of the existing filter list -
addQueryFilter
Adds a custom query filter to the end of the existing filter list -
addSyncFilter
Adds a custom sync filter. -
addSyncFilter
Adds a custom sync filter. -
addSyncFilter
public CoreModuleExtender addSyncFilter(DataChannelSyncFilter syncFilter, boolean includeInTransaction) Adds a custom sync filter. Depending on the "includeInTransaction" parameter value it is added either before or after theTransactionFilter
. -
addSyncFilter
public CoreModuleExtender addSyncFilter(Class<? extends DataChannelSyncFilter> syncFilterType, boolean includeInTransaction) Adds a custom sync filter. Depending on the "includeInTransaction" parameter value it is added either before or after theTransactionFilter
. -
addListener
Registers an annotated event listener. -
addListenerType
Registers an annotated event listener of a given type -
addAdapterDetector
Adds a custom DbAdapterDetector -
addAdapterDetector
public CoreModuleExtender addAdapterDetector(Class<? extends DbAdapterDetector> adapterDetectorType) Adds a custom DbAdapterDetector -
addDefaultExtendedType
Adds a default adapter-agnostic ExtendedType. "Default" types are loaded before adapter-provided or "user" types, so they may be overridden by those. -
addDefaultExtendedType
Adds a default adapter-agnostic ExtendedType. "Default" types are loaded before adapter-provided or "user" types, so they may be overridden by those. -
addUserExtendedType
Adds an adapter-agnostic ExtendedType. "User" types are loaded after default and adapter-provided types and can override those. -
addUserExtendedType
Adds an adapter-agnostic ExtendedType. "User" types are loaded after default and adapter-provided types and can override those. -
addExtendedTypeFactory
Adds an ExtendedTypeFactory used for dynamic extended type creation. -
addExtendedTypeFactory
Adds an ExtendedTypeFactory used for dynamic extended type creation. -
addValueObjectType
Adds a customValueObjectType
. -
addValueObjectType
Adds a customValueObjectType
.
-