Package org.neo4j.gds.similarity.filtering

Interface NodeFilterSpec

All Known Implementing Classes:

LabelNodeFilterSpec, NodeIdNodeFilterSpec

public interface NodeFilterSpec

A NodeFilterSpec is a partially constructed NodeFilter. Because we cannot fully construct the NodeFilter from user inputs alone, we parse and validate what we can, and prepare for completing the construction once the rest is available. There are two types of node filters: ones based on a list of node IDs, and ones based on labels. There are therefore two types of node filter specs, accordingly. The spec is created using NodeFilterSpecFactory.create(Object) and the NodeFilter is then created using toNodeFilter(org.neo4j.gds.api.IdMap).

Field Summary

Fields

Modifier and Type	Field	Description
static NodeFilterSpec	noOp

Method Summary

Modifier and Type	Method	Description
java.lang.String	render()
NodeFilter	toNodeFilter(org.neo4j.gds.api.IdMap idMap)
void	validate(org.neo4j.gds.api.GraphStore graphStore, java.util.Collection<org.neo4j.gds.NodeLabel> selectedLabels, java.lang.String nodeFilterType)

Field Detail

noOp

static final NodeFilterSpec noOp

Method Detail

toNodeFilter

NodeFilter toNodeFilter(org.neo4j.gds.api.IdMap idMap)

render

java.lang.String render()

validate

void validate(org.neo4j.gds.api.GraphStore graphStore,
              java.util.Collection<org.neo4j.gds.NodeLabel> selectedLabels,
              java.lang.String nodeFilterType)
       throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException