oracle.webcenter.search.refine

Class StringRefinement

java.lang.Object

oracle.webcenter.search.refine.Refinement<java.lang.String>

oracle.webcenter.search.refine.StringRefinement

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StringRefinement
extends Refinement<java.lang.String>

A String based refinement that captures a lot of the logic Strings go through when used as Refiners for a search.

Since:

11.1.1.0.0 Beta 2

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class oracle.webcenter.search.refine.Refinement

Refinement.Clause<T>

Constructor Summary

Constructors

Constructor and Description
StringRefinement(java.util.List<Refinement.Clause<java.lang.String>> clauses, int count) Constructs a StringRefinement with a List of clauses and a count.
StringRefinement(java.lang.String value, int count) Constructs a StringRefinement with a List of clauses and a count.
StringRefinement(java.lang.String value, java.lang.String comparator, int count) Constructs a StringRefinement with a List of clauses and a count.

Method Summary

Modifier and Type	Method and Description
protected void	buildName(java.lang.String value) Builds the name of the StringRefinement with a String value.
ComplexPredicate.ConjunctionOp	getConjunctionOp() When we have a ComplexPredicate built using StringRefinements, the default is an OR, which supports operations like "user in {user1,user2}"
boolean	hasMatch(java.lang.String value) Returns whether the String value passed in matches the criteria held in this Refinement.

Methods inherited from class oracle.webcenter.search.refine.Refinement

addAttributePredicate, buildName, buildName, createPredicate, getClauses, getCount, getName, getValue, increment, increment, initClauses, isCurrent, refine, setCount, setCurrent, setName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StringRefinement

public StringRefinement(java.util.List<Refinement.Clause<java.lang.String>> clauses,
                        int count)

Constructs a StringRefinement with a List of clauses and a count.

Parameters:

clauses - the List off Refinement.Clause objects to be used in this Refinement.

count - the number of results expected when this StringRefinement is applied

StringRefinement

public StringRefinement(java.lang.String value,
                        java.lang.String comparator,
                        int count)

Constructs a StringRefinement with a List of clauses and a count.

Parameters:

value - the String value we want to the clause to test equality with

comparator - a comparator to override the default EQUALS, e.g. CONTAINS

count - the number of results expected when this StringRefinement is applied

StringRefinement

public StringRefinement(java.lang.String value,
                        int count)

Constructs a StringRefinement with a List of clauses and a count.

Parameters:

value - the String value we want to the clause to test equality with

count - the number of results expected when this StringRefinement is applied

Method Detail

getConjunctionOp

public ComplexPredicate.ConjunctionOp getConjunctionOp()

When we have a ComplexPredicate built using StringRefinements, the default is an OR, which supports operations like "user in {user1,user2}"

Specified by:

getConjunctionOp in class Refinement<java.lang.String>

Returns:

a ConjunctionOp that is either ConjunctionOp.And or ConjunctionOp.Or

buildName

protected void buildName(java.lang.String value)

Builds the name of the StringRefinement with a String value.

Specified by:

buildName in class Refinement<java.lang.String>

Parameters:

value - the String value to use to build the name

hasMatch

public boolean hasMatch(java.lang.String value)

Returns whether the String value passed in matches the criteria held in this Refinement.

Specified by:

hasMatch in class Refinement<java.lang.String>

Parameters:

value - the String value to be matched.

Returns:

true if the value falls within the range defined by this Refinement.