core

Class AbstractComponent

java.lang.Object

core.AbstractComponent

Direct Known Subclasses:

AbstractMethod, AbstractProblem, AbstractRanking, AbstractRepresentation

public abstract class AbstractComponent
extends java.lang.Object

Abstract base superclass for all FREVO components. Each component is instantiated based on a source ComponentXMLData class. Furthermore, a map of properties are also always passed to each component.

Author:

Istvan Fehervari

Constructor Summary

Constructors

Constructor and Description
AbstractComponent()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Hashtable<java.lang.String,XMLFieldEntry>	getProperties() Returns the properties of this component loaded from the component source XML file.
java.lang.String	getPropertyValue(java.lang.String key) Returns the value assigned to the given property key.
XMLFieldType	getTypeOfProperty(java.lang.String key) Returns the type of the given property key.
ComponentXMLData	getXMLData() Returns the ComponentXMLdata object that was used to create this component instance.
void	setProperties(java.util.Hashtable<java.lang.String,XMLFieldEntry> properties) Sets the properties of this component to the given value.
void	setXMLData(ComponentXMLData data) Sets the source ComponentXMLdata object to the given value.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractComponent

public AbstractComponent()

Method Detail

getXMLData

public final ComponentXMLData getXMLData()

Returns the ComponentXMLdata object that was used to create this component instance.

Returns:

A reference to the source ComponentXMLdata object.

setXMLData

public final void setXMLData(ComponentXMLData data)

Sets the source ComponentXMLdata object to the given value.

Parameters:

data - The new ComponentXMLdata to be used.

setProperties

public final void setProperties(java.util.Hashtable<java.lang.String,XMLFieldEntry> properties)

Sets the properties of this component to the given value. The object will receive a clone (shallow copy) of the source map.

Parameters:

properties - The new map of property keys and values.

getProperties

public final java.util.Hashtable<java.lang.String,XMLFieldEntry> getProperties()

Returns the properties of this component loaded from the component source XML file.

Returns:

A reference to the properties map of this component.

getTypeOfProperty

public final XMLFieldType getTypeOfProperty(java.lang.String key)

Returns the type of the given property key.

Parameters:

key - The key whose assigned type is requested.

Returns:

the type of the requested property key.

Throws:

java.lang.IllegalArgumentException - if the given key is not found in the property map.

getPropertyValue

public final java.lang.String getPropertyValue(java.lang.String key)
                                        throws java.lang.IllegalArgumentException

Returns the value assigned to the given property key.

Parameters:

key - The key whose assigned value is requested.

Returns:

The value of the requested property key.

Throws:

java.lang.IllegalArgumentException - if the given key is not found in the property map.