Package com.broadleafcommerce.search.api.domain

Class FieldVariant

java.lang.Object

com.broadleafcommerce.search.api.domain.FieldVariant

All Implemented Interfaces:

Serializable

public class FieldVariant
extends Object
implements Serializable

A specific variant of a field representing the concrete indexed version with a type.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
FieldVariant()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
FieldDefinition	getField()	The field which this variant represents.
String	getType()	The general type of value stored in this field.
int	hashCode()
boolean	isIncludeInResponse()	Determines whether or not this variant should be included in the search response.
void	setField(FieldDefinition field)	The field which this variant represents.
void	setIncludeInResponse(boolean includeInResponse)	Determines whether or not this variant should be included in the search response.
void	setType(String type)	The general type of value stored in this field.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

FieldVariant

public FieldVariant()

Method Detail

getField

public FieldDefinition getField()

The field which this variant represents.

Returns:

field which this variant represents

getType

public String getType()

The general type of value stored in this field.

Should be a value of FieldType

Returns:

value type stored in this field

isIncludeInResponse

public boolean isIncludeInResponse()

Determines whether or not this variant should be included in the search response. This must be a stored value in the search index.

Returns:

should this be included in the search response?

setField

public void setField(FieldDefinition field)

The field which this variant represents.

Parameters:

field - field which this variant represents

setType

public void setType(String type)

The general type of value stored in this field.

Should be a value of FieldType

Parameters:

type - value type stored in this field

setIncludeInResponse

public void setIncludeInResponse(boolean includeInResponse)

Determines whether or not this variant should be included in the search response. This must be a stored value in the search index.

Parameters:

includeInResponse - Should this field be included in the search response?

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object