SMILA 1.0 API documentation

org.eclipse.smila.solr
Class SolrConstants

java.lang.Object
  extended by org.eclipse.smila.solr.SolrConstants

public final class SolrConstants
extends java.lang.Object

This class holds static constants that are used for property names and other such stuff.


Nested Class Summary
static class SolrConstants.AttributeOrAttachment
          Source/Target type AttributeOrAttachment.
static class SolrConstants.ExecutionMode
          The execution mode.
 
Field Summary
static java.lang.String CORE_FIELD_ID
          The core field id.
static java.lang.String CORE_FIELD_NAME
          The parameter field name.
static java.lang.String CORE_FIELD_SCORE
          The core field score.
static java.lang.String CORE_FIELDS
          The parameter index fields.
static java.lang.String CORE_NAME
          The parameter core name.
static java.lang.String DATE_FORMAT_PATTERN
          The default solr date format pattern.
static java.lang.String DEFAULT_CORE
          The DefaultCore folder.
static java.lang.String DOC_BOOST
          annotation name for defining a boost factor (double) of a record/document.
static java.lang.String DYNAMIC_TARGET_CORE
          annotation on a record to control the target index/core dynamically. overrides the pipelet config.
static java.lang.String EXECUTION_MODE
          The parameter execution mode.
static java.lang.String FACET_MULTISELECT
          FACET_MULTISELECT
static java.lang.String FACET_NAME
          FACET_NAME
static java.lang.String FACET_QUERY_ATTR
          Deprecated. as of 1.0
static java.lang.String FACET_RANGES
          FACET_RANGES (result)
static java.lang.String FACET_TYPE
          controls what type of faceting shall be done. one of: facet.field (default), facet.date, facet.range, or any other that solr supports in the future.
static java.lang.String FACET_TYPE_CUSTOM_RANGES
          FACET_TYPE_CUSTOM_RANGES (query)
static java.lang.String FIELD_PREFIX
          The parameter field prefix.
static java.lang.String FIELD_SUFFIX
          The paramter field suffix.
static java.lang.String FILTER_GROUP
          smila parameter name for a filter or facet, designating the filter group.
static java.lang.String FILTER_GROUP_Q
          special, constant value for a filter group designating the main query as the group.
static java.lang.String FILTER_GROUPS
          smila parameter name for a the map containing the configs for filter groups.
static java.lang.String FILTER_QUERY
          Parameter filter query.
static java.lang.String GLOBAL
          Parameter global.
static java.lang.String GROUPBY_AS_MAIN_RESULT
          GROUPBY_AS_MAIN_RESULT
static java.lang.String GROUPBY_DEFAULT_IF_NULL
          Default group name if null
static java.lang.String GROUPBY_METHOD_ATTRIBUTES
          GROUPBY_METHOD_ATTRIBUTES
static java.lang.String HIGHLIGHTING
          Parameter highlighting.
static java.lang.String LOCAL_PARAM_TAG
          The Constant TAG.
static java.lang.String LOCAL_PARAMS
          name of map to hold solr local params that are passed verbatim as for various constructs (e.g. q, fq, facet params).
static java.lang.String MAX_SCORE
          Parameter max_score.
static java.lang.String MLT_RESULT_ITEMS
          MLT_SEQ_NAME.
static java.lang.String MLT_RESULT_META
          MLT_META_MAP_NAME.
static java.lang.String MORE_LIKE_THIS
          MORE_LIKE_THIS.
static java.lang.String QUERY_MAP
          Parameter query map.
static java.lang.String RESULT_MAP
          Parameter result map.
static java.lang.String SHARDS
          The shards.
static java.lang.String SOLR_PREFIX
          Parameter _solr.
static java.lang.String SOURCE_NAME
          Record source name.
static java.lang.String SOURCE_TYPE
          Record source type (AttributeOrAttachment).
static java.lang.String TERMS
          Parameter terms.
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EXECUTION_MODE

public static final java.lang.String EXECUTION_MODE
The parameter execution mode.

See Also:
Constant Field Values

CORE_NAME

public static final java.lang.String CORE_NAME
The parameter core name.

See Also:
Constant Field Values

CORE_FIELDS

public static final java.lang.String CORE_FIELDS
The parameter index fields.

See Also:
Constant Field Values

CORE_FIELD_NAME

public static final java.lang.String CORE_FIELD_NAME
The parameter field name.

See Also:
Constant Field Values

SOURCE_NAME

public static final java.lang.String SOURCE_NAME
Record source name.

See Also:
Constant Field Values

SOURCE_TYPE

public static final java.lang.String SOURCE_TYPE
Record source type (AttributeOrAttachment).

See Also:
Constant Field Values

CORE_FIELD_ID

public static final java.lang.String CORE_FIELD_ID
The core field id.

See Also:
Constant Field Values

CORE_FIELD_SCORE

public static final java.lang.String CORE_FIELD_SCORE
The core field score.

See Also:
Constant Field Values

DATE_FORMAT_PATTERN

public static final java.lang.String DATE_FORMAT_PATTERN
The default solr date format pattern.

See Also:
Constant Field Values

FACET_TYPE

public static final java.lang.String FACET_TYPE
controls what type of faceting shall be done. one of: facet.field (default), facet.date, facet.range, or any other that solr supports in the future. The value is taken as given and passed as a param to solr with the value contained in the attribute-Val.

See Also:
Constant Field Values

FACET_TYPE_CUSTOM_RANGES

public static final java.lang.String FACET_TYPE_CUSTOM_RANGES
FACET_TYPE_CUSTOM_RANGES (query)

See Also:
Constant Field Values

FACET_RANGES

public static final java.lang.String FACET_RANGES
FACET_RANGES (result)

See Also:
Constant Field Values

FACET_NAME

public static final java.lang.String FACET_NAME
FACET_NAME

See Also:
Constant Field Values

FACET_MULTISELECT

public static final java.lang.String FACET_MULTISELECT
FACET_MULTISELECT

See Also:
Constant Field Values

FACET_QUERY_ATTR

@Deprecated
public static final java.lang.String FACET_QUERY_ATTR
Deprecated. as of 1.0
The facet query attribute.

See Also:
Constant Field Values

SHARDS

public static final java.lang.String SHARDS
The shards.

See Also:
Constant Field Values

DOC_BOOST

public static final java.lang.String DOC_BOOST
annotation name for defining a boost factor (double) of a record/document.

Note: i was thinking if smila defines smth. like this already, as it is a common thing such as _id, but it doesnt make sense to put this @ the record like Record.RECORD_ID since boosting is search specific. So what we need is a place for constants that make sense in the realm of search but have to do with the indexing side of things, which is the resason why QueryConstants is not such a good place. AFAIK there is no such place so far.

See Also:
Constant Field Values

SOLR_PREFIX

public static final java.lang.String SOLR_PREFIX
Parameter _solr.

See Also:
Constant Field Values

QUERY_MAP

public static final java.lang.String QUERY_MAP
Parameter query map.

See Also:
Constant Field Values

RESULT_MAP

public static final java.lang.String RESULT_MAP
Parameter result map.

See Also:
Constant Field Values

GLOBAL

public static final java.lang.String GLOBAL
Parameter global.

See Also:
Constant Field Values

FIELD_PREFIX

public static final java.lang.String FIELD_PREFIX
The parameter field prefix.

See Also:
Constant Field Values

FIELD_SUFFIX

public static final java.lang.String FIELD_SUFFIX
The paramter field suffix.

See Also:
Constant Field Values

MAX_SCORE

public static final java.lang.String MAX_SCORE
Parameter max_score.

See Also:
Constant Field Values

TERMS

public static final java.lang.String TERMS
Parameter terms.

See Also:
Constant Field Values

HIGHLIGHTING

public static final java.lang.String HIGHLIGHTING
Parameter highlighting.

See Also:
Constant Field Values

FILTER_QUERY

public static final java.lang.String FILTER_QUERY
Parameter filter query.

See Also:
Constant Field Values

DYNAMIC_TARGET_CORE

public static final java.lang.String DYNAMIC_TARGET_CORE
annotation on a record to control the target index/core dynamically. overrides the pipelet config.

See Also:
Constant Field Values

DEFAULT_CORE

public static final java.lang.String DEFAULT_CORE
The DefaultCore folder.

See Also:
Constant Field Values

MLT_RESULT_META

public static final java.lang.String MLT_RESULT_META
MLT_META_MAP_NAME.

See Also:
Constant Field Values

MLT_RESULT_ITEMS

public static final java.lang.String MLT_RESULT_ITEMS
MLT_SEQ_NAME.

See Also:
Constant Field Values

MORE_LIKE_THIS

public static final java.lang.String MORE_LIKE_THIS
MORE_LIKE_THIS.

See Also:
Constant Field Values

LOCAL_PARAMS

public static final java.lang.String LOCAL_PARAMS
name of map to hold solr local params that are passed verbatim as for various constructs (e.g. q, fq, facet params).

See Also:
Constant Field Values

FILTER_GROUP

public static final java.lang.String FILTER_GROUP
smila parameter name for a filter or facet, designating the filter group.

See Also:
Constant Field Values

FILTER_GROUPS

public static final java.lang.String FILTER_GROUPS
smila parameter name for a the map containing the configs for filter groups.

See Also:
Constant Field Values

FILTER_GROUP_Q

public static final java.lang.String FILTER_GROUP_Q
special, constant value for a filter group designating the main query as the group. Note, the tag value can still be overridden with local params!

See Also:
Constant Field Values

LOCAL_PARAM_TAG

public static final java.lang.String LOCAL_PARAM_TAG
The Constant TAG.

See Also:
Constant Field Values

GROUPBY_METHOD_ATTRIBUTES

public static final java.lang.String GROUPBY_METHOD_ATTRIBUTES
GROUPBY_METHOD_ATTRIBUTES

See Also:
Constant Field Values

GROUPBY_AS_MAIN_RESULT

public static final java.lang.String GROUPBY_AS_MAIN_RESULT
GROUPBY_AS_MAIN_RESULT

See Also:
Constant Field Values

GROUPBY_DEFAULT_IF_NULL

public static final java.lang.String GROUPBY_DEFAULT_IF_NULL
Default group name if null

See Also:
Constant Field Values

SMILA 1.0 API documentation