Class RelationshipNode

A relationship node.

Hierarchy (View Summary)

LeafNode
- RelationshipNode

Index

Constructors

Properties

Accessors

nodes ref rel term tokens type

Methods

accept acceptChildNodes eval toJSON

Constructors

constructor

new RelationshipNode(
    rel: TokenRelationship,
    term?: TokenValue,
    ref?: TokenValue,
): RelationshipNode
Parameters
- rel: TokenRelationship
- Optionalterm: TokenValue
- Optionalref: TokenValue
Returns RelationshipNode
Overrides LeafNode.constructor
- Defined in src/filter/Node.ts:627

Properties

`Protected`$tokens

$tokens: Token[]

Accessors

nodes

get nodes(): readonly Node[]
A list of child nodes for this node.

Returns readonly Node[]
Inherited from LeafNode.nodes
- Defined in src/filter/Node.ts:292

ref

get ref(): undefined | TokenValue
Returns undefined | TokenValue
- Defined in src/filter/Node.ts:653
set ref(ref: undefined | TokenValue): void
Parameters
- ref: undefined | TokenValue
Returns void
- Defined in src/filter/Node.ts:659

rel

get rel(): TokenRelationship
Returns TokenRelationship
- Defined in src/filter/Node.ts:635
set rel(val: TokenRelationship): void
Parameters
- val: TokenRelationship
Returns void
- Defined in src/filter/Node.ts:639

term

get term(): undefined | TokenValue
Returns undefined | TokenValue
- Defined in src/filter/Node.ts:643
set term(term: undefined | TokenValue): void
Parameters
- term: undefined | TokenValue
Returns void
- Defined in src/filter/Node.ts:649

tokens

get tokens(): readonly Token[]
A list of tokens for this node.

Returns readonly Token[]
Inherited from LeafNode.tokens
- Defined in src/filter/Node.ts:288

type

get type(): NodeType
The type of node.

Returns NodeType
Overrides LeafNode.type
- Defined in src/filter/Node.ts:631

Methods

accept

accept(visitor: Visitor): void
Accept a visitor for this.

Please note, each new subtype of Node must have a corresponding enumeration and visitor method.
Parameters
- visitor: Visitor
  The visitor for this node.
Returns void
Overrides LeafNode.accept
- Defined in src/filter/Node.ts:663

acceptChildNodes

acceptChildNodes(): void
Accept the visitor on all child nodes.

Returns void
Inherited from LeafNode.acceptChildNodes
- Defined in src/filter/Node.ts:319

eval

eval(context: EvalContext): boolean
Evaluate the node against the evaluation context and return the result.
Parameters
- context: EvalContext
  The evaluation context.
Returns boolean
the resultant evaluation.
Overrides LeafNode.eval
- Defined in src/filter/Node.ts:667

toJSON

toJSON(): NodeData
Returns NodeData
A JSON representation of the node.
Inherited from LeafNode.toJSON
- Defined in src/filter/Node.ts:296