de.julielab.neo4j.plugins.datarepresentation.constants

Class FacetConstants

java.lang.Object

de.julielab.neo4j.plugins.constants.NodeConstants

de.julielab.neo4j.plugins.datarepresentation.constants.NodeConstants

de.julielab.neo4j.plugins.datarepresentation.constants.FacetConstants

public class FacetConstants
extends NodeConstants

Nested Class Summary

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

NodeConstants.Labels

Field Summary

Fields

Modifier and Type	Field and Description
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	NAME_FACET_GROUPS
static String	NAME_NO_FACET_GROUPS
static String	NO_FACET Import option.
static String	PROP_CUSTOM_ID The custom ID may be specified during the import of facets.
static String	PROP_NUM_ROOT_TERMS The number of roots a facet has.
static String	PROP_SHORT_NAME An optional short name for display at places that lack more space.
static String	PROP_SOURCE_TYPE The type of content of the facet identified by #PROP_SOURCE_NAME.
static String	SRC_TYPE_FLAT Concepts without taxonomical relations between them.
static String	SRC_TYPE_HIERARCHICAL Taxonomically arranged concepts.
static String	SRC_TYPE_STRINGS No pre-defined concepts with a name and synonyms but just strings.

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

INDEX_ROOT_NODES, PROP_ID, PROP_LABELS, PROP_NAME, PROP_QUALIFIERS, 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

SRC_TYPE_HIERARCHICAL

public static final String SRC_TYPE_HIERARCHICAL

Taxonomically arranged concepts.

See Also:

Constant Field Values

SRC_TYPE_FLAT

public static final String SRC_TYPE_FLAT

Concepts without taxonomical relations between them.

See Also:

Constant Field Values

SRC_TYPE_STRINGS

public static final String SRC_TYPE_STRINGS

No pre-defined concepts with a name and synonyms but just strings. This kind of facet typically has no concepts in the database but is filled by the using application at runtime. An example would be author names of a bibliographic system that does not group authors into concepts but treats each name as a separate entity.

See Also:

Constant Field Values

PROP_CUSTOM_ID

public static final String PROP_CUSTOM_ID

The custom ID may be specified during the import of facets. It serves as an alternative identifier for facets besides the automatically generated facet ID. This custom ID must be unique per facet.

See Also:

Constant Field Values

PROP_SOURCE_TYPE

public static final String PROP_SOURCE_TYPE

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

See Also:

SRC_TYPE_HIERARCHICAL, SRC_TYPE_FLAT, SRC_TYPE_STRINGS, 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

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

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

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

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

Constructor Detail

FacetConstants

public FacetConstants()