Package adams.data.conversion

Class DOMToProperties

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.conversion.AbstractConversion

adams.data.conversion.DOMToProperties

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, Serializable

public class DOMToProperties
extends AbstractConversion

Flattens a DOM object (or node) into a Properties object.

Valid options are:

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-path-separator <java.lang.String> (property: pathSeparator)
    The separator to use in the path.
    default: .
 

-add-index <boolean> (property: addIndex)
    If enabled, the index gets added to the path, to disambiguate.
    default: false
 

-store-attributes <boolean> (property: storeAttributes)
    If enabled, attribute values get stored as well.
    default: false
 

-skip-root <boolean> (property: skipRoot)
    If enabled, the root element name is excluded from the path.
    default: false
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_AddIndex	whether to add index to path.
protected String	m_PathSeparator	the path separator.
protected boolean	m_SkipRoot	whether to exclude the root element from the path.
protected boolean	m_StoreAttributes	whether to store attributes of elements as well.

Fields inherited from class adams.data.conversion.AbstractConversion

m_Input, m_Output, m_Owner, m_Stopped

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
DOMToProperties()

Method Summary

Modifier and Type	Method	Description
Class	accepts()	Returns the class that is accepted as input.
String	addIndexTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected Object	doConvert()	Performs the actual conversion.
Class	generates()	Returns the class that is generated as output.
boolean	getAddIndex()	Returns whether to add the index to the path to disambiguate values.
String	getPathSeparator()	Returns the separator in use.
boolean	getSkipRoot()	Returns whether to exclude the root element name from the path.
boolean	getStoreAttributes()	Returns whether to store the attributes as well.
String	globalInfo()	Returns a string describing the object.
String	pathSeparatorTipText()	Returns the tip text for this property.
void	setAddIndex(boolean value)	Sets whether to add the index to the path to disambiguate values.
void	setPathSeparator(String value)	Sets the separator in use.
void	setSkipRoot(boolean value)	Sets whether to exclude the root element name from the path.
void	setStoreAttributes(boolean value)	Sets whether to store the attributes as well.
String	skipRootTipText()	Returns the tip text for this property.
String	storeAttributesTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.conversion.AbstractConversion

checkData, cleanUp, convert, getAdditionalInformation, getInput, getInput, getOutput, getOutput, getOwner, getQuickInfo, reset, setInput, setOwner, shallowCopy, shallowCopy, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_PathSeparator

protected String m_PathSeparator

the path separator.

m_AddIndex

protected boolean m_AddIndex

whether to add index to path.

m_StoreAttributes

protected boolean m_StoreAttributes

whether to store attributes of elements as well.

m_SkipRoot

protected boolean m_SkipRoot

whether to exclude the root element from the path.

Constructor Detail

DOMToProperties

public DOMToProperties()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setPathSeparator

public void setPathSeparator(String value)

Sets the separator in use.

Parameters:

value - the separator

getPathSeparator

public String getPathSeparator()

Returns the separator in use.

Returns:

the separator

pathSeparatorTipText

public String pathSeparatorTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setAddIndex

public void setAddIndex(boolean value)

Sets whether to add the index to the path to disambiguate values.

Parameters:

value - true if to add index

getAddIndex

public boolean getAddIndex()

Returns whether to add the index to the path to disambiguate values.

Returns:

true if to add index

addIndexTipText

public String addIndexTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setStoreAttributes

public void setStoreAttributes(boolean value)

Sets whether to store the attributes as well.

Parameters:

value - true if to store attributes

getStoreAttributes

public boolean getStoreAttributes()

Returns whether to store the attributes as well.

Returns:

true if attributes are stored as well

storeAttributesTipText

public String storeAttributesTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setSkipRoot

public void setSkipRoot(boolean value)

Sets whether to exclude the root element name from the path.

Parameters:

value - true if to exclude the root

getSkipRoot

public boolean getSkipRoot()

Returns whether to exclude the root element name from the path.

Returns:

true if root excluded

skipRootTipText

public String skipRootTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

accepts

public Class accepts()

Returns the class that is accepted as input.

Specified by:

accepts in interface Conversion

Specified by:

accepts in class AbstractConversion

Returns:

the class

generates

public Class generates()

Returns the class that is generated as output.

Specified by:

generates in interface Conversion

Specified by:

generates in class AbstractConversion

Returns:

the class

doConvert

protected Object doConvert()
                    throws Exception

Performs the actual conversion.

Specified by:

doConvert in class AbstractConversion

Returns:

the converted data

Throws:

Exception - if something goes wrong with the conversion