prefuse.visual.expression
Class InGroupPredicate

java.lang.Object
  prefuse.data.expression.AbstractExpression
      prefuse.visual.expression.GroupExpression
          prefuse.visual.expression.InGroupPredicate

All Implemented Interfaces:

java.util.EventListener, ExpressionListener, Expression, Function, Predicate

Direct Known Subclasses:

SearchPredicate

public class InGroupPredicate
extends GroupExpression
implements Predicate

Expression that indicates if an item is currently a member of a particular data group. The data group name is provided by a String-valued sub-expression.

Author:

jeffrey heer

Field Summary

Fields inherited from class prefuse.visual.expression.GroupExpression

m_group

Fields inherited from interface prefuse.data.expression.Function

VARARGS

Constructor Summary

InGroupPredicate()
Create a new InGroupPredicate.

InGroupPredicate(java.lang.String group)
Create a new InGroupPredicate.

Method Summary

java.lang.Object	get(Tuple t) By default, throws an UnsupportedOperationException.
boolean	getBoolean(Tuple t) By default, throws an UnsupportedOperationException.
java.lang.String	getName() Get the name of this function.
java.lang.Class	getType(Schema s) Returns the type that this expression evaluates to when tuples with the given Schema are provided as input.

Methods inherited from class prefuse.visual.expression.GroupExpression

addParameter, getGroup, getParameterCount, toString

Methods inherited from class prefuse.data.expression.AbstractExpression

addChildListeners, addExpressionListener, expressionChanged, fireExpressionChange, getDouble, getFloat, getInt, getLong, hasListeners, removeChildListeners, removeExpressionListener, visit

Methods inherited from class java.lang.Object

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

Methods inherited from interface prefuse.data.expression.Expression

addExpressionListener, getDouble, getFloat, getInt, getLong, removeExpressionListener, visit

Constructor Detail

InGroupPredicate

public InGroupPredicate()

Create a new InGroupPredicate.

InGroupPredicate

public InGroupPredicate(java.lang.String group)

Create a new InGroupPredicate.

Parameters:

group - @param group the data group name to use as a parameter

Method Detail

get

public java.lang.Object get(Tuple t)

Description copied from class: AbstractExpression

By default, throws an UnsupportedOperationException.

Specified by:

get in interface Expression

Overrides:

get in class AbstractExpression

Parameters:

t - the input Tuple

Returns:

the Expression return value, as an Object

See Also:

Expression.get(prefuse.data.Tuple)

getBoolean

public boolean getBoolean(Tuple t)

Description copied from class: AbstractExpression

By default, throws an UnsupportedOperationException.

Specified by:

getBoolean in interface Expression

Overrides:

getBoolean in class AbstractExpression

Parameters:

t - the input Tuple

Returns:

the Expression return value, as a boolean

See Also:

Expression.getBoolean(prefuse.data.Tuple)

getName

public java.lang.String getName()

Description copied from interface: Function

Get the name of this function.

Specified by:

getName in interface Function

Returns:

the function name

See Also:

Function.getName()

getType

public java.lang.Class getType(Schema s)

Description copied from interface: Expression

Returns the type that this expression evaluates to when tuples with the given Schema are provided as input.

Specified by:

getType in interface Expression

See Also:

Expression.getType(prefuse.data.Schema)