SMILA 1.0 API documentation

org.eclipse.smila.search.api
Class SearchResultConstants

java.lang.Object
  extended by org.eclipse.smila.search.api.SearchResultConstants

public final class SearchResultConstants
extends java.lang.Object

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

Author:
jschumacher

Field Summary
static java.lang.String COUNT
          name of "count" property of result.
static java.lang.String FACETS
          name of "facets" annotations: map of attribute name to sequence of maps with "value" and "count".
static java.lang.String HIGHLIGHT
          name of "_highlight" 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
          name of annotation for number of objects in index.
static java.lang.String POS_END
          name of "end" property of (e.g.
static java.lang.String POS_QUALITY
          name of "quality" property of (e.g.
static java.lang.String POS_START
          name of "start" property of (e.g.
static java.lang.String RECORDS
          name of "records" sequence in result.
static java.lang.String RUNTIME
          name of annotation for execution runtime of workflow.
static java.lang.String VALUE
          name of "value" properties, e.g.
static java.lang.String WEIGHT
          name of "_weight" annotation in result records.
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RECORDS

public static final java.lang.String RECORDS
name of "records" sequence in result.

See Also:
Constant Field Values

COUNT

public static final java.lang.String COUNT
name of "count" property of result.

See Also:
Constant Field Values

INDEX_SIZE

public static final java.lang.String INDEX_SIZE
name of annotation for number of objects in index.

See Also:
Constant Field Values

RUNTIME

public static final java.lang.String RUNTIME
name of annotation for execution runtime of workflow.

See Also:
Constant Field Values

WEIGHT

public static final java.lang.String WEIGHT
name of "_weight" annotation in result records.

See Also:
Constant Field Values

HIGHLIGHT

public static final java.lang.String HIGHLIGHT
name of "_highlight" 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

POS_START

public static final java.lang.String POS_START
name of "start" property of (e.g. highlight) position annotations.

See Also:
Constant Field Values

POS_END

public static final java.lang.String POS_END
name of "end" property of (e.g. highlight) position annotations.

See Also:
Constant Field Values

POS_QUALITY

public static final java.lang.String POS_QUALITY
name of "quality" property of (e.g. highlight) position annotations.

See Also:
Constant Field Values

FACETS

public static final java.lang.String FACETS
name of "facets" annotations: map of attribute name to sequence of maps with "value" and "count".

See Also:
Constant Field Values

VALUE

public static final java.lang.String VALUE
name of "value" properties, e.g. in "facets" annotation

See Also:
Constant Field Values

SMILA 1.0 API documentation