oracle.webcenter.search.refine

Class StringRefiner

java.lang.Object

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

oracle.webcenter.search.refine.StringRefiner

All Implemented Interfaces:

java.io.Serializable

public class StringRefiner
extends Refiner<java.lang.String>

The StringRefiner is a String subclass of the base Refiner class that focuses on Modifiers of the String type.

Since:

11.1.1.0.0 Beta 2

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StringRefiner(QName column, java.util.Map<java.lang.String,java.lang.Integer> counters) Constructs a StringRefiner on a column with a map of counters registering counts for each String value.
StringRefiner(QName column, java.lang.String comparator, java.util.Map<java.lang.String,java.lang.Integer> counters) Constructs a StringRefiner on a column with a map of counters registering counts for each String value.

Method Summary

Modifier and Type	Method and Description
protected Refinement<java.lang.String>	createRefinement(java.lang.String key, int count) The only responsbility of the StringRefiner subclass is to create a Refinement of type String; so we just return a new StringRefinement.

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

addRefinements, consumeCounters, getName, getRefinements, lookupRefinement, organize, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StringRefiner

public StringRefiner(QName column,
                     java.lang.String comparator,
                     java.util.Map<java.lang.String,java.lang.Integer> counters)

Constructs a StringRefiner on a column with a map of counters registering counts for each String value.

Parameters:

column - the qualified QName of a column in a Row of results

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

counters - a Map of counters keyed by a String value

StringRefiner

public StringRefiner(QName column,
                     java.util.Map<java.lang.String,java.lang.Integer> counters)

Constructs a StringRefiner on a column with a map of counters registering counts for each String value.

Parameters:

column - the qualified QName of a column in a Row of results

counters - a Map of counters keyed by a String value

Method Detail

createRefinement

protected Refinement<java.lang.String> createRefinement(java.lang.String key,
                                                        int count)

The only responsbility of the StringRefiner subclass is to create a Refinement of type String; so we just return a new StringRefinement.

Specified by:

createRefinement in class Refiner<java.lang.String>

Parameters:

key - the String value to create the StringRefinement with

count - how many times has this String been used?

Returns:

a Refinement of type T