com.qualcomm.ftccommon.configuration

Class RobotConfigFileManager

java.lang.Object

com.qualcomm.ftccommon.configuration.RobotConfigFileManager

public class RobotConfigFileManager
extends java.lang.Object

A class that helps to manage robot configuration files and stores our list of resource ids that maps to robot configurations packaged with the apk.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RobotConfigFileManager.ConfigNameCheckResult

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG
static java.lang.String	FILE_EXT
static java.lang.String	FILE_LIST_COMMAND_DELIMITER
java.lang.String	noConfig
static java.lang.String	ROBOT_CONFIG_DESCRIPTION_GENERATE_XSLT
static java.lang.String	ROBOT_CONFIG_TAXONOMY_XML
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
RobotConfigFileManager()
RobotConfigFileManager(Activity activity)

Method Summary

Modifier and Type	Method and Description
protected void	addChild(org.w3c.dom.Document document, org.w3c.dom.Element parent, java.lang.String tag, java.lang.String contents)
void	changeHeaderBackground(int idColorHolder)
void	createConfigFolder() Builds the Folder on the sdcard that holds all of the configuration files if it doesn't exist.
static RobotConfigFile	deserializeConfig(java.lang.String serialized)
static java.util.List<RobotConfigFile>	deserializeXMLConfigList(java.lang.String objsSerialized)
RobotConfigFile	getActiveConfig()
RobotConfigFile	getActiveConfigAndUpdateUI()
RobotConfigFile	getConfigFromString(java.lang.String objSerialized)
static java.io.File	getFullPath(java.lang.String fileNameWithoutExtension)
java.lang.String	getRobotConfigDescription(XmlPullParser xpp) Returns a high-level human-readable description of an XML robot configuration or configuration template.
protected javax.xml.transform.Source	getRobotConfigDescriptionTransform() Returns a Source to the XSLT transformation that will transform robot config templates/configurations into human-readable descriptions.
static java.lang.String	getRobotConfigTemplateAttribute()
static java.lang.String	getRobotConfigTypeAttribute() Returns the value of the Robot@type attribute of the XML resources that we are interested in
protected javax.xml.transform.Source	getSourceFromPullParser(XmlPullParser xpp)
java.util.ArrayList<RobotConfigFile>	getXMLFiles() Gets the list of files from the Configuration File directory, and populates the global list used by the fileSpinner.
java.util.ArrayList<RobotConfigFile>	getXMLTemplates()
RobotConfigFileManager.ConfigNameCheckResult	isPlausibleConfigName(RobotConfigFile existingConfig, java.lang.String candidate, java.util.List<RobotConfigFile> extantConfigurations) Answers as to whether the candidate config name is a plausible one to use as the name of a new robot configuration.
void	sendActiveConfigToDriverStation()
void	sendRobotControllerActiveConfigAndUpdateUI(RobotConfigFile config)
static java.lang.String	serializeConfig(RobotConfigFile configFile)
static java.lang.String	serializeXMLConfigList(java.util.List<RobotConfigFile> configList)
void	setActiveConfig(boolean runningOnDriverStation, RobotConfigFile config)
void	setActiveConfig(RobotConfigFile cfgFile)
void	setActiveConfigAndUpdateUI(boolean runningOnDriverStation, RobotConfigFile configFile)
void	setActiveConfigAndUpdateUI(RobotConfigFile config)
static void	setXmlResourceIdSupplier(Supplier<java.util.Collection<java.lang.Integer>> supplier) Sets the collection into which our class filter will insert the resource ids of the resource-based robot XML configurations.
static void	setXmlResourceTemplateIdSupplier(Supplier<java.util.Collection<java.lang.Integer>> supplier)
static java.io.File	stripFileNameExtension(java.io.File path)
static java.lang.String	stripFileNameExtension(java.lang.String fileName)
java.lang.String	toXml(java.util.Map<SerialNumber,ControllerConfiguration> deviceControllers) Calls the writer to write the current list of devices out to a XML string.
java.lang.String	toXml(RobotConfigMap robotConfigMap)
void	updateActiveConfigHeader(RobotConfigFile robotConfigFile)
void	updateActiveConfigHeader(java.lang.String fileNameIn, boolean dirty)
static java.lang.String	withExtension(java.lang.String fileName)
void	writeToFile(RobotConfigFile cfgFile, boolean runningOnDriverStation, java.lang.String data)

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

DEBUG

public static final boolean DEBUG

See Also:

Constant Field Values

ROBOT_CONFIG_DESCRIPTION_GENERATE_XSLT

public static final java.lang.String ROBOT_CONFIG_DESCRIPTION_GENERATE_XSLT

See Also:

Constant Field Values

ROBOT_CONFIG_TAXONOMY_XML

public static final java.lang.String ROBOT_CONFIG_TAXONOMY_XML

See Also:

Constant Field Values

FILE_LIST_COMMAND_DELIMITER

public static final java.lang.String FILE_LIST_COMMAND_DELIMITER

See Also:

Constant Field Values

FILE_EXT

public static final java.lang.String FILE_EXT

See Also:

Constant Field Values

noConfig

public final java.lang.String noConfig

Constructor Detail

RobotConfigFileManager

public RobotConfigFileManager(Activity activity)

RobotConfigFileManager

public RobotConfigFileManager()

Method Detail

createConfigFolder

public void createConfigFolder()

Builds the Folder on the sdcard that holds all of the configuration files if it doesn't exist. If this fails, a toast will pop up.

getRobotConfigTypeAttribute

public static java.lang.String getRobotConfigTypeAttribute()

Returns the value of the Robot@type attribute of the XML resources that we are interested in

getRobotConfigTemplateAttribute

public static java.lang.String getRobotConfigTemplateAttribute()

setXmlResourceIdSupplier

public static void setXmlResourceIdSupplier(Supplier<java.util.Collection<java.lang.Integer>> supplier)

Sets the collection into which our class filter will insert the resource ids of the resource-based robot XML configurations.

See Also:

RobotConfigResFilter

setXmlResourceTemplateIdSupplier

public static void setXmlResourceTemplateIdSupplier(Supplier<java.util.Collection<java.lang.Integer>> supplier)

getConfigFromString

public RobotConfigFile getConfigFromString(java.lang.String objSerialized)

getActiveConfigAndUpdateUI

public RobotConfigFile getActiveConfigAndUpdateUI()

getActiveConfig

public RobotConfigFile getActiveConfig()

sendActiveConfigToDriverStation

public void sendActiveConfigToDriverStation()

setActiveConfigAndUpdateUI

public void setActiveConfigAndUpdateUI(boolean runningOnDriverStation,
                                       RobotConfigFile configFile)

setActiveConfigAndUpdateUI

public void setActiveConfigAndUpdateUI(RobotConfigFile config)

setActiveConfig

public void setActiveConfig(boolean runningOnDriverStation,
                            RobotConfigFile config)

setActiveConfig

public void setActiveConfig(RobotConfigFile cfgFile)

sendRobotControllerActiveConfigAndUpdateUI

public void sendRobotControllerActiveConfigAndUpdateUI(RobotConfigFile config)

updateActiveConfigHeader

public void updateActiveConfigHeader(RobotConfigFile robotConfigFile)

updateActiveConfigHeader

public void updateActiveConfigHeader(java.lang.String fileNameIn,
                                     boolean dirty)

changeHeaderBackground

public void changeHeaderBackground(int idColorHolder)

isPlausibleConfigName

public RobotConfigFileManager.ConfigNameCheckResult isPlausibleConfigName(RobotConfigFile existingConfig,
                                                                          java.lang.String candidate,
                                                                          java.util.List<RobotConfigFile> extantConfigurations)

Answers as to whether the candidate config name is a plausible one to use as the name of a new robot configuration.

Parameters:

candidate - the new name to test

extantConfigurations - the list of the currently existing robot configurations

Returns:

whether the candidate config name is a plausible one

stripFileNameExtension

public static java.lang.String stripFileNameExtension(java.lang.String fileName)

stripFileNameExtension

public static java.io.File stripFileNameExtension(java.io.File path)

withExtension

public static java.lang.String withExtension(java.lang.String fileName)

getFullPath

public static java.io.File getFullPath(java.lang.String fileNameWithoutExtension)

getXMLFiles

public java.util.ArrayList<RobotConfigFile> getXMLFiles()

Gets the list of files from the Configuration File directory, and populates the global list used by the fileSpinner. Note that this should only ever be executed on the robot controller, not the driver station, as the robot controller is the authoritative source of configurations.

getXMLTemplates

public java.util.ArrayList<RobotConfigFile> getXMLTemplates()

getRobotConfigDescription

public java.lang.String getRobotConfigDescription(XmlPullParser xpp)

Returns a high-level human-readable description of an XML robot configuration or configuration template.

getRobotConfigDescriptionTransform

protected javax.xml.transform.Source getRobotConfigDescriptionTransform()
                                                                 throws XmlPullParserException,
                                                                        java.io.IOException,
                                                                        javax.xml.transform.TransformerConfigurationException,
                                                                        javax.xml.transform.TransformerException

Returns a Source to the XSLT transformation that will transform robot config templates/configurations into human-readable descriptions.

Throws:

XmlPullParserException

java.io.IOException

javax.xml.transform.TransformerConfigurationException

javax.xml.transform.TransformerException

addChild

protected void addChild(org.w3c.dom.Document document,
                        org.w3c.dom.Element parent,
                        java.lang.String tag,
                        java.lang.String contents)

getSourceFromPullParser

protected javax.xml.transform.Source getSourceFromPullParser(XmlPullParser xpp)
                                                      throws XmlPullParserException,
                                                             java.io.IOException

Throws:

XmlPullParserException

java.io.IOException

serializeXMLConfigList

public static java.lang.String serializeXMLConfigList(java.util.List<RobotConfigFile> configList)

serializeConfig

public static java.lang.String serializeConfig(RobotConfigFile configFile)

deserializeXMLConfigList

public static java.util.List<RobotConfigFile> deserializeXMLConfigList(java.lang.String objsSerialized)

deserializeConfig

public static RobotConfigFile deserializeConfig(java.lang.String serialized)

toXml

public java.lang.String toXml(java.util.Map<SerialNumber,ControllerConfiguration> deviceControllers)

Calls the writer to write the current list of devices out to a XML string. Checks for duplicate names, and will throw an error if any are found. In that case, a helpful complainToast pops up with the duplicate names, and the file is not saved or written.

Returns:

the XML string. This will be non-null if toXml happened successfully, null otherwise

toXml

public java.lang.String toXml(RobotConfigMap robotConfigMap)

writeToFile

public void writeToFile(RobotConfigFile cfgFile,
                        boolean runningOnDriverStation,
                        java.lang.String data)
                 throws RobotCoreException,
                        java.io.IOException

Throws:

RobotCoreException

java.io.IOException