story.dbcore.parameters
Class RelatedNodeParameter

java.lang.Object
  extended by story.dbcore.parameters.Parameter
      extended by story.dbcore.parameters.MatchingParameter
          extended by story.dbcore.parameters.RelatedNodeParameter

public class RelatedNodeParameter
extends MatchingParameter

A Node parameter which will match a node which has a particular relationship to a concrete node or a previously matched node.


Constructor Summary
RelatedNodeParameter(NodeAddress nodeAddress, LinkType linkType, LinkDirection linkDirection, boolean overrideInference)
          Constructor with no outreference and an absolute node
RelatedNodeParameter(NodeAddress nodeAddress, LinkType linkType, LinkDirection linkDirection, boolean overrideInference, VariableID outreference)
          Constructor with an outgoing reference ID and an absolute node
RelatedNodeParameter(VariableID nodeReference, LinkType linkType, LinkDirection linkDirection, boolean overrideInference)
          Constructor with no outreference and node from a reference
RelatedNodeParameter(VariableID nodeReference, LinkType linkType, LinkDirection linkDirection, boolean overrideInference, VariableID outreference)
          Constructor with an outgoing reference ID and node from a reference
 
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.
 LinkDirection getLinkDirection()
          Return the link direction.
 LinkType getLinkType()
          Return the link type.
 NodeAddress getNodeAddress()
          Return the NodeAddress of the required node if constructed with one (i.e., if usesReference() returns false; otherwise, throws exception).
 VariableID getNodeReferenceID()
          Return the VariableID of the required node reference if constructed with one (i.e., if usesReference() returns true; otherwise, throws exception
 boolean getOverrideInference()
          Return whether inference override is on for this query.
 Parameter makeCopy()
          All Parameters must include a self-duplication function.
 ReferenceReqSet referenceRequirements()
          Instantiation of abstract function from superclass.
 VariableType referenceType()
          Instantiation of abstract function from superclass.
 java.lang.StringBuffer specificRender()
          Render as a StringBuffer
 boolean usesReference()
          Returns true if constructed with a node reference for its input node; false if constructed with an absolute address.
 
Methods inherited from class story.dbcore.parameters.MatchingParameter
getReference, makeClone, makeCloneWithNewReference, referenceSet, render
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RelatedNodeParameter

public RelatedNodeParameter(VariableID nodeReference,
                            LinkType linkType,
                            LinkDirection linkDirection,
                            boolean overrideInference)
                     throws Scheherexception
Constructor with no outreference and node from a reference

Throws:
Scheherexception

RelatedNodeParameter

public RelatedNodeParameter(VariableID nodeReference,
                            LinkType linkType,
                            LinkDirection linkDirection,
                            boolean overrideInference,
                            VariableID outreference)
                     throws Scheherexception
Constructor with an outgoing reference ID and node from a reference

Throws:
Scheherexception

RelatedNodeParameter

public RelatedNodeParameter(NodeAddress nodeAddress,
                            LinkType linkType,
                            LinkDirection linkDirection,
                            boolean overrideInference)
                     throws Scheherexception
Constructor with no outreference and an absolute node

Throws:
Scheherexception

RelatedNodeParameter

public RelatedNodeParameter(NodeAddress nodeAddress,
                            LinkType linkType,
                            LinkDirection linkDirection,
                            boolean overrideInference,
                            VariableID outreference)
                     throws Scheherexception
Constructor with an outgoing reference ID and an absolute node

Throws:
Scheherexception
Method Detail

usesReference

public boolean usesReference()
Returns true if constructed with a node reference for its input node; false if constructed with an absolute address.


getLinkType

public LinkType getLinkType()
Return the link type.


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

getLinkDirection

public LinkDirection getLinkDirection()
Return the link direction.


getNodeAddress

public NodeAddress getNodeAddress()
                           throws Scheherexception
Return the NodeAddress of the required node if constructed with one (i.e., if usesReference() returns false; otherwise, throws exception).

Throws:
Scheherexception

getNodeReferenceID

public VariableID getNodeReferenceID()
                              throws Scheherexception
Return the VariableID of the required node reference if constructed with one (i.e., if usesReference() returns true; otherwise, throws exception.);

Throws:
Scheherexception

getOverrideInference

public boolean getOverrideInference()
Return whether inference override is on for this query.


specificRender

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

Specified by:
specificRender in class Parameter
Throws:
Scheherexception

referenceType

public VariableType referenceType()
Instantiation of abstract function from superclass.

Specified by:
referenceType in class MatchingParameter

referenceRequirements

public ReferenceReqSet referenceRequirements()
Instantiation of abstract function from superclass.

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.