story.dbcore.parameters
Class NodeParameter

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

public class NodeParameter
extends MatchingParameter

A Node parameter indicating that a particular node is required.


Constructor Summary
NodeParameter()
          Constructor with no argument; just requires a node.
NodeParameter(NodeAddress nodePrototype)
          Constructor with a NodeAddress for a prototype node
NodeParameter(NodeAddress nodePrototype, boolean exactNodeOnly)
          Constructor with a NodeAddress for a prototype node.
NodeParameter(NodeAddress nodePrototype, NodeRepositoryID nodeRepository)
          Constructor with a NodeAddress for a prototype node and a NodeRepository requirement.
NodeParameter(NodeAddress nodePrototype, NodeRepositoryID nodeRepository, VariableID reference)
          Constructor with a NodeAddress for a prototype node, a NodeRepository requirement and an outgoing reference ID.
NodeParameter(NodeAddress nodePrototype, VariableID reference)
          Constructor with a NodeAddress for a prototype node and an outgoing reference ID.
NodeParameter(NodeAddress nodePrototype, VariableID reference, boolean exactNodeOnly)
          Constructor with a NodeAddress for a prototype node and an outgoing reference ID.
NodeParameter(NodeRepositoryID nodeRepository)
          Constructor with only a NodeRepository requirement.
NodeParameter(NodeRepositoryID nodeRepository, VariableID reference)
          Constructor with a NodeRepository requirement and an outgoing reference ID.
NodeParameter(NodeType nodeType)
          Constructor with a NodeType requirement.
NodeParameter(NodeType nodeType, NodeRepositoryID nodeRepository)
          Constructor with a NodeType requirement and a NodeRepository requirement.
NodeParameter(NodeType nodeType, NodeRepositoryID nodeRepository, VariableID reference)
          Constructor with a NodeType requirement, a NodeRepository requirement and an outgoing reference ID.
NodeParameter(NodeType nodeType, VariableID reference)
          Constructor with a NodeType requirement and an outgoing reference ID.
NodeParameter(VariableID reference)
          Constructor with only outgoing reference ID; just requires a node.
 
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.
 boolean exactNodeOnly()
          Returns true if (a) a specific NodeAddress was given by the constructor, and (b) the parameter should only match that exact node (and exclude any subtypes or instances)
 NodeAddress getNodePrototype()
          Return the node prototype
 NodeRepositoryID getNodeRepositoryID()
          Return the required NodeRepository.
 NodeType getNodeType()
          Return the node type.
 Parameter makeCopy()
          Make a copy of the NodeParameter.
 ReferenceReqSet referenceRequirements()
          Instantiation of abstract function from superclass.
 VariableType referenceType()
          Each concretizing class needs to tell us what kind of variable would need to go into the reference SymbolTable should such a storage be needed.
 java.lang.StringBuffer specificRender()
          Render as a StringBuffer
 
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

NodeParameter

public NodeParameter(NodeType nodeType)
Constructor with a NodeType requirement.


NodeParameter

public NodeParameter(NodeType nodeType,
                     VariableID reference)
Constructor with a NodeType requirement and an outgoing reference ID.


NodeParameter

public NodeParameter(NodeAddress nodePrototype)
Constructor with a NodeAddress for a prototype node


NodeParameter

public NodeParameter(NodeAddress nodePrototype,
                     boolean exactNodeOnly)
Constructor with a NodeAddress for a prototype node. This constructor also allows you to require the parameter to match this particular node, as opposed to any subtype or instance of the node as a prototype. Set exactNodeOnly to true for this.


NodeParameter

public NodeParameter(NodeAddress nodePrototype,
                     VariableID reference)
Constructor with a NodeAddress for a prototype node and an outgoing reference ID.


NodeParameter

public NodeParameter(NodeAddress nodePrototype,
                     VariableID reference,
                     boolean exactNodeOnly)
Constructor with a NodeAddress for a prototype node and an outgoing reference ID. This constructor also allows you to require the parameter to match this particular node, as opposed to any subtype or instance of this node as a prototype. Set exactNodeOnly to true for this.


NodeParameter

public NodeParameter()
Constructor with no argument; just requires a node.


NodeParameter

public NodeParameter(VariableID reference)
Constructor with only outgoing reference ID; just requires a node.


NodeParameter

public NodeParameter(NodeType nodeType,
                     NodeRepositoryID nodeRepository)
Constructor with a NodeType requirement and a NodeRepository requirement.


NodeParameter

public NodeParameter(NodeType nodeType,
                     NodeRepositoryID nodeRepository,
                     VariableID reference)
Constructor with a NodeType requirement, a NodeRepository requirement and an outgoing reference ID.


NodeParameter

public NodeParameter(NodeAddress nodePrototype,
                     NodeRepositoryID nodeRepository)
Constructor with a NodeAddress for a prototype node and a NodeRepository requirement.


NodeParameter

public NodeParameter(NodeAddress nodePrototype,
                     NodeRepositoryID nodeRepository,
                     VariableID reference)
Constructor with a NodeAddress for a prototype node, a NodeRepository requirement and an outgoing reference ID.


NodeParameter

public NodeParameter(NodeRepositoryID nodeRepository)
Constructor with only a NodeRepository requirement.


NodeParameter

public NodeParameter(NodeRepositoryID nodeRepository,
                     VariableID reference)
Constructor with a NodeRepository requirement and an outgoing reference ID.

Method Detail

getNodeType

public NodeType getNodeType()
Return the node type.


getNodePrototype

public NodeAddress getNodePrototype()
Return the node prototype


getNodeRepositoryID

public NodeRepositoryID getNodeRepositoryID()
Return the required NodeRepository.


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

referenceType

public VariableType referenceType()
Description copied from class: MatchingParameter
Each concretizing class needs to tell us what kind of variable would need to go into the reference SymbolTable should such a storage be needed.

Specified by:
referenceType in class MatchingParameter

referenceRequirements

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

Specified by:
referenceRequirements in class Parameter

exactNodeOnly

public boolean exactNodeOnly()
Returns true if (a) a specific NodeAddress was given by the constructor, and (b) the parameter should only match that exact node (and exclude any subtypes or instances).`


makeCopy

public Parameter makeCopy()
Make a copy of the NodeParameter.

Specified by:
makeCopy in class Parameter


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