de.jreality.toolsystem.config

Class ToolSystemConfiguration

java.lang.Object

de.jreality.toolsystem.config.ToolSystemConfiguration

public class ToolSystemConfiguration
extends Object

TODO: comment this. This is the main code that will read the .xml files that calls other xml files for each device to set up the interactions. An object of the Type ToolSystemConfiguration contains multiple Lists for RawDeviceConfig, RawMapping, VirtualDeviceConfig, VirtualConstants and VirtualMappings This code is called on every startup.

Author:

weissman

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TOOLCONFIG

Constructor Summary

Constructors

Constructor and Description
ToolSystemConfiguration()

Method Summary

Modifier and Type	Method and Description
void	addRawDeviceConfig(RawDeviceConfig config)
void	addRawMapping(RawMapping mapping)
void	addVirtualConstant(VirtualConstant constant)
void	addVirtualDeviceConfig(VirtualDeviceConfig config)
void	addVirtualMapping(VirtualMapping mapping)
static InputStream	domToInputStream(Node root)
static void	domToString(Node node, StringBuffer sb, int ind)
List<RawDeviceConfig>	getRawConfigs()
List<RawMapping>	getRawMappings()
static String	getStringFromFile(File aFile) Fetch the entire contents of a text file, and return it in a String.
List<VirtualDeviceConfig>	getVirtualConfigs()
List<VirtualConstant>	getVirtualConstants()
List<VirtualMapping>	getVirtualMappings()
static ToolSystemConfiguration	loadConfiguration(Input xmlFile) given the Input object of an xmlFile, this method returns an object of type "toolsystemconfiguration".
static ToolSystemConfiguration	loadConfiguration(List<Input> inputs) loadconfiguration that will be called for each element of a list.
static ToolSystemConfiguration	loadDefaultConfiguration()
static ToolSystemConfiguration	loadDefaultDesktopAndPortalConfiguration()
static ToolSystemConfiguration	loadDefaultDesktopConfiguration()
static ToolSystemConfiguration	loadDefaultDesktopConfiguration(List<Input> additionalInputs)
static ToolSystemConfiguration	loadDefaultPortalConfiguration()
static ToolSystemConfiguration	loadDefaultPortalConfiguration(List<Input> additionalInputs)
static ToolSystemConfiguration	loadRemotePortalConfiguration()
static ToolSystemConfiguration	loadRemotePortalMasterConfiguration()
static void	main(String[] args)
static void	setFileFromString(File aFile, String aContents) Change the contents of text file in its entirety, overwriting any existing text.
void	setRawConfigs(List<RawDeviceConfig> rawConfigs)
void	setRawMappings(List<RawMapping> rawMappings)
void	setVirtualConfigs(List<VirtualDeviceConfig> virtualConfigs)
void	setVirtualConstants(List<VirtualConstant> virtualConstants)
void	setVirtualMappings(List<VirtualMapping> virtualMappings)
static void	tempGamePadConfigJInputWriter() this is where we can add more devices to the toolsystemconfig that are not written in the .xml file.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_TOOLCONFIG

public static String DEFAULT_TOOLCONFIG

Constructor Detail

ToolSystemConfiguration

public ToolSystemConfiguration()

Method Detail

loadDefaultConfiguration

public static ToolSystemConfiguration loadDefaultConfiguration()

loadDefaultDesktopAndPortalConfiguration

public static ToolSystemConfiguration loadDefaultDesktopAndPortalConfiguration()
                                                                        throws IOException

Throws:

IOException

loadDefaultDesktopConfiguration

public static ToolSystemConfiguration loadDefaultDesktopConfiguration()
                                                               throws IOException

Throws:

IOException

loadDefaultDesktopConfiguration

public static ToolSystemConfiguration loadDefaultDesktopConfiguration(List<Input> additionalInputs)
                                                               throws IOException

Throws:

IOException

loadDefaultPortalConfiguration

public static ToolSystemConfiguration loadDefaultPortalConfiguration()
                                                              throws IOException

Throws:

IOException

loadRemotePortalConfiguration

public static ToolSystemConfiguration loadRemotePortalConfiguration()
                                                             throws IOException

Throws:

IOException

loadRemotePortalMasterConfiguration

public static ToolSystemConfiguration loadRemotePortalMasterConfiguration()
                                                                   throws IOException

Throws:

IOException

loadDefaultPortalConfiguration

public static ToolSystemConfiguration loadDefaultPortalConfiguration(List<Input> additionalInputs)
                                                              throws IOException

Throws:

IOException

loadConfiguration

public static ToolSystemConfiguration loadConfiguration(Input xmlFile)
                                                 throws IOException

given the Input object of an xmlFile, this method returns an object of type "toolsystemconfiguration". It is intended to read the "main" configuration file that will call device specific configuration files.

Parameters:

xmlFile -

Returns:

Throws:

IOException

loadConfiguration

public static ToolSystemConfiguration loadConfiguration(List<Input> inputs)
                                                 throws IOException

loadconfiguration that will be called for each element of a list. The result is then merged to one toolsystemconfig

Parameters:

inputs -

Returns:

Throws:

IOException

getRawConfigs

public List<RawDeviceConfig> getRawConfigs()

getRawMappings

public List<RawMapping> getRawMappings()

getVirtualConfigs

public List<VirtualDeviceConfig> getVirtualConfigs()

getVirtualMappings

public List<VirtualMapping> getVirtualMappings()

getVirtualConstants

public List<VirtualConstant> getVirtualConstants()

setRawConfigs

public void setRawConfigs(List<RawDeviceConfig> rawConfigs)

setRawMappings

public void setRawMappings(List<RawMapping> rawMappings)

setVirtualConfigs

public void setVirtualConfigs(List<VirtualDeviceConfig> virtualConfigs)

setVirtualMappings

public void setVirtualMappings(List<VirtualMapping> virtualMappings)

setVirtualConstants

public void setVirtualConstants(List<VirtualConstant> virtualConstants)

addRawDeviceConfig

public void addRawDeviceConfig(RawDeviceConfig config)

addRawMapping

public void addRawMapping(RawMapping mapping)

addVirtualDeviceConfig

public void addVirtualDeviceConfig(VirtualDeviceConfig config)

addVirtualMapping

public void addVirtualMapping(VirtualMapping mapping)

addVirtualConstant

public void addVirtualConstant(VirtualConstant constant)

toString

public String toString()

Overrides:

toString in class Object

domToInputStream

public static InputStream domToInputStream(Node root)
                                    throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

domToString

public static void domToString(Node node,
                               StringBuffer sb,
                               int ind)

tempGamePadConfigJInputWriter

public static void tempGamePadConfigJInputWriter()

this is where we can add more devices to the toolsystemconfig that are not written in the .xml file. e.g. for now: new controllers manageable by jInput. note: when it finds a controller, it add the toolconfig-temp-gamepad.xml in the toolconfig-split.xml author: padilla Feb 2015

setFileFromString

public static void setFileFromString(File aFile,
                                     String aContents)
                              throws FileNotFoundException,
                                     IOException

Change the contents of text file in its entirety, overwriting any existing text. This style of implementation throws all exceptions to the caller.

Parameters:

aFile - is an existing file which can be written to.

Throws:

IllegalArgumentException - if param does not comply.

FileNotFoundException - if the file does not exist.

IOException - if problem encountered during write.

getStringFromFile

public static String getStringFromFile(File aFile)

Fetch the entire contents of a text file, and return it in a String. This style of implementation does not throw Exceptions to the caller.

Parameters:

aFile - is a file which already exists and can be read.

main

public static void main(String[] args)
                 throws IOException

Throws:

IOException