OpenSchemaPlanner.Node (Document Structuring schema for Natural Language Generation 0.0.3-SNAPSHOT API)

java.lang.Object
- net.sf.openschema.OpenSchemaPlanner.Node

Enclosing class:: OpenSchemaPlanner

protected class OpenSchemaPlanner.Node
extends Object

Node inner class.

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`name` Name, for debugging purposes
`List<OpenSchemaPlanner.Node>`	`outgoing` Nodes that can be accessed from the current one.
`OpenSchemaPlanner.Predicate`	`predicate` Predicate held by this node (if any).
`int`	`type` Type of the node (EMPTY_NODE, PREDICATE_NODE, etc.).
`Map<String,String>`	`vars` Mapping from global-to-local variable names (if any).

Constructor Summary

Constructors
Constructor and Description
`Node()` Create an EMPTY_NODE.
`Node(int type)` Create a node of a given type.
`Node(int type, String name)` Create a node of a given type.
`Node(OpenSchemaPlanner.Predicate predicate, Map<String,String> vars)` Create a PREDICATE_NODE.
`Node(String name)` Create an EMPTY_NODE.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<OpenSchemaPlanner.Node>`	`getOutgoing()` Access all nodes accessable from this node.
`OpenSchemaPlanner.Predicate`	`getPredicate()` Access the predicate referenced by this node (if any).
`int`	`getType()` Node type accessor.
`Map<String,String>`	`getVars()` Access the global-to-local variable names mapping (if any).
`boolean`	`isAggrBoundary()` Check whether the type of the node is AGGRBOUNDARY_NODE.
`boolean`	`isParBoundary()` Check whether the type of the node is PARBOUNDARY_NODE.
`boolean`	`isPredicate()` Check whether the type of the node is PREDICATE_NODE.
`void`	`linkTo(OpenSchemaPlanner.Node destination)` Add a link from the current node to the destination node.
`String`	`toString()` String rendering (for debugging purposes).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - type
```
public int type
```
    Type of the node (EMPTY_NODE, PREDICATE_NODE, etc.).
  - name
```
public String name
```
    Name, for debugging purposes
  - outgoing
```
public List<OpenSchemaPlanner.Node> outgoing
```
    Nodes that can be accessed from the current one.
  - predicate
```
public OpenSchemaPlanner.Predicate predicate
```
    Predicate held by this node (if any).
  - vars
```
public Map<String,String> vars
```
    Mapping from global-to-local variable names (if any).
- Constructor Detail
  - Node
```
public Node()
```
    Create an EMPTY_NODE.
  - Node
```
public Node(String name)
```
    Create an EMPTY_NODE.
  - Node
```
public Node(int type)
```
    Create a node of a given type.
  - Node
```
public Node(int type,
            String name)
```
    Create a node of a given type.
  - Node
```
public Node(OpenSchemaPlanner.Predicate predicate,
            Map<String,String> vars)
```
    Create a PREDICATE_NODE.
- Method Detail
  - linkTo
```
public void linkTo(OpenSchemaPlanner.Node destination)
```
    Add a link from the current node to the destination node.
  - getType
```
public int getType()
```
    Node type accessor.
  - isPredicate
```
public boolean isPredicate()
```
    Check whether the type of the node is PREDICATE_NODE.
  - isAggrBoundary
```
public boolean isAggrBoundary()
```
    Check whether the type of the node is AGGRBOUNDARY_NODE.
  - isParBoundary
```
public boolean isParBoundary()
```
    Check whether the type of the node is PARBOUNDARY_NODE.
  - getOutgoing
```
public List<OpenSchemaPlanner.Node> getOutgoing()
```
    Access all nodes accessable from this node.
  - getVars
```
public Map<String,String> getVars()
```
    Access the global-to-local variable names mapping (if any).
  - getPredicate
```
public OpenSchemaPlanner.Predicate getPredicate()
```
    Access the predicate referenced by this node (if any).
  - toString
```
public String toString()
```
    String rendering (for debugging purposes).
    
    Overrides:
    
    toString in class Object

Class OpenSchemaPlanner.Node

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

type

name

outgoing

predicate

vars

Constructor Detail

Node

Node

Node

Node

Node

Method Detail

linkTo

getType

isPredicate

isAggrBoundary

isParBoundary

getOutgoing

getVars

getPredicate

toString