org.colomoto.mddlib.operators

Class AbstractFlexibleOperator

java.lang.Object

org.colomoto.mddlib.operators.AbstractOperator

org.colomoto.mddlib.operators.AbstractFlexibleOperator

All Implemented Interfaces:

MDDOperator

Direct Known Subclasses:

OverwriteOperator

public abstract class AbstractFlexibleOperator
extends AbstractOperator

Base class for quick prototyping of new complex operators.

The AbstractGenericOperator relies on AbstractOperator and adds a mapping between "status" and a set of likely behaviours, including some hooks to quickly write custom operators without bothering with "common" cases.

A status is the relationship between the nodes being merged

Author:

Aurelien Naldi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractFlexibleOperator.MergeAction Supported actions while merging.

Constructor Summary

Constructors

Constructor and Description
AbstractFlexibleOperator(AbstractFlexibleOperator.MergeAction A_LL) Create a new operator.
AbstractFlexibleOperator(AbstractFlexibleOperator.MergeAction A_LL, boolean multipleMerge) Create a new operator

Method Summary

Modifier and Type	Method and Description
AbstractFlexibleOperator.MergeAction	ask(MDDManager ddmanager, NodeRelation status, int first, int other) if some cases need more info to be tested, put the ASKME value in the array t and implement this complementary function.
int	combine(MDDManager ddmanager, int first, int other) Combine two MDDs and return the result.
int	custom(MDDManager ddmanager, NodeRelation status, int first, int other) put the CUSTOM value in t and implement this function to add more complex behaviours.
protected void	lock() Lock the operator so that the actions can no more be changed.
protected void	setAction(NodeRelation rel, AbstractFlexibleOperator.MergeAction action) Define the action applied for a given relation between the merged nodes.

Methods inherited from class org.colomoto.mddlib.operators.AbstractOperator

combine, multiple_leaves, recurse_multiple, recurse

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFlexibleOperator

public AbstractFlexibleOperator(AbstractFlexibleOperator.MergeAction A_LL,
                                boolean multipleMerge)

Create a new operator

By default, only the action for two leaves have to be defined, all others are set to recursive. You can define additional actions by calling setAction.

Parameters:

A_LL -

multipleMerge -

AbstractFlexibleOperator

public AbstractFlexibleOperator(AbstractFlexibleOperator.MergeAction A_LL)

Create a new operator.

By default, only the action for two leaves have to be defined, all others are set to recursive. You can define additional actions by calling setAction.

Parameters:

A_LL -

Method Detail

setAction

protected void setAction(NodeRelation rel,
                         AbstractFlexibleOperator.MergeAction action)

Define the action applied for a given relation between the merged nodes.

Note: once the operation is locked, this method does nothing. It should be defined in the constructor and never change.

Override ask and/or custom if you plan to use the ASKME and CUSTOM actions.

Parameters:

rel -

action -

lock

protected void lock()

Lock the operator so that the actions can no more be changed.

This should be done at the end of the constructor.

combine

public int combine(MDDManager ddmanager,
                   int first,
                   int other)

Description copied from interface: MDDOperator

Combine two MDDs and return the result.

Parameters:

ddmanager - the MDD manager in which the nodes are stored

first - the root node of the first MDD

other - the root node of the other MDD

Returns:

the root node of the combined MDD. It can be a new or an existing node.

ask

public AbstractFlexibleOperator.MergeAction ask(MDDManager ddmanager,
                                                NodeRelation status,
                                                int first,
                                                int other)

if some cases need more info to be tested, put the ASKME value in the array t and implement this complementary function.

Parameters:

ddmanager -

status -

first - value or level of the first node

other - value or level of the other node

Returns:

the action to perform

custom

public int custom(MDDManager ddmanager,
                  NodeRelation status,
                  int first,
                  int other)

put the CUSTOM value in t and implement this function to add more complex behaviours. Warning: it is responsible for dealing with usage counter: don't forget to call the "use" method if you return one of the existing nodes without going through get_bnode or get_mnode.

Parameters:

ddmanager -

status -

first - value or level of the first node

other - value or level of the other node

Returns:

the resulting node index