hep.wired.cut

Interface Condition

All Known Implementing Classes:

AbstractCondition, BooleanCondition, DoubleCondition, IntegerCondition, LongCondition, StringCondition

public interface Condition

Condition that filter displayable objects based on a single attribute value.

Version:

$Id: Condition.java 13824 2011-05-04 18:30:02Z onoprien $

Author:

Mark Donszelmann, Dmitry Onoprienko

Method Summary

Methods

Modifier and Type	Method and Description
Object	get() Returns criteria used by this condition.
Cut	getCut() Returns the Cut this Condition belongs to.
ConditionDefinition	getDefinition() Returns ConditionDefinition associated with this condition.
String	getStatus() Returns status string describing what attribute values satisfy this condition in its current state.
boolean	isEnabled() Returns true is this condition is enabled.
boolean	isInverted() Returns true is this condition is inverted.
boolean	pass(org.freehep.util.Value value) Returns true is the value satisfies this condition.
void	reset() Resets condition to its default state.
void	set(Object value) Sets criteria to be used by this condition.
void	setCut(Cut cut) Sets the Cut this Condition belongs to.
void	setEnabled(boolean state) Enables or disables this condition.
void	setInverted(boolean state) Sets inversion state of this condition.

Method Detail

pass

boolean pass(org.freehep.util.Value value)

Returns true is the value satisfies this condition.

getCut

Cut getCut()

Returns the Cut this Condition belongs to.

isEnabled

boolean isEnabled()

Returns true is this condition is enabled.

isInverted

boolean isInverted()

Returns true is this condition is inverted.

getDefinition

ConditionDefinition getDefinition()

Returns ConditionDefinition associated with this condition.

getStatus

String getStatus()

Returns status string describing what attribute values satisfy this condition in its current state.

get

Object get()

Returns criteria used by this condition. The actual type of the return value depends on the type of the condition.

setCut

void setCut(Cut cut)

Sets the Cut this Condition belongs to.

setEnabled

void setEnabled(boolean state)

Enables or disables this condition.

setInverted

void setInverted(boolean state)

Sets inversion state of this condition.

set

void set(Object value)

Sets criteria to be used by this condition. The actual type of the argument depends on the type of the condition.

reset

void reset()

Resets condition to its default state. For most kinds of conditions, that means nothing (everything) is cut if the condition is not (is) inverted. Boolean conditions are an exception.