org.broadleafcommerce.core.search.dao

Interface IndexFieldDao

All Known Implementing Classes:

IndexFieldDaoImpl

public interface IndexFieldDao

DAO used to interact with the database search fields

Author:

Nick Crum (ncrum)

Method Summary

Modifier and Type	Method and Description
List<IndexFieldType>	getIndexFieldTypes(FieldType facetFieldType)
List<IndexFieldType>	getIndexFieldTypesByAbbreviation(String abbreviation)
List<IndexFieldType>	getIndexFieldTypesByAbbreviationAndEntityType(String abbreviation, FieldEntity entityType)
List<IndexFieldType>	getIndexFieldTypesByAbbreviationOrPropertyName(String name)
List<IndexField>	readAllIndexFieldsByFieldId(Long fieldId) Finds all of the IndexFields associated with the given field parameter, or null if non exists.
List<IndexField>	readFieldsByEntityType(FieldEntity entityType) Finds all of the IndexFields based on the entity type.
IndexField	readIndexFieldByAbbreviation(String abbreviation)
IndexField	readIndexFieldByAbbreviationAndEntityType(String abbreviation, FieldEntity entityType)
IndexField	readIndexFieldByFieldId(Long fieldId) Returns the SearchField instance associated with the given field parameter, or null if non exists.
IndexField	readIndexFieldForField(Field field) Returns the SearchField instance associated with the given field parameter, or null if non exists.
List<IndexField>	readSearchableFieldsByEntityType(FieldEntity entityType) Reads all of the IndexFields that are searchable on the entity type

Method Detail

readIndexFieldForField

IndexField readIndexFieldForField(Field field)

Returns the SearchField instance associated with the given field parameter, or null if non exists.

Parameters:

field - the Field we are looking for the SearchField for

Returns:

a SearchField instance for the given field

readIndexFieldByFieldId

IndexField readIndexFieldByFieldId(Long fieldId)

Returns the SearchField instance associated with the given field parameter, or null if non exists.

Parameters:

fieldId - the Field we are looking for the SearchField for

Returns:

a SearchField instance for the given field

readAllIndexFieldsByFieldId

List<IndexField> readAllIndexFieldsByFieldId(Long fieldId)

Finds all of the IndexFields associated with the given field parameter, or null if non exists.

Parameters:

fieldId - the Field we are looking for the SearchField for

Returns:

readFieldsByEntityType

List<IndexField> readFieldsByEntityType(FieldEntity entityType)

Finds all of the IndexFields based on the entity type.

Parameters:

entityType -

Returns:

readSearchableFieldsByEntityType

List<IndexField> readSearchableFieldsByEntityType(FieldEntity entityType)

Reads all of the IndexFields that are searchable on the entity type

Parameters:

entityType -

Returns:

getIndexFieldTypesByAbbreviation

List<IndexFieldType> getIndexFieldTypesByAbbreviation(String abbreviation)

getIndexFieldTypesByAbbreviationAndEntityType

List<IndexFieldType> getIndexFieldTypesByAbbreviationAndEntityType(String abbreviation,
                                                                   FieldEntity entityType)

getIndexFieldTypesByAbbreviationOrPropertyName

List<IndexFieldType> getIndexFieldTypesByAbbreviationOrPropertyName(String name)

getIndexFieldTypes

List<IndexFieldType> getIndexFieldTypes(FieldType facetFieldType)

readIndexFieldByAbbreviation

IndexField readIndexFieldByAbbreviation(String abbreviation)

readIndexFieldByAbbreviationAndEntityType

IndexField readIndexFieldByAbbreviationAndEntityType(String abbreviation,
                                                     FieldEntity entityType)