com.monad.homerun.filter
Class RelationScreen

java.lang.Object
  extended by com.monad.homerun.filter.Screen
      extended by com.monad.homerun.filter.RelationScreen
All Implemented Interfaces:
java.io.Serializable

public class RelationScreen
extends Screen

RelationScreen extends Screen to describe object model relations. The screen passes the object if it satisfies the relation. Note that this is a 'runtime' screen, meaning that objects may pass or fail depending on the current state of their model.

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
RelationScreen()
           
RelationScreen(boolean alternate, Relation relation)
           
RelationScreen(boolean alternate, Relation relation, java.lang.String compObjName)
           
RelationScreen(RelationScreen screen)
           
 
Method Summary
 java.lang.String getCompObjName()
           
 Relation getRelation()
           
 java.lang.String getSpecType()
           
 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 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

RelationScreen

public RelationScreen()

RelationScreen

public RelationScreen(boolean alternate,
                      Relation relation)

RelationScreen

public RelationScreen(boolean alternate,
                      Relation relation,
                      java.lang.String compObjName)

RelationScreen

public RelationScreen(RelationScreen screen)
Method Detail

getRelation

public Relation getRelation()

getCompObjName

public java.lang.String getCompObjName()

getSpecType

public java.lang.String getSpecType()

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


Copyright © 2006-2009 Richard Rodgers. All Rights Reserved.