burlap.oomdp.legacy

Class StateYAMLParser

java.lang.Object

burlap.oomdp.legacy.StateYAMLParser

All Implemented Interfaces:

StateParser

public class StateYAMLParser
extends java.lang.Object
implements StateParser

A StateParser class that uses the YAML file format and can can convert states to YAML strings (and back from them) for any possible input domain. Use of this class requries the SnakeYaml java library.

Author:

James MacGlashan

Field Summary

Fields

Modifier and Type	Field and Description
protected Domain	domain The domain holding the object class definitions that states represented in yaml strings will be converted to.

Constructor Summary

Constructors

Constructor and Description
StateYAMLParser(Domain domain) Initializes with a a given domain object.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getYAMLPrepared(State s) Returns the data structure of a state that is passed to YAML.
java.lang.String	stateToString(State s) Converts state s into a parsable string representation.
State	stringToState(java.lang.String str) Converts a string into a State object assuming the string representation was produced using this state parser.

Methods inherited from class java.lang.Object

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

Field Detail

domain

protected Domain domain

The domain holding the object class definitions that states represented in yaml strings will be converted to. This is not necessary if parsing will only go from states to strings and not strings to states.

Constructor Detail

StateYAMLParser

public StateYAMLParser(Domain domain)

Initializes with a a given domain object. The domain object is used for converting from strings to states. Specifically, the object instances will be assigned to the object class in the domain object with the given name in the state string.

Parameters:

domain - the domain object to which state objects will be associated.

Method Detail

getYAMLPrepared

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getYAMLPrepared(State s)

Returns the data structure of a state that is passed to YAML.

Parameters:

s - the input state to turn into a YAML prepared datastructure

Returns:

YAML prepared data structure representation of the state

stateToString

public java.lang.String stateToString(State s)

Description copied from interface: StateParser

Converts state s into a parsable string representation.

Specified by:

stateToString in interface StateParser

Parameters:

s - the state to convert

Returns:

a parsable string representation of state s.

stringToState

public State stringToState(java.lang.String str)

Description copied from interface: StateParser

Converts a string into a State object assuming the string representation was produced using this state parser.

Specified by:

stringToState in interface StateParser

Parameters:

str - a string representation of a state

Returns:

the state object that corresponds to the string representation.