de.julielab.neo4j.plugins.constants.semedico

Class FacetConstants

java.lang.Object

de.julielab.neo4j.plugins.constants.NodeConstants

de.julielab.neo4j.plugins.constants.semedico.NodeConstants

de.julielab.neo4j.plugins.constants.semedico.FacetConstants

public class FacetConstants
extends NodeConstants

Nested Class Summary

Nested classes/interfaces inherited from class de.julielab.neo4j.plugins.constants.semedico.NodeConstants

NodeConstants.Labels

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGGREGATION_LABELS For facets that are just an aggregation of other facets, this property defines a list of facet labels identifying those facets to be used for the aggregation.
static String	FACET_FIELD_PREFIX
static String	FACET_GROUP Used when inserting facets to specify the facet group they are to be connected to.
static String	INDEX_GENERAL_LABELS
static String	NAME_FACET_GROUPS
static String	NAME_NO_FACET_GROUPS
static String	NO_FACET Import option.
static String	PROP_ACTIVE Boolean property to indicate whether the facet is active - should be loaded and shown in the system - or not.
static String	PROP_AGGREGATION_FIELDS For facets that are just an aggregation of other facets, this property defines a list of index fields to directly draw terms from.
static String	PROP_CSS_ID
static String	PROP_FILTER_FIELD_NAMES The names of Lucene fields on which filtering should be performed when a term of a particular facet is used for Lucene filtering.
static String	PROP_INDUCING_TERM For facets that are induced by a term, i.e.
static String	PROP_NUM_ROOT_TERMS The number of roots a facet has.
static String	PROP_POSITION
static String	PROP_SEARCH_FIELD_NAMES The names of Lucene fields which should be searched when looking for terms included in a particular facet.
static String	PROP_SHORT_NAME An optional short name for display at places that lack more space.
static String	PROP_SOURCE_NAME The name of the Lucene field which is the source of the term IDs for a facet when e.g.
static String	PROP_SOURCE_TYPE The type of content of the Lucene fields indentified by PROP_SOURCE_NAME.
static String	PROP_TYPE Deprecated.
static String	SRC_TYPE_FACET_AGGREGATION
static String	SRC_TYPE_FLAT
static String	SRC_TYPE_HIERARCHICAL
static String	SRC_TYPE_STRINGS

Fields inherited from class de.julielab.neo4j.plugins.constants.semedico.NodeConstants

INDEX_ROOT_NODES, PROP_GENERAL_LABELS, PROP_ID, PROP_NAME, PROP_PROPERTIES, PROP_QUALIFIERS, PROP_UNIQUE_LABELS, PROP_VALUE

Fields inherited from class de.julielab.neo4j.plugins.constants.NodeConstants

KEY_LABELS

Constructor Summary

Constructors

Constructor and Description
FacetConstants()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

PROP_CSS_ID

public static final String PROP_CSS_ID

See Also:

Constant Field Values

PROP_POSITION

public static final String PROP_POSITION

See Also:

Constant Field Values

PROP_SOURCE_NAME

public static final String PROP_SOURCE_NAME

The name of the Lucene field which is the source of the term IDs for a facet when e.g. computing facet counts for the Semedico frontend.

This property cannot be set from the outside when creating a facet and will be ignored if delivered within the information for facet creation. Instead, when a facet is created, the automatically generated facet ID (assembled by NodeIDPrefixConstants.FACET and a ascending number for each new facet) will be appended to FACET_FIELD_PREFIX and stored to this property.

For faceting to actually work for a Semedico document search, a field of the resulting name must exist in the index which will eventually be queried for facet values in Semedico. The creation - and naming - of these fields is configured in the LuCas mapping file in the Semedico UIMA application.

See Also:

Constant Field Values

PROP_SOURCE_TYPE

public static final String PROP_SOURCE_TYPE

The type of content of the Lucene fields indentified by PROP_SOURCE_NAME. The source type tells whether there are IDs of hierarchical terms to find in a facet's source field, or mere strings like dates or author names (as long as these are not captured as terms, anyway). Values should be one of the constants below.

See Also:

SRC_TYPE_HIERARCHICAL, SRC_TYPE_FLAT, SRC_TYPE_STRINGS, Constant Field Values

PROP_SEARCH_FIELD_NAMES

public static final String PROP_SEARCH_FIELD_NAMES

The names of Lucene fields which should be searched when looking for terms included in a particular facet.

See Also:

Constant Field Values

PROP_FILTER_FIELD_NAMES

public static final String PROP_FILTER_FIELD_NAMES

The names of Lucene fields on which filtering should be performed when a term of a particular facet is used for Lucene filtering.

See Also:

Constant Field Values

PROP_NUM_ROOT_TERMS

public static final String PROP_NUM_ROOT_TERMS

The number of roots a facet has. This is precomputed to speed up decisions within Semedico depending on the number of roots of a facet. The information is used to decide whether to load all facet roots for faceting or just to switch the facet to flat counts because there are too many roots (e.g. Genes and Proteins have 450k roots).

See Also:

Constant Field Values

PROP_ACTIVE

public static final String PROP_ACTIVE

Boolean property to indicate whether the facet is active - should be loaded and shown in the system - or not. If the property is missing on facet, the convention is that the facet is active.

See Also:

Constant Field Values

NAME_FACET_GROUPS

public static final String NAME_FACET_GROUPS

See Also:

Constant Field Values

NAME_NO_FACET_GROUPS

public static final String NAME_NO_FACET_GROUPS

See Also:

Constant Field Values

INDEX_GENERAL_LABELS

public static final String INDEX_GENERAL_LABELS

See Also:

Constant Field Values

PROP_TYPE

@Deprecated
public static final String PROP_TYPE

Deprecated.

Currently, the type is "translated" by the Semedico Facet service into from which field the facet should read and to which facet group it belongs, among other things. All this information is no stored in the graph structure or should be an explicit property value (the index field name, for example).

See Also:

Constant Field Values

FACET_GROUP

public static final String FACET_GROUP

Used when inserting facets to specify the facet group they are to be connected to. This is the key under which the facet group information can be found in the map defining a facet.

 Map<String, Object> facetGroupMap = new HashMap<>();
 facetGroupMap.put(FacetGroupConstants.PROP_NAME, "myfacetgroup");
 
 Map<String, Object> facetMap = new HashMap<>();
 facetMap.put(FacetConstants.PROP_NAME, "myfacet");
 facetMap.put(.,.);
 facetMap.put(FACET_GROUP, facetGroupMap);
 

See Also:

Constant Field Values

SRC_TYPE_HIERARCHICAL

public static final String SRC_TYPE_HIERARCHICAL

See Also:

Constant Field Values

SRC_TYPE_FLAT

public static final String SRC_TYPE_FLAT

See Also:

Constant Field Values

SRC_TYPE_STRINGS

public static final String SRC_TYPE_STRINGS

See Also:

Constant Field Values

SRC_TYPE_FACET_AGGREGATION

public static final String SRC_TYPE_FACET_AGGREGATION

See Also:

Constant Field Values

FACET_FIELD_PREFIX

public static final String FACET_FIELD_PREFIX

See Also:

Constant Field Values

NO_FACET

public static final String NO_FACET

Import option. If this field is set to true for the facet definition used in a term import, that facet will not be connected to the normal facet groups but to the no-facet section.

See Also:

Constant Field Values

AGGREGATION_LABELS

public static final String AGGREGATION_LABELS

For facets that are just an aggregation of other facets, this property defines a list of facet labels identifying those facets to be used for the aggregation.

See Also:

Constant Field Values

PROP_AGGREGATION_FIELDS

public static final String PROP_AGGREGATION_FIELDS

For facets that are just an aggregation of other facets, this property defines a list of index fields to directly draw terms from.

See Also:

Constant Field Values

PROP_INDUCING_TERM

public static final String PROP_INDUCING_TERM

For facets that are induced by a term, i.e. that have some kind of equivalent term. For example, the "phosphorylation" event facet has the "phosphorylation" event term as an inducing term. This information is sometimes necessary to create connections from term to facet.

See Also:

Constant Field Values

PROP_SHORT_NAME

public static final String PROP_SHORT_NAME

An optional short name for display at places that lack more space.

See Also:

Constant Field Values

Constructor Detail

FacetConstants

public FacetConstants()