|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.4.0) E15995-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.webcenter.search.refine.Refiner<T>
public abstract class Refiner<T>
A abstract base class that captures what is necessary to implement Navigated searches. It is driven by a QName to indicate which column within the Row in the QueryResult, it can navigate over. It holds a list of Refinements that perform the actual modification of the Predicates in a Query.
Constructor Summary | |
---|---|
Refiner(QName name, java.util.Map<T,java.lang.Integer> counters) Constructs a Refiner with a qualified name for column and a Map of counters for how many times a value of type T appears in the result. |
Method Summary | |
---|---|
void |
addRefinements(java.util.List<Refinement<T>> refinements) Adds a list of Refinements to this Refiner. |
protected abstract Refinement<T> |
createRefinement(T key, int count) Type aware subclasses will implement this to create new concrete subclasses of Refinement<T> |
QName |
getName() Gets the name of the Refiner which signifies the column name of the Row being navigated over. |
java.util.List<Refinement<T>> |
getRefinements() Returns a list of all the Refinements for this Refiner. |
Refinement<T> |
lookupRefinement(java.lang.String name) Lookup a refinement by name. |
void |
organize(RefinementOrganizer organizer) The Refiner drives the organize by taking in a RefinementOrganizer. |
java.lang.String |
toString() |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Refiner(QName name, java.util.Map<T,java.lang.Integer> counters)
name
- the QName that describes the column being navigated overcounters
- a Map of counters keyed by the values available for navigation overMethod Detail |
---|
public java.util.List<Refinement<T>> getRefinements()
public QName getName()
protected abstract Refinement<T> createRefinement(T key, int count)
key
- the value to create the refinement with - currently we only support creating with one value (as opposed to a List of them) within the Refiner consumption.count
- number of times this value appearedpublic final Refinement<T> lookupRefinement(java.lang.String name)
name
- the name of the Refinement within this Refinerpublic void addRefinements(java.util.List<Refinement<T>> refinements)
refinements
- the List of Refinement of type T to add to this Refinerpublic void organize(RefinementOrganizer organizer)
organizer
- a RefinementOrganizer that is used to re-arrange the list of Refinements in this Refinerpublic java.lang.String toString()
toString
in class java.lang.Object
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.4.0) E15995-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |