story.dbcore.parameters
Class AttComparedToAttParameter

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

public class AttComparedToAttParameter
extends BooleanReturnParameter

A filter (BooleanReturn) parameter comparing the attributes of two nodes and returning true if (a) the first node is greater than the second, or (b) the first node equals the second, depending on a constructor flag.


Constructor Summary
AttComparedToAttParameter(VariableID node1reference, VariableID node2reference, AttributeID attribute, boolean testGreaterThan, boolean overrideInheritance)
          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.
 AttributeID getAttribute()
           
 VariableID getNode1()
           
 VariableID getNode2()
           
 boolean getOverrideInheritance()
           
 boolean getTest()
          Returns true if the test is whether node1.attribute > node2.attribute.
 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

AttComparedToAttParameter

public AttComparedToAttParameter(VariableID node1reference,
                                 VariableID node2reference,
                                 AttributeID attribute,
                                 boolean testGreaterThan,
                                 boolean overrideInheritance)
Constructor.

Parameters:
node1reference - The name of the reference by which the node1 should already be stored.
node2reference - The name of the reference by which the node1 should already be stored.
attribute - The ID of the attribute to check.
test - Pass true for the parameter to return true iff node1.attribute > node2.attribute. Pass false for the parameter to return true iff node1.attribute == node2.attribute.
overrideInheritance - Set to true if you want to only check a candidate node itself, but false if you want to allow the node to inherit the value from a neighborhing node (according to the rules set in LinkProperties).
Method Detail

getNode1

public VariableID getNode1()

getNode2

public VariableID getNode2()

getAttribute

public AttributeID getAttribute()

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

getTest

public boolean getTest()
Returns true if the test is whether node1.attribute > node2.attribute. Returns false if the desired test is whether node1.attribute == node2.attribute.


getOverrideInheritance

public boolean getOverrideInheritance()

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


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