Class QueryNodeProcessorPipeline
- java.lang.Object
-
- org.apache.lucene.queryparser.flexible.core.processors.QueryNodeProcessorPipeline
-
- All Implemented Interfaces:
java.lang.Iterable<QueryNodeProcessor>
,java.util.Collection<QueryNodeProcessor>
,java.util.List<QueryNodeProcessor>
,QueryNodeProcessor
- Direct Known Subclasses:
StandardQueryNodeProcessorPipeline
public class QueryNodeProcessorPipeline extends java.lang.Object implements QueryNodeProcessor, java.util.List<QueryNodeProcessor>
AQueryNodeProcessorPipeline
class should be used to build a query node processor pipeline. When a query node tree is processed using this class, it passes the query node tree to each processor on the pipeline and the result from each processor is passed to the next one, always following the order the processors were on the pipeline. When aQueryConfigHandler
object is set on aQueryNodeProcessorPipeline
, it also takes care of setting thisQueryConfigHandler
on all processor on pipeline.
-
-
Constructor Summary
Constructors Constructor Description QueryNodeProcessorPipeline()
Constructs an empty query node processor pipeline.QueryNodeProcessorPipeline(QueryConfigHandler queryConfigHandler)
Constructs with aQueryConfigHandler
object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(int index, QueryNodeProcessor processor)
boolean
add(QueryNodeProcessor processor)
boolean
addAll(int index, java.util.Collection<? extends QueryNodeProcessor> c)
boolean
addAll(java.util.Collection<? extends QueryNodeProcessor> c)
void
clear()
boolean
contains(java.lang.Object o)
boolean
containsAll(java.util.Collection<?> c)
QueryNodeProcessor
get(int index)
QueryConfigHandler
getQueryConfigHandler()
For reference about this method check:QueryNodeProcessor.getQueryConfigHandler()
.int
indexOf(java.lang.Object o)
boolean
isEmpty()
java.util.Iterator<QueryNodeProcessor>
iterator()
int
lastIndexOf(java.lang.Object o)
java.util.ListIterator<QueryNodeProcessor>
listIterator()
java.util.ListIterator<QueryNodeProcessor>
listIterator(int index)
QueryNode
process(QueryNode queryTree)
For reference about this method check:QueryNodeProcessor.process(QueryNode)
.QueryNodeProcessor
remove(int index)
boolean
remove(java.lang.Object o)
boolean
removeAll(java.util.Collection<?> c)
boolean
retainAll(java.util.Collection<?> c)
QueryNodeProcessor
set(int index, QueryNodeProcessor processor)
void
setQueryConfigHandler(QueryConfigHandler queryConfigHandler)
For reference about this method check:QueryNodeProcessor.setQueryConfigHandler(QueryConfigHandler)
.int
size()
java.util.List<QueryNodeProcessor>
subList(int fromIndex, int toIndex)
java.lang.Object[]
toArray()
<T> T[]
toArray(T[] array)
-
-
-
Constructor Detail
-
QueryNodeProcessorPipeline
public QueryNodeProcessorPipeline()
Constructs an empty query node processor pipeline.
-
QueryNodeProcessorPipeline
public QueryNodeProcessorPipeline(QueryConfigHandler queryConfigHandler)
Constructs with aQueryConfigHandler
object.
-
-
Method Detail
-
getQueryConfigHandler
public QueryConfigHandler getQueryConfigHandler()
For reference about this method check:QueryNodeProcessor.getQueryConfigHandler()
.- Specified by:
getQueryConfigHandler
in interfaceQueryNodeProcessor
- Returns:
- QueryConfigHandler the query configuration handler to be set.
- See Also:
QueryNodeProcessor.setQueryConfigHandler(QueryConfigHandler)
,QueryConfigHandler
-
process
public QueryNode process(QueryNode queryTree) throws QueryNodeException
For reference about this method check:QueryNodeProcessor.process(QueryNode)
.- Specified by:
process
in interfaceQueryNodeProcessor
- Parameters:
queryTree
- the query node tree to be processed- Returns:
- the processed query tree
- Throws:
QueryNodeException
- if something goes wrong during the query node processing- See Also:
QueryNode
-
setQueryConfigHandler
public void setQueryConfigHandler(QueryConfigHandler queryConfigHandler)
For reference about this method check:QueryNodeProcessor.setQueryConfigHandler(QueryConfigHandler)
.- Specified by:
setQueryConfigHandler
in interfaceQueryNodeProcessor
- Parameters:
queryConfigHandler
- the query configuration handler to be set.- See Also:
QueryNodeProcessor.getQueryConfigHandler()
,QueryConfigHandler
-
add
public boolean add(QueryNodeProcessor processor)
- Specified by:
add
in interfacejava.util.Collection<QueryNodeProcessor>
- Specified by:
add
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.add(Object)
-
add
public void add(int index, QueryNodeProcessor processor)
- Specified by:
add
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.add(int, Object)
-
addAll
public boolean addAll(java.util.Collection<? extends QueryNodeProcessor> c)
- Specified by:
addAll
in interfacejava.util.Collection<QueryNodeProcessor>
- Specified by:
addAll
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.addAll(Collection)
-
addAll
public boolean addAll(int index, java.util.Collection<? extends QueryNodeProcessor> c)
- Specified by:
addAll
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.addAll(int, Collection)
-
clear
public void clear()
- Specified by:
clear
in interfacejava.util.Collection<QueryNodeProcessor>
- Specified by:
clear
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.clear()
-
contains
public boolean contains(java.lang.Object o)
- Specified by:
contains
in interfacejava.util.Collection<QueryNodeProcessor>
- Specified by:
contains
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.contains(Object)
-
containsAll
public boolean containsAll(java.util.Collection<?> c)
- Specified by:
containsAll
in interfacejava.util.Collection<QueryNodeProcessor>
- Specified by:
containsAll
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.containsAll(Collection)
-
get
public QueryNodeProcessor get(int index)
- Specified by:
get
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.get(int)
-
indexOf
public int indexOf(java.lang.Object o)
- Specified by:
indexOf
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.indexOf(Object)
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfacejava.util.Collection<QueryNodeProcessor>
- Specified by:
isEmpty
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.isEmpty()
-
iterator
public java.util.Iterator<QueryNodeProcessor> iterator()
- Specified by:
iterator
in interfacejava.util.Collection<QueryNodeProcessor>
- Specified by:
iterator
in interfacejava.lang.Iterable<QueryNodeProcessor>
- Specified by:
iterator
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.iterator()
-
lastIndexOf
public int lastIndexOf(java.lang.Object o)
- Specified by:
lastIndexOf
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.lastIndexOf(Object)
-
listIterator
public java.util.ListIterator<QueryNodeProcessor> listIterator()
- Specified by:
listIterator
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.listIterator()
-
listIterator
public java.util.ListIterator<QueryNodeProcessor> listIterator(int index)
- Specified by:
listIterator
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.listIterator(int)
-
remove
public boolean remove(java.lang.Object o)
- Specified by:
remove
in interfacejava.util.Collection<QueryNodeProcessor>
- Specified by:
remove
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.remove(Object)
-
remove
public QueryNodeProcessor remove(int index)
- Specified by:
remove
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.remove(int)
-
removeAll
public boolean removeAll(java.util.Collection<?> c)
- Specified by:
removeAll
in interfacejava.util.Collection<QueryNodeProcessor>
- Specified by:
removeAll
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.removeAll(Collection)
-
retainAll
public boolean retainAll(java.util.Collection<?> c)
- Specified by:
retainAll
in interfacejava.util.Collection<QueryNodeProcessor>
- Specified by:
retainAll
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.retainAll(Collection)
-
set
public QueryNodeProcessor set(int index, QueryNodeProcessor processor)
- Specified by:
set
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.set(int, Object)
-
size
public int size()
- Specified by:
size
in interfacejava.util.Collection<QueryNodeProcessor>
- Specified by:
size
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.size()
-
subList
public java.util.List<QueryNodeProcessor> subList(int fromIndex, int toIndex)
- Specified by:
subList
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.subList(int, int)
-
toArray
public <T> T[] toArray(T[] array)
- Specified by:
toArray
in interfacejava.util.Collection<QueryNodeProcessor>
- Specified by:
toArray
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.toArray(Object[])
-
toArray
public java.lang.Object[] toArray()
- Specified by:
toArray
in interfacejava.util.Collection<QueryNodeProcessor>
- Specified by:
toArray
in interfacejava.util.List<QueryNodeProcessor>
- See Also:
List.toArray()
-
-