Package org.opencms.jsp.search.config.parser.simplesearch.preconfiguredrestrictions

Class CmsRestrictionRule

java.lang.Object

org.opencms.jsp.search.config.parser.simplesearch.preconfiguredrestrictions.CmsRestrictionRule

public class CmsRestrictionRule
extends Object

A single restriction rule, telling for which field and type what kind of restriction should be enforced.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CmsRestrictionRule.MatchType	Match type of the restriction, i.e., how the values should be treated.

Constructor Summary

Constructors

Constructor	Description
CmsRestrictionRule(String field)	Constructs a restriction rule for the provided field that has no type restriction and default combination mode and match type.
CmsRestrictionRule(String field, String type, CmsRestrictionRule.MatchType matchType, CmsConfigurationBean.CombinationMode combinationModeBetweenFields, CmsConfigurationBean.CombinationMode combinationModeInField)	Constructs restriction rule with the provided settings.

Method Summary

Modifier and Type	Method	Description
CmsConfigurationBean.CombinationMode	getCombinationModeBetweenFields()	Returns the way values of different input fields are combined (match any or all).
CmsConfigurationBean.CombinationMode	getCombinationModeInField()	Returns the way values of different input fields are combined (match any or all).
String	getFieldForLocale(Locale l)	Returns the name of the solr field, the restrictions should be enforced on for, dependent on the provided locale.
CmsRestrictionRule.MatchType	getMatchType()	Returns the match type for values, e.g., exact, as-is, prefix, ....
String	getRawField()	Returns the name of the solr field, the restrictions should be enforced on, but without resolving the locale placeholder.
String	getType()	Returns the name of the resource type, the restriction should be enforced for.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsRestrictionRule

public CmsRestrictionRule(String field)

Constructs a restriction rule for the provided field that has no type restriction and default combination mode and match type.

Parameters:

field - the field to put the restriction on.

CmsRestrictionRule

public CmsRestrictionRule(String field,
 String type,
 CmsRestrictionRule.MatchType matchType,
 CmsConfigurationBean.CombinationMode combinationModeBetweenFields,
 CmsConfigurationBean.CombinationMode combinationModeInField)

Constructs restriction rule with the provided settings.

Parameters:

field - the field the restriction has to be enforced on.

type - the resource type the restriction should be enforced on.

matchType - the way how values should be treated.

combinationModeBetweenFields - the way how values in different fields should be combined.

combinationModeInField - the way how values in different fields in one field should be combined.

Method Details

getCombinationModeBetweenFields

public CmsConfigurationBean.CombinationMode getCombinationModeBetweenFields()

Returns the way values of different input fields are combined (match any or all).

Returns:

the way values of different input fields are combined (match any or all).

getCombinationModeInField

public CmsConfigurationBean.CombinationMode getCombinationModeInField()

Returns the way values of different input fields are combined (match any or all).

Returns:

the way values of different input fields are combined (match any or all).

getFieldForLocale

public String getFieldForLocale(Locale l)

Returns the name of the solr field, the restrictions should be enforced on for, dependent on the provided locale.

Parameters:

l - the search locale.

Returns:

the name of the solr field, the restrictions should be enforced on for, dependent on the provided locale.

getMatchType

public CmsRestrictionRule.MatchType getMatchType()

Returns the match type for values, e.g., exact, as-is, prefix, ....

Returns:

the match type for values, e.g., exact, as-is, prefix, ....

getRawField

public String getRawField()

Returns the name of the solr field, the restrictions should be enforced on, but without resolving the locale placeholder.

Returns:

the name of the solr field, the restrictions should be enforced on, but without resolving the locale placeholder.

getType

public String getType()

Returns the name of the resource type, the restriction should be enforced for.

Returns:

the resource type, the restriction should be enforced for. null is returned iff the restriction should hold for all resource types.