org.eclipse.smila.processing.parameters
Class SearchAnnotations

java.lang.Object
  org.eclipse.smila.processing.parameters.SearchAnnotations

public final class SearchAnnotations
extends java.lang.Object

Constants for names and values of record and attribute annotations commonly used in search pipelines.

Author:

jschumacher

Nested Class Summary

static class	SearchAnnotations.FilterMode predefined values of "mdoe" property of filter annotations.
static class	SearchAnnotations.FilterType predefined values of "type" property of filter annotations.

Field Summary

static java.lang.String	FACET_COUNT name of "count" property of facet annotations.
static java.lang.String	FACET_FILTER name of "filter" annotation of facet annotations.
static java.lang.String	FACET_NAME name of "name" property of facet annotations.
static java.lang.String	FACETS name of "facets" attribute annoation of effective query.
static java.lang.String	FILTER name of "filter" attribute and facet annotations for defining hard search criteria on top of fuzzy searches.
static java.lang.String	FILTER_MAX name of "max" property of range "filter" annotations: upper bound value.
static java.lang.String	FILTER_MIN name of "min" property of range "filter" annotations: lower bound value.
static java.lang.String	FILTER_MODE name of "mode" property of "filter" annotations.
static java.lang.String	FILTER_TYPE name of "type" property of "filter" annotations.
static java.lang.String	HIGHLIGHT name of "highlight" record and attribute annotations.
static java.lang.String	HIGHLIGHT_POS_END name of "end" property of highlight position annotations.
static java.lang.String	HIGHLIGHT_POS_GROUP name of "group" property of highlight position annotations.
static java.lang.String	HIGHLIGHT_POS_METHOD name of "method" property of highlight position annotations.
static java.lang.String	HIGHLIGHT_POS_QUALITY name of "quality" property of highlight position annotations.
static java.lang.String	HIGHLIGHT_POS_START name of "start" property of highlight position annotations.
static java.lang.String	HIGHLIGHT_POSITIONS name of "positions" subannotations of highlight annotations.
static java.lang.String	HIGHLIGHT_TEXT name of "text" property of highlight annotations.
static java.lang.String	INDEX_SIZE number of objects in index.
static java.lang.String	RANKING name of "ranking" record or attribute annotation for specifying ranking criteria.
static java.lang.String	RANKING_BOOST name of "boost" property of "ranking" annotations: Specifies a boost factor.
static java.lang.String	RANKING_NAME name of "name" property of "ranking" annotations: Use a named predefined ranking criterium.
static java.lang.String	RELEVANCE name of "relevance" property of "result" annotation of results.
static java.lang.String	RESULT name of "result" annotation of effective query.
static java.lang.String	RUNTIME execution runtime of workflow, set by search service in result annotation on query record.
static java.lang.String	TERM_CONCEPT name of "concept" property of term annotations.
static java.lang.String	TERM_END name of "end" property of term annotations.
static java.lang.String	TERM_ENDWORD name of "endWord" property of term annotations.
static java.lang.String	TERM_METHOD name of "method" property of term annotations.
static java.lang.String	TERM_PARTOFSPEECH name of "pos" property of term annotations.
static java.lang.String	TERM_QUALITY name of "quality" property of term annotations.
static java.lang.String	TERM_START name of "start" property of term annotations.
static java.lang.String	TERM_STARTWORD name of "startWord" property of term annotations.
static java.lang.String	TERM_TARGET name of "target" property of term annotations.
static java.lang.String	TERM_TOKEN name of "token" property of term annotations.
static java.lang.String	TERMS name of "terms" attribute annotation.
static java.lang.String	TOTAL_HITS name of "totalHits" property of "result" annotation of query.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FILTER

public static final java.lang.String FILTER

name of "filter" attribute and facet annotations for defining hard search criteria on top of fuzzy searches.

See Also:

Constant Field Values

FILTER_TYPE

public static final java.lang.String FILTER_TYPE

name of "type" property of "filter" annotations. For predefiend values see SearchAnnotations.FilterType.

See Also:

Constant Field Values

FILTER_MODE

public static final java.lang.String FILTER_MODE

name of "mode" property of "filter" annotations. For predefined values set SearchAnnotations.FilterMode.

See Also:

Constant Field Values

FILTER_MIN

public static final java.lang.String FILTER_MIN

name of "min" property of range "filter" annotations: lower bound value.

See Also:

Constant Field Values

FILTER_MAX

public static final java.lang.String FILTER_MAX

name of "max" property of range "filter" annotations: upper bound value.

See Also:

Constant Field Values

RANKING

public static final java.lang.String RANKING

name of "ranking" record or attribute annotation for specifying ranking criteria.

See Also:

Constant Field Values

RANKING_NAME

public static final java.lang.String RANKING_NAME

name of "name" property of "ranking" annotations: Use a named predefined ranking criterium.

See Also:

Constant Field Values

RANKING_BOOST

public static final java.lang.String RANKING_BOOST

name of "boost" property of "ranking" annotations: Specifies a boost factor.

See Also:

Constant Field Values

RESULT

public static final java.lang.String RESULT

name of "result" annotation of effective query.

See Also:

Constant Field Values

TOTAL_HITS

public static final java.lang.String TOTAL_HITS

name of "totalHits" property of "result" annotation of query.

See Also:

Constant Field Values

INDEX_SIZE

public static final java.lang.String INDEX_SIZE

number of objects in index. May be set by retrieval engine in result annotation on query record.

See Also:

Constant Field Values

RUNTIME

public static final java.lang.String RUNTIME

execution runtime of workflow, set by search service in result annotation on query record.

See Also:

Constant Field Values

RELEVANCE

public static final java.lang.String RELEVANCE

name of "relevance" property of "result" annotation of results.

See Also:

Constant Field Values

FACETS

public static final java.lang.String FACETS

name of "facets" attribute annoation of effective query.

See Also:

Constant Field Values

FACET_NAME

public static final java.lang.String FACET_NAME

name of "name" property of facet annotations.

See Also:

Constant Field Values

FACET_COUNT

public static final java.lang.String FACET_COUNT

name of "count" property of facet annotations.

See Also:

Constant Field Values

FACET_FILTER

public static final java.lang.String FACET_FILTER

name of "filter" annotation of facet annotations.

See Also:

Constant Field Values

TERMS

public static final java.lang.String TERMS

name of "terms" attribute annotation.

See Also:

Constant Field Values

TERM_CONCEPT

public static final java.lang.String TERM_CONCEPT

name of "concept" property of term annotations.

See Also:

Constant Field Values

TERM_TOKEN

public static final java.lang.String TERM_TOKEN

name of "token" property of term annotations.

See Also:

Constant Field Values

TERM_TARGET

public static final java.lang.String TERM_TARGET

name of "target" property of term annotations.

See Also:

Constant Field Values

TERM_START

public static final java.lang.String TERM_START

name of "start" property of term annotations.

See Also:

Constant Field Values

TERM_END

public static final java.lang.String TERM_END

name of "end" property of term annotations.

See Also:

Constant Field Values

TERM_STARTWORD

public static final java.lang.String TERM_STARTWORD

name of "startWord" property of term annotations.

See Also:

Constant Field Values

TERM_ENDWORD

public static final java.lang.String TERM_ENDWORD

name of "endWord" property of term annotations.

See Also:

Constant Field Values

TERM_PARTOFSPEECH

public static final java.lang.String TERM_PARTOFSPEECH

name of "pos" property of term annotations.

See Also:

Constant Field Values

TERM_METHOD

public static final java.lang.String TERM_METHOD

name of "method" property of term annotations.

See Also:

Constant Field Values

TERM_QUALITY

public static final java.lang.String TERM_QUALITY

name of "quality" property of term annotations.

See Also:

Constant Field Values

HIGHLIGHT

public static final java.lang.String HIGHLIGHT

name of "highlight" record and attribute annotations.

See Also:

Constant Field Values

HIGHLIGHT_TEXT

public static final java.lang.String HIGHLIGHT_TEXT

name of "text" property of highlight annotations.

See Also:

Constant Field Values

HIGHLIGHT_POSITIONS

public static final java.lang.String HIGHLIGHT_POSITIONS

name of "positions" subannotations of highlight annotations.

See Also:

Constant Field Values

HIGHLIGHT_POS_START

public static final java.lang.String HIGHLIGHT_POS_START

name of "start" property of highlight position annotations.

See Also:

Constant Field Values

HIGHLIGHT_POS_END

public static final java.lang.String HIGHLIGHT_POS_END

name of "end" property of highlight position annotations.

See Also:

Constant Field Values

HIGHLIGHT_POS_QUALITY

public static final java.lang.String HIGHLIGHT_POS_QUALITY

name of "quality" property of highlight position annotations.

See Also:

Constant Field Values

HIGHLIGHT_POS_GROUP

public static final java.lang.String HIGHLIGHT_POS_GROUP

name of "group" property of highlight position annotations.

See Also:

Constant Field Values

HIGHLIGHT_POS_METHOD

public static final java.lang.String HIGHLIGHT_POS_METHOD

name of "method" property of highlight position annotations.

See Also:

Constant Field Values