org.springframework.data.neo4j.repository.config

Annotation Type EnableNeo4jRepositories

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

Annotation to enable Neo4j repositories. Will scan the package of the annotated configuration class for Spring Data repositories by default.

Author:

Vince Bickers, Mark Angrish, Michael J. Simons

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>[]	basePackageClasses Type-safe alternative to basePackages() for specifying the packages to scan for annotated components.
String[]	basePackages Base packages to scan for annotated components.
boolean	considerNestedRepositories Configures whether nested repository-interfaces (e.g. defined as inner classes) should be discovered by the repositories infrastructure.
boolean	enableDefaultTransactions Configures whether to enable default transactions for Spring Data Neo4j repositories.
ComponentScan.Filter[]	excludeFilters Specifies which types are not eligible for component scanning.
ComponentScan.Filter[]	includeFilters Specifies which types are eligible for component scanning.
String	mappingContextBeanName Configures the name of the Neo4jMappingContext bean definition created.
String	namedQueriesLocation Configures the location of where to find the Spring Data named queries properties file.
QueryLookupStrategy.Key	queryLookupStrategy Returns the key of the QueryLookupStrategy to be used for lookup queries for query methods.
Class<?>	repositoryBaseClass Configure the repository base class to be used to create repository proxies for this particular configuration.
Class<?>	repositoryFactoryBeanClass Returns the FactoryBean class to be used for each repository instance.
String	repositoryImplementationPostfix Returns the postfix to be used when looking up custom repository implementations.
String	sessionBeanName Configures the name of the Session bean definition created.
String	sessionFactoryRef Configures the name of the SessionFactory bean definition to be used to create repositories discovered through this annotation.
String	transactionManagerRef Configures the name of the PlatformTransactionManager bean definition to be used to create repositories discovered through this annotation.
String[]	value Alias for the basePackages() attribute.

Element Detail

value

public abstract String[] value

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

Default:

{}

basePackages

public abstract 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.

Default:

{}

basePackageClasses

public abstract 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.

Default:

{}

includeFilters

public abstract 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.

Default:

{}

excludeFilters

public abstract ComponentScan.Filter[] excludeFilters

Specifies which types are not eligible for component scanning.

Default:

{}

repositoryImplementationPostfix

public abstract 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.

Default:

"Impl"

namedQueriesLocation

public abstract String namedQueriesLocation

Configures the location of where to find the Spring Data named queries properties file. Will default to META-INFO/neo4j-named-queries.properties.

Default:

""

queryLookupStrategy

public abstract 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.

Default:

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

repositoryFactoryBeanClass

public abstract Class<?> repositoryFactoryBeanClass

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

Default:

org.springframework.data.neo4j.repository.support.Neo4jRepositoryFactoryBean.class

repositoryBaseClass

public abstract Class<?> repositoryBaseClass

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

Returns:

Default:

org.springframework.data.repository.config.DefaultRepositoryBaseClass.class

sessionFactoryRef

public abstract String sessionFactoryRef

Configures the name of the SessionFactory bean definition to be used to create repositories discovered through this annotation. Defaults to sessionFactory.

Default:

"sessionFactory"

sessionBeanName

public abstract String sessionBeanName

Configures the name of the Session bean definition created. Defaults to a generated name.

Since:

5.1.0

Default:

"(generated)"

transactionManagerRef

public abstract String transactionManagerRef

Configures the name of the PlatformTransactionManager bean definition to be used to create repositories discovered through this annotation. Defaults to transactionManager.

Default:

"transactionManager"

mappingContextBeanName

public abstract String mappingContextBeanName

Configures the name of the Neo4jMappingContext bean definition created. Defaults to a generated name.

Since:

5.1.0

Default:

"(generated)"

considerNestedRepositories

public abstract boolean considerNestedRepositories

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

Default:

false

enableDefaultTransactions

public abstract boolean enableDefaultTransactions

Configures whether to enable default transactions for Spring Data Neo4j repositories. Defaults to true. If disabled, repositories must be used behind a facade that's configuring transactions (e.g. using Spring's annotation driven transaction facilities) or repository methods have to be used to demarcate transactions.

Returns:

whether to enable default transactions, defaults to true.

Default:

true