com.monad.homerun.filter
Class ListScreen

java.lang.Object
  com.monad.homerun.filter.Screen
      com.monad.homerun.filter.ListScreen

All Implemented Interfaces:

java.io.Serializable

public class ListScreen
extends Screen

ListScreen is a Screen for comparing objects to a fixed list of names. That is, the screen passes the object if it is on/not on the list.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.monad.homerun.filter.Screen

COMPONENT, FILTER, INST_PROP, LIST, RELATION, TYPE, TYPE_PROP

Constructor Summary

ListScreen()

ListScreen(boolean alternate, java.lang.String[] list, int operator)

ListScreen(ListScreen screen)

Method Summary

java.lang.String[]	getList() Returns the names on the list
int	getOperator() Returns the screen operator
boolean	isRuntime(Screener screener) Returns true if testing screen relies on runtime state of system
boolean	pass(Screener screener, java.lang.String domain, java.lang.String objectName, FilterTrace trace) Tests the object against the screen (with optional tracing)
java.lang.String	toCommaList()
java.lang.String	toString() Returns a string representation of the Screen
boolean	validate(Screener screener, java.lang.String domain, FilterTrace trace) Validates the terms of the screen with optional tracing

Methods inherited from class com.monad.homerun.filter.Screen

clone, getNote, getType, isAlternate, setNote

Methods inherited from class java.lang.Object

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

Constructor Detail

ListScreen

public ListScreen()

ListScreen

public ListScreen(boolean alternate,
                  java.lang.String[] list,
                  int operator)

ListScreen

public ListScreen(ListScreen screen)

Method Detail

getList

public java.lang.String[] getList()

Returns the names on the list

Returns:

list an array of names

getOperator

public int getOperator()

Returns the screen operator

Returns:

oper the screen operator

toString

public java.lang.String toString()

Description copied from class: Screen

Returns a string representation of the Screen

Overrides:

toString in class Screen

Returns:

a descriptive screen

isRuntime

public boolean isRuntime(Screener screener)

Description copied from class: Screen

Returns true if testing screen relies on runtime state of system

Specified by:

isRuntime in class Screen

Returns:

true if runtime

validate

public boolean validate(Screener screener,
                        java.lang.String domain,
                        FilterTrace trace)

Validates the terms of the screen with optional tracing

Specified by:

validate in class Screen

Parameters:

screener - the Screening agent

domain - the domain of the object being screened

trace - the optional trace object

Returns:

true if screen valid

pass

public boolean pass(Screener screener,
                    java.lang.String domain,
                    java.lang.String objectName,
                    FilterTrace trace)

Tests the object against the screen (with optional tracing)

Specified by:

pass in class Screen

Parameters:

screener - the Screening agent

domain - the domain of the object being screened

objectName - the object being screened

trace - the optional trace object

Returns:

true if object passes through screen

toCommaList

public java.lang.String toCommaList()