Package com.commercetools.api.models.product_search

Class ProductSearchFacetStatsValueBuilder

java.lang.Object

com.commercetools.api.models.product_search.ProductSearchFacetStatsValueBuilder

All Implemented Interfaces:

Builder<ProductSearchFacetStatsValue>

public class ProductSearchFacetStatsValueBuilder
extends Object
implements Builder<ProductSearchFacetStatsValue>

ProductSearchFacetStatsValueBuilder Example to create an instance using the builder pattern

     ProductSearchFacetStatsValue productSearchFacetStatsValue = ProductSearchFacetStatsValue.builder()
             .name("{name}")
             .field("{field}")
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ProductSearchFacetStatsValueBuilder()

Method Summary

Modifier and Type	Method	Description
ProductSearchFacetStatsValue	build()	builds ProductSearchFacetStatsValue with checking for non-null required values
ProductSearchFacetStatsValue	buildUnchecked()	builds ProductSearchFacetStatsValue without checking for non-null required values
ProductSearchFacetStatsValueBuilder	field(String field)	The searchable Product field to facet on.
ProductSearchFacetStatsValueBuilder	fieldType(SearchFieldType fieldType)	If the field is not standard, this must be the Attribute type.
ProductSearchFacetStatsValueBuilder	filter(SearchQuery filter)	Additional filtering expression to apply to the search result before calculating the facet.
ProductSearchFacetStatsValueBuilder	filter(Function<SearchQueryBuilder,SearchQueryBuilder> builder)	Additional filtering expression to apply to the search result before calculating the facet.
String	getField()	The searchable Product field to facet on.
SearchFieldType	getFieldType()	If the field is not standard, this must be the Attribute type.
SearchQuery	getFilter()	Additional filtering expression to apply to the search result before calculating the facet.
String	getName()	Name of the stats facet to appear in the ProductSearchFacetResultStats.
ProductSearchFacetScopeEnum	getScope()	Whether the facet must consider only the Products resulting from the search (query) or all the Products (all).
ProductSearchFacetStatsValueBuilder	name(String name)	Name of the stats facet to appear in the ProductSearchFacetResultStats.
static ProductSearchFacetStatsValueBuilder	of()	factory method for an instance of ProductSearchFacetStatsValueBuilder
static ProductSearchFacetStatsValueBuilder	of(ProductSearchFacetStatsValue template)	create builder for ProductSearchFacetStatsValue instance
ProductSearchFacetStatsValueBuilder	scope(ProductSearchFacetScopeEnum scope)	Whether the facet must consider only the Products resulting from the search (query) or all the Products (all).
ProductSearchFacetStatsValueBuilder	withFilter(Function<SearchQueryBuilder,SearchQuery> builder)	Additional filtering expression to apply to the search result before calculating the facet.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProductSearchFacetStatsValueBuilder

public ProductSearchFacetStatsValueBuilder()

Method Details

name

public ProductSearchFacetStatsValueBuilder name(String name)

Name of the stats facet to appear in the ProductSearchFacetResultStats.

Parameters:

name - value to be set

Returns:

Builder

scope

public ProductSearchFacetStatsValueBuilder scope(@Nullable
 ProductSearchFacetScopeEnum scope)

Whether the facet must consider only the Products resulting from the search (query) or all the Products (all).

Parameters:

scope - value to be set

Returns:

Builder

filter

public ProductSearchFacetStatsValueBuilder filter(Function<SearchQueryBuilder,SearchQueryBuilder> builder)

Additional filtering expression to apply to the search result before calculating the facet.

Parameters:

builder - function to build the filter value

Returns:

Builder

withFilter

public ProductSearchFacetStatsValueBuilder withFilter(Function<SearchQueryBuilder,SearchQuery> builder)

Additional filtering expression to apply to the search result before calculating the facet.

Parameters:

builder - function to build the filter value

Returns:

Builder

filter

public ProductSearchFacetStatsValueBuilder filter(@Nullable
 SearchQuery filter)

Additional filtering expression to apply to the search result before calculating the facet.

Parameters:

filter - value to be set

Returns:

Builder

field

public ProductSearchFacetStatsValueBuilder field(String field)

The searchable Product field to facet on.

Parameters:

field - value to be set

Returns:

Builder

fieldType

public ProductSearchFacetStatsValueBuilder fieldType(@Nullable
 SearchFieldType fieldType)

If the field is not standard, this must be the Attribute type.

Parameters:

fieldType - value to be set

Returns:

Builder

getName

public String getName()

Name of the stats facet to appear in the ProductSearchFacetResultStats.

Returns:

name

getScope

@Nullable
public ProductSearchFacetScopeEnum getScope()

Whether the facet must consider only the Products resulting from the search (query) or all the Products (all).

Returns:

scope

getFilter

@Nullable
public SearchQuery getFilter()

Additional filtering expression to apply to the search result before calculating the facet.

Returns:

filter

getField

public String getField()

The searchable Product field to facet on.

Returns:

field

getFieldType

@Nullable
public SearchFieldType getFieldType()

If the field is not standard, this must be the Attribute type.

Returns:

fieldType

build

public ProductSearchFacetStatsValue build()

builds ProductSearchFacetStatsValue with checking for non-null required values

Specified by:

build in interface Builder<ProductSearchFacetStatsValue>

Returns:

ProductSearchFacetStatsValue

buildUnchecked

public ProductSearchFacetStatsValue buildUnchecked()

builds ProductSearchFacetStatsValue without checking for non-null required values

Returns:

ProductSearchFacetStatsValue

of

public static ProductSearchFacetStatsValueBuilder of()

factory method for an instance of ProductSearchFacetStatsValueBuilder

Returns:

builder

of

public static ProductSearchFacetStatsValueBuilder of(ProductSearchFacetStatsValue template)

create builder for ProductSearchFacetStatsValue instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder