Package io.jmix.searchui.component.impl

Class FullTextFilterImpl

java.lang.Object

io.jmix.ui.component.CompositeComponent<HBoxLayout>

io.jmix.ui.component.impl.AbstractSingleFilterComponent<String>

io.jmix.searchui.component.impl.FullTextFilterImpl

All Implemented Interfaces:

FullTextFilter, AttachNotifier, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, CompositeWithCaption, CompositeWithDescription, CompositeWithHtmlCaption, CompositeWithHtmlDescription, FilterComponent, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasValue<String>, Requirable, SingleFilterComponent<String>, SupportsCaptionPosition, Validatable

public class FullTextFilterImpl
extends AbstractSingleFilterComponent<String>
implements FullTextFilter

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.component.CompositeComponent

CompositeComponent.CreateEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface io.jmix.ui.component.SupportsCaptionPosition

SupportsCaptionPosition.CaptionPosition

Field Summary

Fields

Modifier and Type	Field	Description
protected String	correctWhere
protected EntitySearcher	entitySearcher
protected static final String	FULL_TEXT_FILTER_STYLENAME
protected IdSerialization	idSerialization
protected JpqlFilterSupport	jpqlFilterSupport
protected String	parameterName
protected SearchStrategy	searchStrategy
protected SearchStrategyManager	searchStrategyManager

Fields inherited from class io.jmix.ui.component.impl.AbstractSingleFilterComponent

autoApply, caption, captionLabel, captionPosition, captionVisible, captionWidth, conditionModificationDelegated, dataLoader, icon, queryCondition, TRUNCATED_CAPTION_STYLENAME, uiComponents, valueComponent

Fields inherited from class io.jmix.ui.component.CompositeComponent

applicationContext, frame, id, prefixId, root

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Fields inherited from interface io.jmix.searchui.component.FullTextFilter

NAME

Constructor Summary

Constructors

Constructor	Description
FullTextFilterImpl()

Method Summary

Modifier and Type	Method	Description
protected Condition	createQueryCondition()
CollectionLoader	getDataLoader()
String	getInnerComponentPrefix()
String	getParameterName()
JpqlCondition	getQueryCondition()
SearchStrategy	getSearchStrategy()	Returns a SearchStrategy that will be used for searching using this component.
protected void	initRootComponent(HBoxLayout root)
void	setDataLoader(DataLoader dataLoader)	Sets a DataLoader related to the current filter component.
void	setEntitySearcher(EntitySearcher entitySearcher)
void	setIdSerialization(IdSerialization idSerialization)
void	setJpqlFilterSupport(JpqlFilterSupport jpqlFilterSupport)
void	setParameterName(String parameterName)	Sets the name of the associated query parameter name.
void	setSearchStrategy(SearchStrategy searchStrategy)
void	setSearchStrategyManager(SearchStrategyManager searchStrategyManager)
protected void	updateQueryCondition(String newValue)

Methods inherited from class io.jmix.ui.component.impl.AbstractSingleFilterComponent

addValueChangeListener, apply, checkValueComponentState, createCaptionLabel, createRootComponent, focus, getCaption, getCaptionPosition, getCaptionWidth, getCaptionWidthSizeUnit, getChildAlignment, getContextHelpIconClickHandler, getContextHelpText, getIcon, getIconName, getRequiredMessage, getTabIndex, getValue, getValueComponent, initValueComponent, isAutoApply, isCaptionVisible, isConditionModificationDelegated, isContextHelpTextHtmlEnabled, isEditable, isRequired, isValid, onCreate, onValueChanged, setAutoApply, setCaption, setCaptionAsHtml, setCaptionPosition, setCaptionVisible, setCaptionWidth, setConditionModificationDelegated, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setEditable, setIcon, setIconFromSet, setRequired, setRequiredMessage, setTabIndex, setUiComponentProperties, setUiComponents, setupLoaderFirstResult, setValue, setValueComponent, setWidth, updateCaption, updateCaptionLabelTruncation, updateCaptionLayout, updateChildAlignment, updateDataLoaderCondition, updateIcon, validate

Methods inherited from class io.jmix.ui.component.CompositeComponent

addAttachListener, addCreateListener, addDetachListener, addStyleName, assignDebugId, attached, detached, disableEventListeners, enableEventListeners, getAlignment, getComposition, getCompositionOrNull, getDebugId, getEventHub, getFrame, getFullId, getHeight, getHeightSizeUnit, getId, getInnerComponent, getInnerComponentOptional, getParent, getPrefixId, getStyleName, getUiEventListeners, getWidth, getWidthSizeUnit, hasSubscriptions, isAttached, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, publish, removeStyleName, setAlignment, setApplicationContext, setComposition, setDebugId, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setId, setParent, setResponsive, setStyleName, setUiEventListeners, setVisible, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, updateComponentIds, updateIdIfNeeded, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface io.jmix.ui.component.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.CompositeWithDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.CompositeWithHtmlCaption

isCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.CompositeWithHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.FilterComponent

apply, isAutoApply, isConditionModificationDelegated, setAutoApply, setConditionModificationDelegated

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

Methods inherited from interface io.jmix.ui.component.Requirable

getRequiredMessage, isRequired, setRequired, setRequiredMessage

Methods inherited from interface io.jmix.ui.component.SingleFilterComponent

getCaptionWidth, getCaptionWidthSizeUnit, getValueComponent, isCaptionVisible, setCaptionVisible, setCaptionWidth, setValueComponent

Methods inherited from interface io.jmix.ui.component.SupportsCaptionPosition

getCaptionPosition, setCaptionPosition

Methods inherited from interface io.jmix.ui.component.Validatable

isValid, isValidateOnCommit, validate

Field Details

FULL_TEXT_FILTER_STYLENAME

protected static final String FULL_TEXT_FILTER_STYLENAME

See Also:

• Constant Field Values

jpqlFilterSupport

protected JpqlFilterSupport jpqlFilterSupport

entitySearcher

protected EntitySearcher entitySearcher

idSerialization

protected IdSerialization idSerialization

parameterName

protected String parameterName

searchStrategy

protected SearchStrategy searchStrategy

searchStrategyManager

protected SearchStrategyManager searchStrategyManager

correctWhere

protected String correctWhere

Constructor Details

FullTextFilterImpl

public FullTextFilterImpl()

Method Details

setJpqlFilterSupport

@Autowired
public void setJpqlFilterSupport(JpqlFilterSupport jpqlFilterSupport)

setEntitySearcher

@Autowired
public void setEntitySearcher(EntitySearcher entitySearcher)

setIdSerialization

@Autowired
public void setIdSerialization(IdSerialization idSerialization)

setSearchStrategyManager

@Autowired
public void setSearchStrategyManager(SearchStrategyManager searchStrategyManager)

initRootComponent

protected void initRootComponent(HBoxLayout root)

Overrides:

initRootComponent in class AbstractSingleFilterComponent<String>

setDataLoader

public void setDataLoader(DataLoader dataLoader)

Description copied from interface: FilterComponent

Sets a DataLoader related to the current filter component.

Specified by:

setDataLoader in interface FilterComponent

Overrides:

setDataLoader in class AbstractSingleFilterComponent<String>

Parameters:

dataLoader - a DataLoader to set

createQueryCondition

protected Condition createQueryCondition()

Specified by:

createQueryCondition in class AbstractSingleFilterComponent<String>

getInnerComponentPrefix

public String getInnerComponentPrefix()

Specified by:

getInnerComponentPrefix in class AbstractSingleFilterComponent<String>

updateQueryCondition

protected void updateQueryCondition(@Nullable
 String newValue)

Specified by:

updateQueryCondition in class AbstractSingleFilterComponent<String>

getQueryCondition

public JpqlCondition getQueryCondition()

Specified by:

getQueryCondition in interface FilterComponent

Overrides:

getQueryCondition in class AbstractSingleFilterComponent<String>

Returns:

a Condition related to the current filter component

getDataLoader

public CollectionLoader getDataLoader()

Specified by:

getDataLoader in interface FilterComponent

Overrides:

getDataLoader in class AbstractSingleFilterComponent<String>

Returns:

a DataLoader related to the current filter component

getParameterName

public String getParameterName()

Specified by:

getParameterName in interface SingleFilterComponent<String>

Returns:

the name of the associated query parameter name

setParameterName

public void setParameterName(String parameterName)

Description copied from interface: SingleFilterComponent

Sets the name of the associated query parameter name.

Specified by:

setParameterName in interface SingleFilterComponent<String>

Parameters:

parameterName - a name of the associated query parameter name

getSearchStrategy

public SearchStrategy getSearchStrategy()

Description copied from interface: FullTextFilter

Returns a SearchStrategy that will be used for searching using this component. If no explicit strategy is set to the full-text filter then a default strategy will be used.

Specified by:

getSearchStrategy in interface FullTextFilter

Returns:

a SearchStrategy or null if the strategy is not explicitly set

See Also:

• SearchStrategyManager.getDefaultSearchStrategy()

setSearchStrategy

public void setSearchStrategy(@Nullable
 SearchStrategy searchStrategy)

Specified by:

setSearchStrategy in interface FullTextFilter