com.weedow.spring.data.search.descriptor

Class SearchDescriptorBuilder<T>

com.weedow.spring.data.search.descriptor.SearchDescriptorBuilder<T>

public class SearchDescriptorBuilder<T>

Class to construct a new interface SearchDescriptor using the Builder pattern.

See Also:

interface SearchDescriptor

Field Detail

Companion

public static com.weedow.spring.data.search.descriptor.SearchDescriptorBuilder.Companion Companion

Constructor Detail

SearchDescriptorBuilder

public SearchDescriptorBuilder(@NotNull
                               java.lang.Class<T> entityClass)

Class to construct a new interface SearchDescriptor using the Builder pattern.

See Also:

interface SearchDescriptor

Method Detail

id

@NotNull
public SearchDescriptorBuilder<T> id(@NotNull
                                              java.lang.String id)

Set the Search Descriptor ID. If this method is not called, the default value is the Entity Name in lowercase, deduced by the given Entity Class.

validators

@NotNull
public SearchDescriptorBuilder<T> validators(@NotNull
                                                      com.weedow.spring.data.search.validation.DataSearchValidator... validators)

Set the validators to validate the query parameters.

dtoMapper

@NotNull
public SearchDescriptorBuilder<T> dtoMapper(@NotNull
                                                     DtoMapper<T,?> dtoMapper)

Set the interface DtoMapper to convert the Entities returned by the SQL queries to DTO object. If this method is not called, the Entities are not converted and they are returned directly.

See Also:

interface DtoMapper

jpaSpecificationExecutor

@NotNull
public SearchDescriptorBuilder<T> jpaSpecificationExecutor(@NotNull
                                                                    org.springframework.data.jpa.repository.JpaSpecificationExecutor<T> jpaSpecificationExecutor)

Set a specific JpaSpecificationExecutor to be used to search for entities. If this method is not called, a default implementation of JpaSpecificationExecutor is retrieved from class JpaSpecificationExecutorFactory.

See Also:

class JpaSpecificationExecutorFactory

entityJoinHandlers

@NotNull
public SearchDescriptorBuilder<T> entityJoinHandlers(@NotNull
                                                              com.weedow.spring.data.search.join.handler.EntityJoinHandler... entityJoinHandlers)

Set the interface EntityJoinHandler to specify join types for any fields having Join Annotation_

See Also:

interface EntityJoinHandler

build

@NotNull
public SearchDescriptor<T> build()

Builds a new interface SearchDescriptor according to the specified options.

See Also:

interface SearchDescriptor