at.mug.iqm.templatemanager

Class XMLPreferencesManager

java.lang.Object

at.mug.iqm.templatemanager.XMLPreferencesManager

public final class XMLPreferencesManager
extends Object

This class is used to load and set GUI preferences and IQM-parameter-blocks.

Version:

0.0.2

Author:

Philipp W. , Philipp Kainz

Field Summary

Fields

Modifier and Type	Field and Description
private static XMLPreferencesManager	currentPrefManager
private String	fileName
private static org.apache.log4j.Logger	logger
private Marshaller	marshaller
private String	pathName
private IqmOperatorTemplates	propertyXML
private Unmarshaller	unmarshaller

Constructor Summary

Constructors

Constructor and Description
XMLPreferencesManager(String pathName) Constructs a new JAIXMLParameterBlocks and a new IQMOperatorTemplates.xml if necessary.

Method Summary

Modifier and Type	Method and Description
void	deleteTemplateByName(String parameterblockname, String templatename) Deletes a template from IQMOperatorTemplates.xml.
static XMLPreferencesManager	getInstance()
IqmOperatorTemplates.ParameterBlock	getParameterBlockByName(String parameterblockname) Returns a List of JaiOperationDescriptor-template from the XML by the given name.
ParameterBlockIQM	getTemplate(String operatorName, String templateName) De-serializes an operator's parameter block into a Java object.
IqmOperatorDescriptor	getTemplateByName(String parameterblockname, String templatename) Returns a JaiOperationDescriptor from the XML by the given name.
private IqmOperatorTemplates	getXMLDoc() Returns an object of the DOM-representation of the XML-file currently written.
ParameterBlockIQM	loadParameterBlockFromTemplate(ParameterBlockIQM block, IqmOperatorDescriptor template) Changes values in a ParameterBlockIQM to the settings in the IQMOperatorTemplates.xml.
void	readXML(File xmlFile) Reads the specified XML-file.
void	setTemplate(String parameterblockname, String templatename, ParameterBlockIQM block) Sets a new template in IQMOperatorTemplates.xml with the values of a ParameterBlockIQM. Currently supported parameter-types: Integer, Boolean, Character, Double, Float. This function is synchronized.
private void	validate() Validates the preferences file against a defined schema.
void	writeXML() Writes the IQMOperatorTemplates.xml to the "IQM"-user-folder of the application.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.apache.log4j.Logger logger

marshaller

private Marshaller marshaller

unmarshaller

private Unmarshaller unmarshaller

propertyXML

private IqmOperatorTemplates propertyXML

currentPrefManager

private static XMLPreferencesManager currentPrefManager

pathName

private String pathName

fileName

private String fileName

Constructor Detail

XMLPreferencesManager

public XMLPreferencesManager(String pathName)

Constructs a new JAIXMLParameterBlocks and a new IQMOperatorTemplates.xml if necessary.

Method Detail

getXMLDoc

private IqmOperatorTemplates getXMLDoc()

Returns an object of the DOM-representation of the XML-file currently written. It it called by the constructor.

Returns:

Object representing the XML.

writeXML

public void writeXML()

Writes the IQMOperatorTemplates.xml to the "IQM"-user-folder of the application. This function is synchronized.

readXML

public void readXML(File xmlFile)
             throws JAXBException,
                    NullPointerException

Reads the specified XML-file. This function is synchronized.

Parameters:

xmlFile - XML-file to read in.

Throws:

JAXBException

NullPointerException

validate

private void validate()

Validates the preferences file against a defined schema.

getParameterBlockByName

public IqmOperatorTemplates.ParameterBlock getParameterBlockByName(String parameterblockname)

Returns a List of JaiOperationDescriptor-template from the XML by the given name.

Parameters:

parameterblockname - ParameterBlock-name (GUI-name) to find in the IQMOperatorTemplates.xml

Returns:

List or NULL if no element was found.

getTemplateByName

public IqmOperatorDescriptor getTemplateByName(String parameterblockname,
                                               String templatename)

Returns a JaiOperationDescriptor from the XML by the given name.

Parameters:

parameterblockname - ParameterBlock-name (GUI-name) to find in the IQMOperatorTemplates.xml

templatename - Template-name to find in the IQMOperatorTemplates.xml

Returns:

jaixml.JaiOperationDescriptor or NULL if no element was found.

getTemplate

public ParameterBlockIQM getTemplate(String operatorName,
                                     String templateName)

De-serializes an operator's parameter block into a Java object. This method

Parameters:

operatorName - the unique name of the operator

templateName - the unique name of the template for an operator

Returns:

the ParameterBlockIQM object

deleteTemplateByName

public void deleteTemplateByName(String parameterblockname,
                                 String templatename)

Deletes a template from IQMOperatorTemplates.xml.

Parameters:

parameterblockname - ParameterBlock-name (GUI-name) of the template to be deleted.

templatename - Template-name to be deleted.

loadParameterBlockFromTemplate

public ParameterBlockIQM loadParameterBlockFromTemplate(ParameterBlockIQM block,
                                                        IqmOperatorDescriptor template)
                                                 throws Exception

Changes values in a ParameterBlockIQM to the settings in the IQMOperatorTemplates.xml.
Currently supported parameter-types: Integer, Boolean, Character, Double, Float.

Parameters:

block - ParameterBlockIQM used as basis for the setting (Use the hard-coded default ParameterBlock if unsure).

template - JaiOperationDescriptor template to fit into the ParameterBlockIQM.

Returns:

ParameterBlockIQM with the changes from the IQMOperatorTemplates.xml.

Throws:

Exception

See Also:

For a convenient way to get the correct {@link IOperatorDescriptor} for parameter template.

setTemplate

public void setTemplate(String parameterblockname,
                        String templatename,
                        ParameterBlockIQM block)

Sets a new template in IQMOperatorTemplates.xml with the values of a ParameterBlockIQM.
Currently supported parameter-types: Integer, Boolean, Character, Double, Float.
This function is synchronized.

Parameters:

parameterblockname - operator name of the new entry to IQMOperatorTemplates.xml.

templatename - Template-name of the new entry to IQMOperatorTemplates.xml.

block - Values of this ParameterBlockIQM are saved to IQMOperatorTemplates.xml.

getInstance

public static XMLPreferencesManager getInstance()