Spring Data Solr

org.springframework.data.solr.repository.config
Annotation Type EnableSolrRepositories


@Target(value=TYPE)
@Retention(value=RUNTIME)
@Documented
@Inherited
@Import(value=org.springframework.data.solr.repository.config.SolrRepositoriesRegistrar.class)
public @interface EnableSolrRepositories

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

Author:
Oliver Gierke

Optional Element Summary
 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.
 ComponentScan.Filter[] excludeFilters
          Specifies which types are not eligible for component scanning.
 ComponentScan.Filter[] includeFilters
          Specifies which types are eligible for component scanning.
 boolean multicoreSupport
          Configures Multicore support for Solr Server
 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<?> 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 solrServerRef
          Configures the name of the org.apache.solr.client.solrj bean definition to be used for creating templates
 String solrTemplateRef
          Configures the name of the SolrTemplate bean definition to be used to create repositories discovered through this annotation.
 String[] value
          Alias for the basePackages() attribute.
 

value

public abstract String[] value
Alias for the basePackages() attribute. Allows for more concise annotation declarations e.g.: @EnableSolrRepositories("org.my.pkg") instead of @EnableSolrRpositories(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.

Returns:
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/solr-named-queries.properties.

Returns:
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.

Returns:
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 SolrRepositoryFactoryBean.

Returns:
Default:
org.springframework.data.solr.repository.support.SolrRepositoryFactoryBean.class

solrTemplateRef

public abstract String solrTemplateRef
Configures the name of the SolrTemplate bean definition to be used to create repositories discovered through this annotation. Defaults to solrTemplate.

Returns:
Default:
"solrTemplate"

solrServerRef

public abstract String solrServerRef
Configures the name of the org.apache.solr.client.solrj bean definition to be used for creating templates

Since:
1.1
Default:
"solrServer"

multicoreSupport

public abstract boolean multicoreSupport
Configures Multicore support for Solr Server

Since:
1.1
Default:
false

Spring Data Solr

Copyright © 2011-2014-2014 Pivotal. All Rights Reserved.