edu.uta.cse.fireeye.common

Class Constraint

java.lang.Object

edu.uta.cse.fireeye.common.Constraint

public class Constraint
extends java.lang.Object

A constraint is a restriction that a test must satisfy to be valid. A constraint consists of the constraint text and a set of parameters involved in this constraint.

Author:

ylei

Constructor Summary

Constructors

Constructor and Description
Constraint(java.lang.String text, java.util.ArrayList<Parameter> params) Constructs a constraint.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	convert(Parameter param, int index) Convert internal values to external values for constraint evaluation with the following logic: Boolean parameter: Use the real Boolean object.
boolean	eval(int[] test) Evaluates this constraint against a given test
boolean	eval(edu.uta.cse.fireeye.service.engine.PVPair p)
boolean	eval(edu.uta.cse.fireeye.service.engine.PVPair p1, edu.uta.cse.fireeye.service.engine.PVPair p2) Evaluates this constraint against two parameter value pairs.
boolean	eval(edu.uta.cse.fireeye.service.engine.Tuple tuple) Evaluates this constraint against a given tuple.
Parameter	getHiddenParameter()
edu.uta.cse.fireeye.service.constraint.HiddenParameterHelper	getHiddenParameterHelper()
java.util.ArrayList<Parameter>	getParams() Returns the list of parameters involved in this constraint.
java.lang.String	getText() Gets the text of this constraint.
boolean	involved(Parameter param) Checks if a parameter is involved in this constraint.
void	setParams(java.util.ArrayList<Parameter> params) Sets the list of parameters involved in this constraint.
void	setText(java.lang.String text) Sets the text of this constraint.
java.lang.String	toString() Returns a string representation of this constraint.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Constraint

public Constraint(java.lang.String text,
                  java.util.ArrayList<Parameter> params)

Constructs a constraint. A constraint consists of the constraint text and a list of all the parameters involved in this constraint.

Parameters:

text - the text of this constraint

params - all the parameters involved in this constraint

Method Detail

getText

public java.lang.String getText()

Gets the text of this constraint.

Returns:

the text of this constraint

setText

public void setText(java.lang.String text)

Sets the text of this constraint.

Parameters:

text -

getParams

public java.util.ArrayList<Parameter> getParams()

Returns the list of parameters involved in this constraint.

Returns:

the list of parameters

setParams

public void setParams(java.util.ArrayList<Parameter> params)

Sets the list of parameters involved in this constraint.

Parameters:

params -

getHiddenParameterHelper

public edu.uta.cse.fireeye.service.constraint.HiddenParameterHelper getHiddenParameterHelper()

involved

public boolean involved(Parameter param)

Checks if a parameter is involved in this constraint.

This method is needed to construct a constraint graph.

Parameters:

param -

Returns:

eval

public boolean eval(int[] test)

Evaluates this constraint against a given test

Note that if one or more parameters have a DONT_CARE value in the test, the constraint is considered to be satisfied. The assumption is that a constraint must be satisfiable. Otherwise, it should not be entered in the first place. Theoretically speaking, it should try all possible values of these parameter to make sure the constraint can be truly satisfied.

Returns:

true if the constraint is satisfied by the given test.

eval

public boolean eval(edu.uta.cse.fireeye.service.engine.Tuple tuple)

Evaluates this constraint against a given tuple.

Note that if one or more parameters in the constraint do not appear in the tuple, the constraint is considered to be satisfied.

Returns:

true if the constraint is satisfied by the given test.

eval

public boolean eval(edu.uta.cse.fireeye.service.engine.PVPair p1,
                    edu.uta.cse.fireeye.service.engine.PVPair p2)

Evaluates this constraint against two parameter value pairs.

This method is only used in building the constraint graph, where p1 and p2 should represent the parameters involved in this constraint.

Returns:

rval true if the two parameter pairs satisfy the constraint.

eval

public boolean eval(edu.uta.cse.fireeye.service.engine.PVPair p)

convert

public java.lang.Object convert(Parameter param,
                                int index)

Convert internal values to external values for constraint evaluation with the following logic:

• Boolean parameter: Use the real Boolean object.
• Enum parameter: Use the real String value
• Int parameter: Use the real Integer value

Parameters:

param -

index -

Returns:

getHiddenParameter

public Parameter getHiddenParameter()

toString

public java.lang.String toString()

Returns a string representation of this constraint.

Overrides:

toString in class java.lang.Object