org.oakgp.serialize

Class NodeReader

java.lang.Object

org.oakgp.serialize.NodeReader

All Implemented Interfaces:

Closeable, AutoCloseable

public final class NodeReader
extends Object
implements Closeable

Creates Node instances from String representations.

e.g. The String:

 (+ 9 5)
 

will produce the Node:

 new FunctionNode(new Add(), createArguments(new ConstantNode(9), new ConstantNode(5))
 

Constructor Summary

Constructors

Constructor and Description
NodeReader(String input, Function[] functions, ConstantNode[] constants, VariableSet variableSet) Creates a NodeReader that reads from the given java.lang.String.

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	isEndOfStream() Returns true if there is no more data to read from the underlying stream, else false.
static boolean	isValidDisplayName(String displayName) Returns true if the given String is suitable for use as the display name of a Function, else {code false}.
Node	readNode() Creates and returns a Node which represents the next s-expression read from the input.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NodeReader

public NodeReader(String input,
                  Function[] functions,
                  ConstantNode[] constants,
                  VariableSet variableSet)

Creates a NodeReader that reads from the given java.lang.String.

Parameters:

input - contains the s-expressions, representing programs as tree structures, that will be read to construct new Node instances

functions - a collection of Functions to use to represent functions read from input

constants - a collection of ConstantNodes to use to represent constants read from input

variableSet - the variable set to use to represent variables read from input

Method Detail

readNode

public Node readNode()
              throws IOException

Creates and returns a Node which represents the next s-expression read from the input.

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

isEndOfStream

public boolean isEndOfStream()
                      throws IOException

Returns true if there is no more data to read from the underlying stream, else false.

Throws:

IOException

isValidDisplayName

public static boolean isValidDisplayName(String displayName)

Returns true if the given String is suitable for use as the display name of a Function, else {code false}.

A String is considered suitable as a display name for a Function - as returned from Function.getDisplayName() - if it can be successfully parsed by a NodeReader. Suitable function names do not start with a number or contain any of the special characters used to represent the start or end of functions (i.e. ( and )), arrays (i.e. [ and ]) or strings (i.e. ").