io.jmix.core.repository

Annotation Type EnableJmixDataRepositories

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @Inherited
 @Import(value=JmixRepositoriesRegistrar.class)
public @interface EnableJmixDataRepositories

Annotation to enable data repositories. Will scan the package of the annotated configuration class for Jmix data repositories by default.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.Class<?>[]	basePackageClasses Type-safe alternative to basePackages() for specifying the packages to scan for annotated components.
java.lang.String[]	basePackages Base packages to scan for annotated components.
boolean	considerNestedRepositories Configures whether nested repository-interfaces (e.g.
org.springframework.context.annotation.ComponentScan.Filter[]	excludeFilters Specifies which types are not eligible for component scanning.
org.springframework.context.annotation.ComponentScan.Filter[]	includeFilters Specifies which types are eligible for component scanning.
java.lang.String	namedQueriesLocation Configures the location of where to find the Spring Data named queries properties file.
org.springframework.data.repository.query.QueryLookupStrategy.Key	queryLookupStrategy Returns the key of the QueryLookupStrategy to be used for lookup queries for query methods.
java.lang.Class<?>	repositoryBaseClass Configure the repository base class to be used to create repository proxies for this particular configuration.
java.lang.Class<?>	repositoryFactoryBeanClass Returns the FactoryBean class to be used for each repository instance.
java.lang.String	repositoryImplementationPostfix Returns the postfix to be used when looking up custom repository implementations.
java.lang.String[]	value Alias for the basePackages() attribute.

Element Detail

value

public abstract java.lang.String[] value

Alias for the basePackages() attribute. Allows for more concise annotation declarations e.g.: @EnableJmixDataRepositories("org.my.pkg") instead of @EnableJmixDataRepositories(basePackages="org.my.pkg").

Returns:

list of packages that should be scanned

Default:

{}

basePackages

public abstract java.lang.String[] basePackages

Base packages to scan for annotated components. value() is an alias for (and mutually exclusive with) this attribute. Use basePackageClasses() for a type-safe alternative to String-based package names.

Returns:

list of packages that should be scanned

Default:

{}

basePackageClasses

public abstract java.lang.Class<?>[] basePackageClasses

Type-safe alternative to basePackages() for specifying the packages to scan for annotated components. The package of each class specified will be scanned. Consider creating a special no-op marker class or interface in each package that serves no purpose other than being referenced by this attribute.

Returns:

list of packages that should be scanned

Default:

{}

excludeFilters

public abstract org.springframework.context.annotation.ComponentScan.Filter[] excludeFilters

Specifies which types are not eligible for component scanning.

Returns:

filters that exclude some classes from scanning

Default:

{}

includeFilters

public abstract org.springframework.context.annotation.ComponentScan.Filter[] includeFilters

Specifies which types are eligible for component scanning. Further narrows the set of candidate components from everything in basePackages() to everything in the base packages that matches the given filter or filters.

Returns:

filters that include classes into scanning

Default:

{}

repositoryImplementationPostfix

public abstract java.lang.String repositoryImplementationPostfix

Returns the postfix to be used when looking up custom repository implementations. Defaults to Impl. So for a repository named PersonRepository the corresponding implementation class will be looked up scanning for PersonRepositoryImpl.

Returns:

Postfix to be used when looking up custom repository implementations.

Default:

"Impl"

namedQueriesLocation

public abstract java.lang.String namedQueriesLocation

Configures the location of where to find the Spring Data named queries properties file.

Returns:

Location of where to find the Spring Data named queries properties file.

Default:

""

queryLookupStrategy

public abstract org.springframework.data.repository.query.QueryLookupStrategy.Key queryLookupStrategy

Returns the key of the QueryLookupStrategy to be used for lookup queries for query methods. Defaults to QueryLookupStrategy.Key#CREATE_IF_NOT_FOUND.

Returns:

Key of the QueryLookupStrategy to be used for lookup queries for query methods.

Default:

org.springframework.data.repository.query.QueryLookupStrategy.Key.CREATE_IF_NOT_FOUND

repositoryFactoryBeanClass

public abstract java.lang.Class<?> repositoryFactoryBeanClass

Returns the FactoryBean class to be used for each repository instance. Defaults to JmixRepositoryFactoryBean.

Returns:

FactoryBean class to be used for each repository instance.

Default:

io.jmix.core.impl.repository.support.JmixRepositoryFactoryBean.class

repositoryBaseClass

public abstract java.lang.Class<?> repositoryBaseClass

Configure the repository base class to be used to create repository proxies for this particular configuration.

Returns:

Repository base class to be used to create repository proxies for this particular configuration.

Default:

io.jmix.core.impl.repository.support.JmixDataRepositoryImpl.class

considerNestedRepositories

public abstract boolean considerNestedRepositories

Configures whether nested repository-interfaces (e.g. defined as inner classes) should be discovered by the repository infrastructure.

Returns:

Flag that indicates if we should consider nested repository during scan

Default:

false