org.ametys.cms.search.solr.field

Class AbstractMetadataSearchField

java.lang.Object

org.ametys.cms.search.solr.field.AbstractMetadataSearchField

All Implemented Interfaces:

JoinableSearchField, SearchField

Direct Known Subclasses:

BooleanSearchField, DateSearchField, DoubleSearchField, LongSearchField, MultilingualStringSearchField, StringSearchField

public abstract class AbstractMetadataSearchField
extends Object
implements JoinableSearchField

Metadata (abstract) generic search field.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	_joinPaths The join paths
protected String	_path The field path.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMetadataSearchField(List<String> joinPaths, String finalPath) Build a Metadata SearchField
protected	AbstractMetadataSearchField(String path) Build a Metadata SearchField

Method Summary

Modifier and Type	Method and Description
protected abstract String	_getFacetFieldSuffix() Get the facet field suffix corresponding to this field.
protected abstract String	_getSortFieldSuffix() Get the sort field suffix corresponding to this field.
String	getFacetField() Get the facet field corresponding to this field.
String	getFacetFunction() Get the facet function corresponding to this field.
String	getFinalPath() Gets the final field path
String	getJoinedPath() Gets the joined path (separated by '->')
String	getName() Get the search field name.
String	getSortField() Get the sort field corresponding to this field.
boolean	isJoined() Indicates if the search field is joined

Methods inherited from class java.lang.Object

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

Field Detail

_joinPaths

protected List<String> _joinPaths

The join paths

_path

protected String _path

The field path.

Constructor Detail

AbstractMetadataSearchField

protected AbstractMetadataSearchField(String path)

Build a Metadata SearchField

Parameters:

path - The field path

AbstractMetadataSearchField

protected AbstractMetadataSearchField(List<String> joinPaths,
                                      String finalPath)

Build a Metadata SearchField

Parameters:

joinPaths - The join field paths

finalPath - The final field path

Method Detail

getSortField

public String getSortField()

Description copied from interface: SearchField

Get the sort field corresponding to this field.

Specified by:

getSortField in interface SearchField

Returns:

The sort field.

_getSortFieldSuffix

protected abstract String _getSortFieldSuffix()

Get the sort field suffix corresponding to this field. Return null if not sortable.

Returns:

the sort field suffix. Null if not sortable.

isJoined

public boolean isJoined()

Description copied from interface: JoinableSearchField

Indicates if the search field is joined

Specified by:

isJoined in interface JoinableSearchField

Returns:

true if the search field is joined

getJoinedPath

public String getJoinedPath()

Description copied from interface: JoinableSearchField

Gets the joined path (separated by '->')

Specified by:

getJoinedPath in interface JoinableSearchField

Returns:

the joined path (separated by '->')

getFinalPath

public String getFinalPath()

Gets the final field path

Returns:

the final field path

getFacetField

public String getFacetField()

Description copied from interface: SearchField

Get the facet field corresponding to this field.

Specified by:

getFacetField in interface SearchField

Returns:

The facet field.

_getFacetFieldSuffix

protected abstract String _getFacetFieldSuffix()

Get the facet field suffix corresponding to this field. Return null if not facetable.

Returns:

the facet field suffix. Null if not facetable.

getFacetFunction

public String getFacetFunction()

Description copied from interface: JoinableSearchField

Get the facet function corresponding to this field.

Specified by:

getFacetFunction in interface JoinableSearchField

Returns:

The facet function.

getName

public String getName()

Description copied from interface: SearchField

Get the search field name.

Specified by:

getName in interface SearchField

Returns:

The search field name.