story.dbcore.parameters
Class BooleanEvalParameter

java.lang.Object
  extended by story.dbcore.parameters.Parameter
      extended by story.dbcore.parameters.BooleanReturnParameter
          extended by story.dbcore.parameters.BooleanEvalParameter

public class BooleanEvalParameter
extends BooleanReturnParameter

A filter parameter requiring that a previously stored Boolean reference be true or false.


Constructor Summary
BooleanEvalParameter(VariableID boolReference, boolean target)
          Constructor.
 
Method Summary
 NodeAddressSet assumedNodes()
          Each concretizing class needs to provide a list of nodes that it assumes exist prior to evaluation, i.e., concrete nodes with which it is constructed.
 VariableID getBoolReferenceID()
           
 boolean getTarget()
           
 Parameter makeCopy()
          All Parameters must include a self-duplication function.
 ReferenceReqSet referenceRequirements()
          Each concretizing class needs to provide a ReferenceReqSet of all the references which must be set prior to the parameter's evaluation.
 java.lang.StringBuffer specificRender()
          Render as a StringBuffer
 
Methods inherited from class story.dbcore.parameters.Parameter
makeClone, render
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BooleanEvalParameter

public BooleanEvalParameter(VariableID boolReference,
                            boolean target)
Constructor.

Parameters:
boolReference - The name of the reference by which the boolean should already be stored.
target - What this parameter should filter for: true or false values of the boolReference.
Method Detail

getBoolReferenceID

public VariableID getBoolReferenceID()

getTarget

public boolean getTarget()

specificRender

public java.lang.StringBuffer specificRender()
                                      throws Scheherexception
Render as a StringBuffer

Specified by:
specificRender in class Parameter
Throws:
Scheherexception

referenceRequirements

public ReferenceReqSet referenceRequirements()
Description copied from class: Parameter
Each concretizing class needs to provide a ReferenceReqSet of all the references which must be set prior to the parameter's evaluation.

Specified by:
referenceRequirements in class Parameter

makeCopy

public Parameter makeCopy()
Description copied from class: Parameter
All Parameters must include a self-duplication function.

Specified by:
makeCopy in class Parameter

assumedNodes

public NodeAddressSet assumedNodes()
Description copied from class: Parameter
Each concretizing class needs to provide a list of nodes that it assumes exist prior to evaluation, i.e., concrete nodes with which it is constructed.

Specified by:
assumedNodes in class Parameter


Copyright © 2011 David K. Elson. All Rights Reserved.