MtasSolrComponentList (MTAS 7.3.0.4-SNAPSHOT API)

java.lang.Object
- mtas.solr.handler.component.util.MtasSolrComponentList

All Implemented Interfaces:: MtasSolrComponent<CodecComponent.ComponentList>

public class MtasSolrComponentList
extends Object
implements MtasSolrComponent<CodecComponent.ComponentList>

The Class MtasSolrComponentList.

Field Summary

Fields
Modifier and Type	Field and Description
`private static org.apache.commons.logging.Log`	`log` The Constant log.
`static String`	`NAME` The Constant NAME.
`static String`	`NAME_MTAS_LIST_FIELD` The Constant NAME_MTAS_LIST_FIELD.
`static String`	`NAME_MTAS_LIST_KEY` The Constant NAME_MTAS_LIST_KEY.
`static String`	`NAME_MTAS_LIST_LEFT` The Constant NAME_MTAS_LIST_LEFT.
`static String`	`NAME_MTAS_LIST_NUMBER` The Constant NAME_MTAS_LIST_NUMBER.
`static String`	`NAME_MTAS_LIST_OUTPUT` The Constant NAME_MTAS_LIST_OUTPUT.
`static String`	`NAME_MTAS_LIST_PREFIX` The Constant NAME_MTAS_LIST_PREFIX.
`static String`	`NAME_MTAS_LIST_QUERY_IGNORE` The Constant NAME_MTAS_LIST_QUERY_IGNORE.
`static String`	`NAME_MTAS_LIST_QUERY_MAXIMUM_IGNORE_LENGTH` The Constant NAME_MTAS_LIST_QUERY_MAXIMUM_IGNORE_LENGTH.
`static String`	`NAME_MTAS_LIST_QUERY_PREFIX` The Constant NAME_MTAS_LIST_QUERY_PREFIX.
`static String`	`NAME_MTAS_LIST_QUERY_TYPE` The Constant NAME_MTAS_LIST_QUERY_TYPE.
`static String`	`NAME_MTAS_LIST_QUERY_VALUE` The Constant NAME_MTAS_LIST_QUERY_VALUE.
`static String`	`NAME_MTAS_LIST_QUERY_VARIABLE` The Constant NAME_MTAS_LIST_QUERY_VARIABLE.
`static String`	`NAME_MTAS_LIST_RIGHT` The Constant NAME_MTAS_LIST_RIGHT.
`static String`	`NAME_MTAS_LIST_START` The Constant NAME_MTAS_LIST_START.
`static String`	`PARAM_MTAS_LIST` The Constant PARAM_MTAS_LIST.
`(package private) MtasSolrSearchComponent`	`searchComponent` The search component.
`static String`	`SUBNAME_MTAS_LIST_QUERY_VARIABLE_NAME` The Constant SUBNAME_MTAS_LIST_QUERY_VARIABLE_NAME.
`static String`	`SUBNAME_MTAS_LIST_QUERY_VARIABLE_VALUE` The Constant SUBNAME_MTAS_LIST_QUERY_VARIABLE_VALUE.

Constructor Summary

Constructors
Constructor and Description

MtasSolrComponentList(MtasSolrSearchComponent searchComponent)
Instantiates a new mtas solr component list.

Constructors
Constructor and Description
`MtasSolrComponentList(MtasSolrSearchComponent searchComponent)` Instantiates a new mtas solr component list.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.apache.solr.common.util.SimpleOrderedMap<Object>`	`create(CodecComponent.ComponentList list, Boolean encode)` Creates the.
`void`	`distributedProcess(org.apache.solr.handler.component.ResponseBuilder rb, CodecComponent.ComponentFields mtasFields)` Distributed process.
`void`	`finishStage(org.apache.solr.handler.component.ResponseBuilder rb)` Finish stage.
`void`	`modifyRequest(org.apache.solr.handler.component.ResponseBuilder rb, org.apache.solr.handler.component.SearchComponent who, org.apache.solr.handler.component.ShardRequest sreq)` Modify request.
`void`	`prepare(org.apache.solr.handler.component.ResponseBuilder rb, CodecComponent.ComponentFields mtasFields)` Prepare.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - log
```
private static final org.apache.commons.logging.Log log
```
    The Constant log.
  - NAME
```
public static final String NAME
```
    The Constant NAME.
    
    See Also:
    
    Constant Field Values
  - searchComponent
```
MtasSolrSearchComponent searchComponent
```
    The search component.
  - PARAM_MTAS_LIST
```
public static final String PARAM_MTAS_LIST
```
    The Constant PARAM_MTAS_LIST.
    
    See Also:
    
    Constant Field Values
  - NAME_MTAS_LIST_FIELD
```
public static final String NAME_MTAS_LIST_FIELD
```
    The Constant NAME_MTAS_LIST_FIELD.
    
    See Also:
    
    Constant Field Values
  - NAME_MTAS_LIST_QUERY_TYPE
```
public static final String NAME_MTAS_LIST_QUERY_TYPE
```
    The Constant NAME_MTAS_LIST_QUERY_TYPE.
    
    See Also:
    
    Constant Field Values
  - NAME_MTAS_LIST_QUERY_VALUE
```
public static final String NAME_MTAS_LIST_QUERY_VALUE
```
    The Constant NAME_MTAS_LIST_QUERY_VALUE.
    
    See Also:
    
    Constant Field Values
  - NAME_MTAS_LIST_QUERY_PREFIX
```
public static final String NAME_MTAS_LIST_QUERY_PREFIX
```
    The Constant NAME_MTAS_LIST_QUERY_PREFIX.
    
    See Also:
    
    Constant Field Values
  - NAME_MTAS_LIST_QUERY_IGNORE
```
public static final String NAME_MTAS_LIST_QUERY_IGNORE
```
    The Constant NAME_MTAS_LIST_QUERY_IGNORE.
    
    See Also:
    
    Constant Field Values
  - NAME_MTAS_LIST_QUERY_MAXIMUM_IGNORE_LENGTH
```
public static final String NAME_MTAS_LIST_QUERY_MAXIMUM_IGNORE_LENGTH
```
    The Constant NAME_MTAS_LIST_QUERY_MAXIMUM_IGNORE_LENGTH.
    
    See Also:
    
    Constant Field Values
  - NAME_MTAS_LIST_QUERY_VARIABLE
```
public static final String NAME_MTAS_LIST_QUERY_VARIABLE
```
    The Constant NAME_MTAS_LIST_QUERY_VARIABLE.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_LIST_QUERY_VARIABLE_NAME
```
public static final String SUBNAME_MTAS_LIST_QUERY_VARIABLE_NAME
```
    The Constant SUBNAME_MTAS_LIST_QUERY_VARIABLE_NAME.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_LIST_QUERY_VARIABLE_VALUE
```
public static final String SUBNAME_MTAS_LIST_QUERY_VARIABLE_VALUE
```
    The Constant SUBNAME_MTAS_LIST_QUERY_VARIABLE_VALUE.
    
    See Also:
    
    Constant Field Values
  - NAME_MTAS_LIST_KEY
```
public static final String NAME_MTAS_LIST_KEY
```
    The Constant NAME_MTAS_LIST_KEY.
    
    See Also:
    
    Constant Field Values
  - NAME_MTAS_LIST_PREFIX
```
public static final String NAME_MTAS_LIST_PREFIX
```
    The Constant NAME_MTAS_LIST_PREFIX.
    
    See Also:
    
    Constant Field Values
  - NAME_MTAS_LIST_START
```
public static final String NAME_MTAS_LIST_START
```
    The Constant NAME_MTAS_LIST_START.
    
    See Also:
    
    Constant Field Values
  - NAME_MTAS_LIST_NUMBER
```
public static final String NAME_MTAS_LIST_NUMBER
```
    The Constant NAME_MTAS_LIST_NUMBER.
    
    See Also:
    
    Constant Field Values
  - NAME_MTAS_LIST_LEFT
```
public static final String NAME_MTAS_LIST_LEFT
```
    The Constant NAME_MTAS_LIST_LEFT.
    
    See Also:
    
    Constant Field Values
  - NAME_MTAS_LIST_RIGHT
```
public static final String NAME_MTAS_LIST_RIGHT
```
    The Constant NAME_MTAS_LIST_RIGHT.
    
    See Also:
    
    Constant Field Values
  - NAME_MTAS_LIST_OUTPUT
```
public static final String NAME_MTAS_LIST_OUTPUT
```
    The Constant NAME_MTAS_LIST_OUTPUT.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MtasSolrComponentList
```
public MtasSolrComponentList(MtasSolrSearchComponent searchComponent)
```
    Instantiates a new mtas solr component list.
    
    Parameters:
    
    searchComponent - the search component
- Method Detail
  - prepare
```
public void prepare(org.apache.solr.handler.component.ResponseBuilder rb,
                    CodecComponent.ComponentFields mtasFields)
             throws IOException
```
    Description copied from interface: MtasSolrComponent
    
    Prepare.
    
    Specified by:
    
    prepare in interface MtasSolrComponent<CodecComponent.ComponentList>
    
    Parameters:
    
    rb - the rb
    
    mtasFields - the mtas fields
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - modifyRequest
```
public void modifyRequest(org.apache.solr.handler.component.ResponseBuilder rb,
                          org.apache.solr.handler.component.SearchComponent who,
                          org.apache.solr.handler.component.ShardRequest sreq)
```
    Description copied from interface: MtasSolrComponent
    
    Modify request.
    
    Specified by:
    
    modifyRequest in interface MtasSolrComponent<CodecComponent.ComponentList>
    
    Parameters:
    
    rb - the rb
    
    who - the who
    
    sreq - the sreq
  - distributedProcess
```
public void distributedProcess(org.apache.solr.handler.component.ResponseBuilder rb,
                               CodecComponent.ComponentFields mtasFields)
```
    Description copied from interface: MtasSolrComponent
    
    Distributed process.
    
    Specified by:
    
    distributedProcess in interface MtasSolrComponent<CodecComponent.ComponentList>
    
    Parameters:
    
    rb - the rb
    
    mtasFields - the mtas fields
  - create
```
public org.apache.solr.common.util.SimpleOrderedMap<Object> create(CodecComponent.ComponentList list,
                                                                   Boolean encode)
```
    Description copied from interface: MtasSolrComponent
    
    Creates the.
    
    Specified by:
    
    create in interface MtasSolrComponent<CodecComponent.ComponentList>
    
    Parameters:
    
    list - the response
    
    encode - the encode
    
    Returns:
    
    the simple ordered map
  - finishStage
```
public void finishStage(org.apache.solr.handler.component.ResponseBuilder rb)
```
    Description copied from interface: MtasSolrComponent
    
    Finish stage.
    
    Specified by:
    
    finishStage in interface MtasSolrComponent<CodecComponent.ComponentList>
    
    Parameters:
    
    rb - the rb

Class MtasSolrComponentList

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

NAME

searchComponent

PARAM_MTAS_LIST

NAME_MTAS_LIST_FIELD

NAME_MTAS_LIST_QUERY_TYPE

NAME_MTAS_LIST_QUERY_VALUE

NAME_MTAS_LIST_QUERY_PREFIX

NAME_MTAS_LIST_QUERY_IGNORE

NAME_MTAS_LIST_QUERY_MAXIMUM_IGNORE_LENGTH

NAME_MTAS_LIST_QUERY_VARIABLE

SUBNAME_MTAS_LIST_QUERY_VARIABLE_NAME

SUBNAME_MTAS_LIST_QUERY_VARIABLE_VALUE

NAME_MTAS_LIST_KEY

NAME_MTAS_LIST_PREFIX

NAME_MTAS_LIST_START

NAME_MTAS_LIST_NUMBER

NAME_MTAS_LIST_LEFT

NAME_MTAS_LIST_RIGHT

NAME_MTAS_LIST_OUTPUT

Constructor Detail

MtasSolrComponentList

Method Detail

prepare

modifyRequest

distributedProcess

create

finishStage