story.dbcore.parameters
Class ThereExistsParameter

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

public class ThereExistsParameter
extends BooleanReturnParameter

A filter parameter that queries a nested ParameterSet and tests the number of results against a constant. Useful for provisional matches, such as "either node X is related to node Y, or Node X has a parent related to node Y," the latter half of which would use this class.


Constructor Summary
ThereExistsParameter(ParameterSet query, ComparisonType comparisonType, int 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.
 ComparisonType getComparisonType()
           
 ParameterSet getQuery()
           
 int 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

ThereExistsParameter

public ThereExistsParameter(ParameterSet query,
                            ComparisonType comparisonType,
                            int target)
                     throws Scheherexception
Constructor.

Parameters:
query - The parameters to query.
comparisonType - Whether to report satisfaction if the number of matches is greater than, less than or equal to the target.
target - The target number of matches to anticipate for the query, interpreted as per comparisonType.
Throws:
Scheherexception
Method Detail

getQuery

public ParameterSet getQuery()

getComparisonType

public ComparisonType getComparisonType()

getTarget

public int 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.