edu.ou.mlfw.config
Class ClientMapping

java.lang.Object
  extended by edu.ou.mlfw.config.ClientMapping

public class ClientMapping
extends java.lang.Object

A ClientMapping is a helper class for a WorldConfig. It maps from a Controllable in the World's simulator, to the ClientInitializer for the Client that will control that Controllable during the execution of the simulator. The controllable name should be a String that uniquely identifies the Controllable through a call to getName(), and the target client location should be the xml file for a ClientInitializer. This class is intended to be serialized to xml that can be hand edited, so future changes should take care to maintain xml readability.


Constructor Summary
ClientMapping(java.lang.String controllableName, java.io.File clientLocation)
          Sole constructor for a ClientMappingEntry, maps a controllable name to a client location.
 
Method Summary
 java.io.File getClientInitializerFile()
           
 java.lang.String getControllableName()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ClientMapping

public ClientMapping(java.lang.String controllableName,
                     java.io.File clientLocation)
Sole constructor for a ClientMappingEntry, maps a controllable name to a client location.

Parameters:
controllableName - A string uniquely identifying a controllable.
clientLocation - An xml file for a ClientInitializer.
Method Detail

getClientInitializerFile

public java.io.File getClientInitializerFile()
Returns:
The file location for this mapping's ClientInitializer.

getControllableName

public java.lang.String getControllableName()
Returns:
The name of this mapping's Controllable.