org.broadleafcommerce.core.search.domain

Class FieldImpl

java.lang.Object

org.broadleafcommerce.core.search.domain.FieldImpl

All Implemented Interfaces:

Serializable, AdminMainEntity, MultiTenantCloneable<Field>, Field

@Entity
public class FieldImpl
extends Object
implements Field, Serializable, AdminMainEntity

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	abbreviation
protected String	entityType
protected String	facetFieldType
protected String	friendlyName
protected Long	id
protected String	propertyName
protected Boolean	searchable
protected List<String>	searchableFieldTypes
protected Boolean	translatable

Fields inherited from interface org.broadleafcommerce.common.admin.domain.AdminMainEntity

MAIN_ENTITY_NAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
FieldImpl()

Method Summary

Methods

Modifier and Type	Method and Description
<G extends Field> CreateResponse<G>	createOrRetrieveCopyInstance(MultiTenantCopyContext context) Clone this entity for the purpose of multiple tenancy.
boolean	equals(Object obj)
String	getAbbreviation() Gets the abbreviation of this Field.
FieldEntity	getEntityType() Gets the entityType of this Field
FieldType	getFacetFieldType() Gets the facet field type.
String	getFriendlyName() Returns the friendly name of the field, for use by admin or other UI.
Long	getId() Gets the id
String	getMainEntityName()
String	getPropertyName() Gets the propertyName of this Field.
String	getQualifiedFieldName() Returns the qualified name of this Field.
Boolean	getSearchable() Gets the searchable flag
List<FieldType>	getSearchableFieldTypes() Gets the dynamic searchable field types.
List<SearchConfig>	getSearchConfigs() Gets the searchConfigs.
Boolean	getTranslatable() Returns whether or not this field should be considered translatable
void	setAbbreviation(String abbreviation) Sets the abbreviation
void	setEntityType(FieldEntity entityType) Sets the entityType
void	setFacetFieldType(FieldType facetFieldType) Sets the facet field type
void	setFriendlyName(String friendlyName) The friendly name of the field, for use by admin or other UI.
void	setId(Long id) Sets the id
void	setPropertyName(String propertyName) Sets the propertyName
void	setSearchable(Boolean searchable) Sets the searchable flag
void	setSearchableFieldTypes(List<FieldType> searchableFieldTypes) Sets the searchableFieldTypes
void	setSearchConfigs(List<SearchConfig> searchConfigs) Sets the searchConfigs.
void	setTranslatable(Boolean translatable) Sets whether or not this field should be considered translatable

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

protected Long id

entityType

protected String entityType

friendlyName

protected String friendlyName

propertyName

protected String propertyName

abbreviation

protected String abbreviation

searchable

protected Boolean searchable

facetFieldType

protected String facetFieldType

searchableFieldTypes

protected List<String> searchableFieldTypes

translatable

protected Boolean translatable

Constructor Detail

FieldImpl

public FieldImpl()

Method Detail

getQualifiedFieldName

public String getQualifiedFieldName()

Description copied from interface: Field

Returns the qualified name of this Field. The default implementation returns the entityType joined with the properName by a "."

Specified by:

getQualifiedFieldName in interface Field

Returns:

the qualifiedFieldName

getId

public Long getId()

Description copied from interface: Field

Gets the id

Specified by:

getId in interface Field

Returns:

the id

setId

public void setId(Long id)

Description copied from interface: Field

Sets the id

Specified by:

setId in interface Field

getEntityType

public FieldEntity getEntityType()

Description copied from interface: Field

Gets the entityType of this Field

Specified by:

getEntityType in interface Field

Returns:

the entityType

setEntityType

public void setEntityType(FieldEntity entityType)

Description copied from interface: Field

Sets the entityType

Specified by:

setEntityType in interface Field

getPropertyName

public String getPropertyName()

Description copied from interface: Field

Gets the propertyName of this Field. This would be something like "manufacturer" or "defaultSku.price" if the EntityType was "product"

Specified by:

getPropertyName in interface Field

Returns:

the propertyName

setPropertyName

public void setPropertyName(String propertyName)

Description copied from interface: Field

Sets the propertyName

Specified by:

setPropertyName in interface Field

getAbbreviation

public String getAbbreviation()

Description copied from interface: Field

Gets the abbreviation of this Field. This will be used in URL query string parameters for sorting and filtering

Specified by:

getAbbreviation in interface Field

Returns:

the abbreviation

setAbbreviation

public void setAbbreviation(String abbreviation)

Description copied from interface: Field

Sets the abbreviation

Specified by:

setAbbreviation in interface Field

getFriendlyName

public String getFriendlyName()

Description copied from interface: Field

Returns the friendly name of the field, for use by admin or other UI.

Specified by:

getFriendlyName in interface Field

Returns:

setFriendlyName

public void setFriendlyName(String friendlyName)

Description copied from interface: Field

The friendly name of the field, for use by admin or other UI.

Specified by:

setFriendlyName in interface Field

getSearchable

public Boolean getSearchable()

Description copied from interface: Field

Gets the searchable flag

Specified by:

getSearchable in interface Field

Returns:

whether or not this Field is searchable

setSearchable

public void setSearchable(Boolean searchable)

Description copied from interface: Field

Sets the searchable flag

Specified by:

setSearchable in interface Field

getFacetFieldType

public FieldType getFacetFieldType()

Description copied from interface: Field

Gets the facet field type. Note that the facet field type is also the type used to perform sorting. Any field where there is a desire to facet or sort on should have this FieldType specified.

Specified by:

getFacetFieldType in interface Field

Returns:

the facet field type

See Also:

Field.getSearchableFieldTypes()

setFacetFieldType

public void setFacetFieldType(FieldType facetFieldType)

Description copied from interface: Field

Sets the facet field type

Specified by:

setFacetFieldType in interface Field

getSearchableFieldTypes

public List<FieldType> getSearchableFieldTypes()

Description copied from interface: Field

Gets the dynamic searchable field types. For example, in solr, if you wanted to index a field as both text and string, you would have two searchable field types, String and Text

Specified by:

getSearchableFieldTypes in interface Field

Returns:

the searchable types for this field

setSearchableFieldTypes

public void setSearchableFieldTypes(List<FieldType> searchableFieldTypes)

Description copied from interface: Field

Sets the searchableFieldTypes

Specified by:

setSearchableFieldTypes in interface Field

See Also:

Field.getSearchableFieldTypes()

getTranslatable

public Boolean getTranslatable()

Description copied from interface: Field

Returns whether or not this field should be considered translatable

Specified by:

getTranslatable in interface Field

Returns:

translatable

setTranslatable

public void setTranslatable(Boolean translatable)

Description copied from interface: Field

Sets whether or not this field should be considered translatable

Specified by:

setTranslatable in interface Field

getSearchConfigs

public List<SearchConfig> getSearchConfigs()

Description copied from interface: Field

Gets the searchConfigs. Note that a concrete implementation or usage of this class is not available in the community version of Broadleaf Commerce.

Specified by:

getSearchConfigs in interface Field

Returns:

the searchConfigs

setSearchConfigs

public void setSearchConfigs(List<SearchConfig> searchConfigs)

Description copied from interface: Field

Sets the searchConfigs.

Specified by:

setSearchConfigs in interface Field

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getMainEntityName

public String getMainEntityName()

Specified by:

getMainEntityName in interface AdminMainEntity

Returns:

the display name of this entity for the admin screen

createOrRetrieveCopyInstance

public <G extends Field> CreateResponse<G> createOrRetrieveCopyInstance(MultiTenantCopyContext context)
                                                             throws CloneNotSupportedException

Description copied from interface: MultiTenantCloneable

Clone this entity for the purpose of multiple tenancy. Note, extending classes should follow this pattern:

public CreateResponse<MyClass> createOrRetrieveCopyInstance(MultiTenantCopyContext context) throws CloneNotSupportedException { CreateResponse<MyClass> createResponse = super.createOrRetrieveCopyInstance(context); if (createResponse.isAlreadyPopulated()) { return createResponse; } MyClass myClone = createResponse.getClone(); //copy extended field values on myClone here return createResponse; }

Support should also be added for @Embeddable classes that contribute fields (collections or basic) to a cloneable entity:

public CreateResponse<G extends MyClass> createOrRetrieveCopyInstance(MultiTenantCopyContext context) throws CloneNotSupportedException { CreateResponse createResponse = context.createOrRetrieveCopyInstance(this); MyClass myClone = createResponse.getClone(); //copy extended field values on myClone here return createResponse; }

Specified by:

createOrRetrieveCopyInstance in interface MultiTenantCloneable<Field>

Parameters:

context - a context object providing persistence and library functionality for copying entities

Returns:

the resulting copy container, possibly already persisted

Throws:

CloneNotSupportedException - if there's a problem detected with the cloning configuration