gr.uoa.di.madgik.commons.configuration.parameter
Interface IParameter

All Known Implementing Classes:
BooleanClassParameter, BooleanPrimitiveParameter, ByteClassParameter, BytePrimitiveParameter, DoubleClassParameter, DoublePrimitiveParameter, FloatClassParameter, FloatPrimitiveParameter, IntegerClassParameter, IntegerPrimitiveParameter, LongClassParameter, LongPrimitiveParameter, ObjectParameter, ShortClassParameter, ShortPrimitiveParameter, StringParameter, XMLParameter

public interface IParameter

All elements that can be defined and retrieved ffrom the ConfigurationManager are parameters. All these parameters have to implement this interface.

Author:
gpapanikos

Nested Class Summary
static class IParameter.ParameterType
          The type of parameters tat can be declared and instnatiated.
 
Method Summary
 void Check()
          Sets that the parameter has been evaluated during the DependencyGraph.ResolveDependencies() process
 void FromXML(org.w3c.dom.Element element)
          Parses the provided xml subtree and populates the parameter instnace
 void FromXML(java.lang.String xml)
          Parses the provided xml subtree and populates the parameter instnace
 java.lang.String GetName()
          Retrieves the name of the parameter
 java.lang.Class<?> GetParameterClassType()
          Retireves the class type of the value the parameter stored
 IParameter.ParameterType GetParameterType()
          Retrieves the IParameter the implementing instnace represents
 java.lang.Object GetValue()
          Retrieves the value of the parameter
 java.lang.Boolean IsChecked()
          Retrieves whether or not the parameter has been evaluated during the DependencyGraph.ResolveDependencies() process
 java.lang.Boolean IsGenerated()
          Retrieves whether or not the parameter is generated or a specific value of generation description is available in the same decleration
 java.lang.Boolean IsInternal()
          Retrieves whether or not the parameter is internal and is only used as an intermediate step during the initialization of an other parameter or it can also be accessed by external clients
 void SetValue(java.lang.Object Value)
          Sets the value of the parameter
 

Method Detail

GetParameterType

IParameter.ParameterType GetParameterType()
Retrieves the IParameter the implementing instnace represents

Returns:
the parameter type

GetName

java.lang.String GetName()
Retrieves the name of the parameter

Returns:
the parameter name

IsGenerated

java.lang.Boolean IsGenerated()
Retrieves whether or not the parameter is generated or a specific value of generation description is available in the same decleration

Returns:
whether or not the parameter is generated

IsInternal

java.lang.Boolean IsInternal()
Retrieves whether or not the parameter is internal and is only used as an intermediate step during the initialization of an other parameter or it can also be accessed by external clients

Returns:
wheter or not the parameter is generated

IsChecked

java.lang.Boolean IsChecked()
Retrieves whether or not the parameter has been evaluated during the DependencyGraph.ResolveDependencies() process

Returns:
whether or not the parameter has been evaluated

Check

void Check()
Sets that the parameter has been evaluated during the DependencyGraph.ResolveDependencies() process


GetValue

java.lang.Object GetValue()
Retrieves the value of the parameter

Returns:
the value

SetValue

void SetValue(java.lang.Object Value)
              throws java.lang.Exception
Sets the value of the parameter

Parameters:
Value - the value
Throws:
java.lang.Exception - the value is not of correct type for the parameter instnace

GetParameterClassType

java.lang.Class<?> GetParameterClassType()
Retireves the class type of the value the parameter stored

Returns:
the class

FromXML

void FromXML(java.lang.String xml)
             throws java.lang.Exception
Parses the provided xml subtree and populates the parameter instnace

Parameters:
xml - the xml subtree
Throws:
java.lang.Exception - the parsing could be performed

FromXML

void FromXML(org.w3c.dom.Element element)
             throws java.lang.Exception
Parses the provided xml subtree and populates the parameter instnace

Parameters:
element - the xml subtree
Throws:
java.lang.Exception - the parsing could be performed