MtasSolrComponentFacet (MTAS 7.3.0.4-SNAPSHOT API)

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

All Implemented Interfaces:: MtasSolrComponent<CodecComponent.ComponentFacet>

public class MtasSolrComponentFacet
extends Object
implements MtasSolrComponent<CodecComponent.ComponentFacet>

The Class MtasSolrComponentFacet.

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.
`private static String`	`NAME_MTAS_FACET_BASE` The Constant NAME_MTAS_FACET_BASE.
`static String`	`NAME_MTAS_FACET_FIELD` The Constant NAME_MTAS_FACET_FIELD.
`static String`	`NAME_MTAS_FACET_KEY` The Constant NAME_MTAS_FACET_KEY.
`private static String`	`NAME_MTAS_FACET_QUERY` The Constant NAME_MTAS_FACET_QUERY.
`static String`	`PARAM_MTAS_FACET` The Constant PARAM_MTAS_FACET.
`(package private) MtasSolrSearchComponent`	`searchComponent` The search component.
`static String`	`SUBNAME_MTAS_FACET_BASE_FIELD` The Constant SUBNAME_MTAS_FACET_BASE_FIELD.
`static String`	`SUBNAME_MTAS_FACET_BASE_FUNCTION` The Constant SUBNAME_MTAS_FACET_BASE_FUNCTION.
`static String`	`SUBNAME_MTAS_FACET_BASE_FUNCTION_EXPRESSION` The Constant SUBNAME_MTAS_FACET_BASE_FUNCTION_EXPRESSION.
`static String`	`SUBNAME_MTAS_FACET_BASE_FUNCTION_KEY` The Constant SUBNAME_MTAS_FACET_BASE_FUNCTION_KEY.
`static String`	`SUBNAME_MTAS_FACET_BASE_FUNCTION_TYPE` The Constant SUBNAME_MTAS_FACET_BASE_FUNCTION_TYPE.
`static String`	`SUBNAME_MTAS_FACET_BASE_MAXIMUM` The Constant SUBNAME_MTAS_FACET_BASE_MAXIMUM.
`static String`	`SUBNAME_MTAS_FACET_BASE_MINIMUM` The Constant SUBNAME_MTAS_FACET_BASE_MINIMUM.
`static String`	`SUBNAME_MTAS_FACET_BASE_NUMBER` The Constant SUBNAME_MTAS_FACET_BASE_NUMBER.
`static String`	`SUBNAME_MTAS_FACET_BASE_RANGE` The Constant SUBNAME_MTAS_FACET_BASE_RANGE.
`static String`	`SUBNAME_MTAS_FACET_BASE_RANGE_BASE` The Constant SUBNAME_MTAS_FACET_BASE_RANGE_BASE.
`static String`	`SUBNAME_MTAS_FACET_BASE_RANGE_SIZE` The Constant SUBNAME_MTAS_FACET_BASE_RANGE_SIZE.
`static String`	`SUBNAME_MTAS_FACET_BASE_SORT_DIRECTION` The Constant SUBNAME_MTAS_FACET_BASE_SORT_DIRECTION.
`static String`	`SUBNAME_MTAS_FACET_BASE_SORT_TYPE` The Constant SUBNAME_MTAS_FACET_BASE_SORT_TYPE.
`static String`	`SUBNAME_MTAS_FACET_BASE_TYPE` The Constant SUBNAME_MTAS_FACET_BASE_TYPE.
`static String`	`SUBNAME_MTAS_FACET_QUERY_IGNORE` The Constant SUBNAME_MTAS_FACET_QUERY_IGNORE.
`static String`	`SUBNAME_MTAS_FACET_QUERY_MAXIMUM_IGNORE_LENGTH` The Constant SUBNAME_MTAS_FACET_QUERY_MAXIMUM_IGNORE_LENGTH.
`static String`	`SUBNAME_MTAS_FACET_QUERY_PREFIX` The Constant SUBNAME_MTAS_FACET_QUERY_PREFIX.
`static String`	`SUBNAME_MTAS_FACET_QUERY_TYPE` The Constant SUBNAME_MTAS_FACET_QUERY_TYPE.
`static String`	`SUBNAME_MTAS_FACET_QUERY_VALUE` The Constant SUBNAME_MTAS_FACET_QUERY_VALUE.
`static String`	`SUBNAME_MTAS_FACET_QUERY_VARIABLE` The Constant SUBNAME_MTAS_FACET_QUERY_VARIABLE.
`static String`	`SUBNAME_MTAS_FACET_QUERY_VARIABLE_NAME` The Constant SUBNAME_MTAS_FACET_QUERY_VARIABLE_NAME.
`static String`	`SUBNAME_MTAS_FACET_QUERY_VARIABLE_VALUE` The Constant SUBNAME_MTAS_FACET_QUERY_VARIABLE_VALUE.

Constructor Summary

Constructors
Constructor and Description

MtasSolrComponentFacet(MtasSolrSearchComponent searchComponent)
Instantiates a new mtas solr component facet.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.apache.solr.common.util.SimpleOrderedMap<Object>`	`create(CodecComponent.ComponentFacet facet, 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.
`private Double`	`getDouble(String number)` Gets the double.
`private String`	`getFieldType(org.apache.solr.schema.IndexSchema schema, String field)` Gets the field type.
`private int`	`getPositiveInteger(String number)` Gets the positive integer.
`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.
  - searchComponent
```
MtasSolrSearchComponent searchComponent
```
    The search component.
  - NAME
```
public static final String NAME
```
    The Constant NAME.
    
    See Also:
    
    Constant Field Values
  - PARAM_MTAS_FACET
```
public static final String PARAM_MTAS_FACET
```
    The Constant PARAM_MTAS_FACET.
    
    See Also:
    
    Constant Field Values
  - NAME_MTAS_FACET_KEY
```
public static final String NAME_MTAS_FACET_KEY
```
    The Constant NAME_MTAS_FACET_KEY.
    
    See Also:
    
    Constant Field Values
  - NAME_MTAS_FACET_FIELD
```
public static final String NAME_MTAS_FACET_FIELD
```
    The Constant NAME_MTAS_FACET_FIELD.
    
    See Also:
    
    Constant Field Values
  - NAME_MTAS_FACET_QUERY
```
private static final String NAME_MTAS_FACET_QUERY
```
    The Constant NAME_MTAS_FACET_QUERY.
    
    See Also:
    
    Constant Field Values
  - NAME_MTAS_FACET_BASE
```
private static final String NAME_MTAS_FACET_BASE
```
    The Constant NAME_MTAS_FACET_BASE.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_QUERY_TYPE
```
public static final String SUBNAME_MTAS_FACET_QUERY_TYPE
```
    The Constant SUBNAME_MTAS_FACET_QUERY_TYPE.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_QUERY_VALUE
```
public static final String SUBNAME_MTAS_FACET_QUERY_VALUE
```
    The Constant SUBNAME_MTAS_FACET_QUERY_VALUE.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_QUERY_PREFIX
```
public static final String SUBNAME_MTAS_FACET_QUERY_PREFIX
```
    The Constant SUBNAME_MTAS_FACET_QUERY_PREFIX.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_QUERY_IGNORE
```
public static final String SUBNAME_MTAS_FACET_QUERY_IGNORE
```
    The Constant SUBNAME_MTAS_FACET_QUERY_IGNORE.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_QUERY_MAXIMUM_IGNORE_LENGTH
```
public static final String SUBNAME_MTAS_FACET_QUERY_MAXIMUM_IGNORE_LENGTH
```
    The Constant SUBNAME_MTAS_FACET_QUERY_MAXIMUM_IGNORE_LENGTH.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_QUERY_VARIABLE
```
public static final String SUBNAME_MTAS_FACET_QUERY_VARIABLE
```
    The Constant SUBNAME_MTAS_FACET_QUERY_VARIABLE.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_QUERY_VARIABLE_NAME
```
public static final String SUBNAME_MTAS_FACET_QUERY_VARIABLE_NAME
```
    The Constant SUBNAME_MTAS_FACET_QUERY_VARIABLE_NAME.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_QUERY_VARIABLE_VALUE
```
public static final String SUBNAME_MTAS_FACET_QUERY_VARIABLE_VALUE
```
    The Constant SUBNAME_MTAS_FACET_QUERY_VARIABLE_VALUE.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_BASE_FIELD
```
public static final String SUBNAME_MTAS_FACET_BASE_FIELD
```
    The Constant SUBNAME_MTAS_FACET_BASE_FIELD.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_BASE_TYPE
```
public static final String SUBNAME_MTAS_FACET_BASE_TYPE
```
    The Constant SUBNAME_MTAS_FACET_BASE_TYPE.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_BASE_SORT_TYPE
```
public static final String SUBNAME_MTAS_FACET_BASE_SORT_TYPE
```
    The Constant SUBNAME_MTAS_FACET_BASE_SORT_TYPE.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_BASE_SORT_DIRECTION
```
public static final String SUBNAME_MTAS_FACET_BASE_SORT_DIRECTION
```
    The Constant SUBNAME_MTAS_FACET_BASE_SORT_DIRECTION.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_BASE_NUMBER
```
public static final String SUBNAME_MTAS_FACET_BASE_NUMBER
```
    The Constant SUBNAME_MTAS_FACET_BASE_NUMBER.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_BASE_MINIMUM
```
public static final String SUBNAME_MTAS_FACET_BASE_MINIMUM
```
    The Constant SUBNAME_MTAS_FACET_BASE_MINIMUM.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_BASE_MAXIMUM
```
public static final String SUBNAME_MTAS_FACET_BASE_MAXIMUM
```
    The Constant SUBNAME_MTAS_FACET_BASE_MAXIMUM.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_BASE_FUNCTION
```
public static final String SUBNAME_MTAS_FACET_BASE_FUNCTION
```
    The Constant SUBNAME_MTAS_FACET_BASE_FUNCTION.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_BASE_FUNCTION_KEY
```
public static final String SUBNAME_MTAS_FACET_BASE_FUNCTION_KEY
```
    The Constant SUBNAME_MTAS_FACET_BASE_FUNCTION_KEY.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_BASE_FUNCTION_EXPRESSION
```
public static final String SUBNAME_MTAS_FACET_BASE_FUNCTION_EXPRESSION
```
    The Constant SUBNAME_MTAS_FACET_BASE_FUNCTION_EXPRESSION.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_BASE_FUNCTION_TYPE
```
public static final String SUBNAME_MTAS_FACET_BASE_FUNCTION_TYPE
```
    The Constant SUBNAME_MTAS_FACET_BASE_FUNCTION_TYPE.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_BASE_RANGE
```
public static final String SUBNAME_MTAS_FACET_BASE_RANGE
```
    The Constant SUBNAME_MTAS_FACET_BASE_RANGE.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_BASE_RANGE_SIZE
```
public static final String SUBNAME_MTAS_FACET_BASE_RANGE_SIZE
```
    The Constant SUBNAME_MTAS_FACET_BASE_RANGE_SIZE.
    
    See Also:
    
    Constant Field Values
  - SUBNAME_MTAS_FACET_BASE_RANGE_BASE
```
public static final String SUBNAME_MTAS_FACET_BASE_RANGE_BASE
```
    The Constant SUBNAME_MTAS_FACET_BASE_RANGE_BASE.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MtasSolrComponentFacet
```
public MtasSolrComponentFacet(MtasSolrSearchComponent searchComponent)
```
    Instantiates a new mtas solr component facet.
    
    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.ComponentFacet>
    
    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.ComponentFacet>
    
    Parameters:
    
    rb - the rb
    
    who - the who
    
    sreq - the sreq
  - create
```
public org.apache.solr.common.util.SimpleOrderedMap<Object> create(CodecComponent.ComponentFacet facet,
                                                                   Boolean encode)
                                                            throws IOException
```
    Description copied from interface: MtasSolrComponent
    
    Creates the.
    
    Specified by:
    
    create in interface MtasSolrComponent<CodecComponent.ComponentFacet>
    
    Parameters:
    
    facet - the response
    
    encode - the encode
    
    Returns:
    
    the simple ordered map
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - 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.ComponentFacet>
    
    Parameters:
    
    rb - the rb
  - distributedProcess
```
public void distributedProcess(org.apache.solr.handler.component.ResponseBuilder rb,
                               CodecComponent.ComponentFields mtasFields)
                        throws IOException
```
    Description copied from interface: MtasSolrComponent
    
    Distributed process.
    
    Specified by:
    
    distributedProcess in interface MtasSolrComponent<CodecComponent.ComponentFacet>
    
    Parameters:
    
    rb - the rb
    
    mtasFields - the mtas fields
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - getFieldType
```
private String getFieldType(org.apache.solr.schema.IndexSchema schema,
                            String field)
                     throws IOException
```
    Gets the field type.
    
    Parameters:
    
    schema - the schema
    
    field - the field
    
    Returns:
    
    the field type
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - getPositiveInteger
```
private int getPositiveInteger(String number)
```
    Gets the positive integer.
    
    Parameters:
    
    number - the number
    
    Returns:
    
    the positive integer
  - getDouble
```
private Double getDouble(String number)
```
    Gets the double.
    
    Parameters:
    
    number - the number
    
    Returns:
    
    the double

Class MtasSolrComponentFacet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

searchComponent

NAME

PARAM_MTAS_FACET

NAME_MTAS_FACET_KEY

NAME_MTAS_FACET_FIELD

NAME_MTAS_FACET_QUERY

NAME_MTAS_FACET_BASE

SUBNAME_MTAS_FACET_QUERY_TYPE

SUBNAME_MTAS_FACET_QUERY_VALUE

SUBNAME_MTAS_FACET_QUERY_PREFIX

SUBNAME_MTAS_FACET_QUERY_IGNORE

SUBNAME_MTAS_FACET_QUERY_MAXIMUM_IGNORE_LENGTH

SUBNAME_MTAS_FACET_QUERY_VARIABLE

SUBNAME_MTAS_FACET_QUERY_VARIABLE_NAME

SUBNAME_MTAS_FACET_QUERY_VARIABLE_VALUE

SUBNAME_MTAS_FACET_BASE_FIELD

SUBNAME_MTAS_FACET_BASE_TYPE

SUBNAME_MTAS_FACET_BASE_SORT_TYPE

SUBNAME_MTAS_FACET_BASE_SORT_DIRECTION

SUBNAME_MTAS_FACET_BASE_NUMBER

SUBNAME_MTAS_FACET_BASE_MINIMUM

SUBNAME_MTAS_FACET_BASE_MAXIMUM

SUBNAME_MTAS_FACET_BASE_FUNCTION

SUBNAME_MTAS_FACET_BASE_FUNCTION_KEY

SUBNAME_MTAS_FACET_BASE_FUNCTION_EXPRESSION

SUBNAME_MTAS_FACET_BASE_FUNCTION_TYPE

SUBNAME_MTAS_FACET_BASE_RANGE

SUBNAME_MTAS_FACET_BASE_RANGE_SIZE

SUBNAME_MTAS_FACET_BASE_RANGE_BASE

Constructor Detail

MtasSolrComponentFacet

Method Detail

prepare

modifyRequest

create

finishStage

distributedProcess

getFieldType

getPositiveInteger

getDouble