Package net.pricefx.formulaengine.optimization

Interface ModelFilterTreesContextReadWrite

All Superinterfaces:

ModelFilterTreesContextReadOnly

public interface ModelFilterTreesContextReadWrite
extends ModelFilterTreesContextReadOnly

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ModelFilterTreesContextReadWrite.MutableFilterTree
static final class	ModelFilterTreesContextReadWrite.NodeSpec	Represents an in-memory tree.

Nested classes/interfaces inherited from interface ModelFilterTreesContextReadOnly

ModelFilterTreesContextReadOnly.FilterTree, ModelFilterTreesContextReadOnly.FilterTreeNode

Method Summary

Modifier and Type	Method	Description
ModelFilterTreesContextReadWrite.MutableFilterTree	addTree(String name, ModelFilterTreesContextReadWrite.NodeSpec root)	Add a tree that will be owned by this model.
ModelFilterTreesContextReadWrite.MutableFilterTree	tree(String name)

Method Details

tree

ModelFilterTreesContextReadWrite.MutableFilterTree tree(String name)

Specified by:

tree in interface ModelFilterTreesContextReadOnly

Parameters:

name - The name of the ModelFilterTreesContextReadWrite.MutableFilterTree owned by this model

Returns:

A ModelFilterTreesContextReadWrite.MutableFilterTree or null if it doesn't exist

Since:

9.0 Hurricane

addTree

ModelFilterTreesContextReadWrite.MutableFilterTree addTree(String name,
 ModelFilterTreesContextReadWrite.NodeSpec root)

Add a tree that will be owned by this model.

If the tree already exists, it is deleted and replaced by this new tree.

Here is an example of a tree representation:

 def myTree = model.addTree(
     "Segments",
     new NodeSpec(
         name: "Segments",
         label: "the root",
         children: [
             new NodeSpec(
                name: "S1",
                label: "avg=0.189",
                filter: Filter.equal("CategoryA", "foo"),
                filterDescription: "CategoryA == foo"
             ),
             new NodeSpec(
                name: "S2",
                label: "avg=0.345",
                filter: Filter.lessOrEqual("CategoryA", "bar"),
                filterDescription: "CategoryA <= bar"
             )
         ]
     )
 )
 

Parameters:

name - The name of the new tree, must be unique per model

root - The representation of the tree to add

Returns:

the new ModelFilterTreesContextReadWrite.MutableFilterTree

Since:

9.0 Hurricane