story.dbcore.parameters
Class AttComparedToConstParameter

java.lang.Object
  extended by story.dbcore.parameters.Parameter
      extended by story.dbcore.parameters.BooleanReturnParameter
          extended by story.dbcore.parameters.AttComparedToConstParameter
Direct Known Subclasses:
NodeIsSubnodeTypeParameter

public class AttComparedToConstParameter
extends BooleanReturnParameter

A filter parameter indicating that a node's attribute should equal, or be greater than, some constant value.


Constructor Summary
AttComparedToConstParameter(VariableID nodeReference, AttributeID attribute, AttributeValue value, boolean test, 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 getAttributeID()
           
 AttributeValue getAttributeValue()
           
 VariableID getNodeReferenceID()
           
 boolean getOverrideInheritance()
           
 boolean getTest()
          Returns true if the test is whether node1.attribute > constant.
 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

AttComparedToConstParameter

public AttComparedToConstParameter(VariableID nodeReference,
                                   AttributeID attribute,
                                   AttributeValue value,
                                   boolean test,
                                   boolean overrideInheritance)
Constructor.

Parameters:
nodeReference - The name of the reference by which the node should already be stored.
attribute - The ID of the attribute to check.
value - The constant value to check against the attribute.
test - Set to true to test whether the node's attribute is greater than the constant. Set to false to test whether the node's attribute is equal to the constant.
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

getNodeReferenceID

public VariableID getNodeReferenceID()

getAttributeID

public AttributeID getAttributeID()

getTest

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


getAttributeValue

public AttributeValue getAttributeValue()

getOverrideInheritance

public boolean getOverrideInheritance()

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

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.