gr.uoa.di.madgik.execution.datatype

Class DataTypeString

java.lang.Object

gr.uoa.di.madgik.execution.datatype.DataTypeString

All Implemented Interfaces:

IDataType, Serializable

public class DataTypeString
extends Object
implements IDataType

This class represents data type with a string payload

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface gr.uoa.di.madgik.execution.datatype.IDataType

IDataType.DataTypes

Constructor Summary

Constructors

Constructor and Description
DataTypeString()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	CanSuggestDataTypeClass() Always returns true
void	FromXML(Element XML) Parses the xml serialization of the data type as retrieved by IDataType.ToXML()
void	FromXML(String XML) Parses the xml serialization of the data type as retrieved by IDataType.ToXML()
Class<?>	GetDataTypeClass() Returns Object.getClass()
IDataType.DataTypes	GetDataTypeEnum() Returns IDataType.DataTypes.String
String	GetStringValue() Returns a new instance of the string payload or an empty string if the value is null
Object	GetValue() Returns the actual payload
void	SetStringValue(String val) If the supplied value is null or an empty string, null is set as the payload.
void	SetValue(Object Value) Sets the provided payload using DataTypeUtils.GetValueAsString(Object)
String	ToXML() The payload of the data type is stored within a CDATA element

Methods inherited from class java.lang.Object

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

Constructor Detail

DataTypeString

public DataTypeString()

Method Detail

CanSuggestDataTypeClass

public boolean CanSuggestDataTypeClass()

Always returns true

Specified by:

CanSuggestDataTypeClass in interface IDataType

Returns:

true, if it can

See Also:

IDataType.CanSuggestDataTypeClass()

GetDataTypeClass

public Class<?> GetDataTypeClass()

Returns Object.getClass()

Specified by:

GetDataTypeClass in interface IDataType

Returns:

the run time type

See Also:

IDataType.GetDataTypeClass()

GetDataTypeEnum

public IDataType.DataTypes GetDataTypeEnum()

Returns IDataType.DataTypes.String

Specified by:

GetDataTypeEnum in interface IDataType

Returns:

the data type

See Also:

IDataType.GetDataTypeEnum()

GetStringValue

public String GetStringValue()
                      throws ExecutionSerializationException

Returns a new instance of the string payload or an empty string if the value is null

Specified by:

GetStringValue in interface IDataType

Returns:

the string representation of the value

Throws:

ExecutionSerializationException - A serialization error occurred

See Also:

IDataType.GetStringValue()

GetValue

public Object GetValue()

Returns the actual payload

Specified by:

GetValue in interface IDataType

Returns:

the value

See Also:

IDataType.GetValue()

SetStringValue

public void SetStringValue(String val)
                    throws ExecutionValidationException,
                           ExecutionSerializationException

If the supplied value is null or an empty string, null is set as the payload. Otherwise the value provided is set

Specified by:

SetStringValue in interface IDataType

Parameters:

val - the value to set

Throws:

ExecutionValidationException - A validation error occurred

ExecutionSerializationException - A serialization error occurred

See Also:

IDataType.SetStringValue(java.lang.String)

SetValue

public void SetValue(Object Value)
              throws ExecutionValidationException

Sets the provided payload using DataTypeUtils.GetValueAsString(Object)

Specified by:

SetValue in interface IDataType

Parameters:

Value - the value to set

Throws:

ExecutionValidationException - A validation error occurred

See Also:

IDataType.SetValue(java.lang.Object)

FromXML

public void FromXML(String XML)
             throws ExecutionSerializationException

Description copied from interface: IDataType

Parses the xml serialization of the data type as retrieved by IDataType.ToXML()

Specified by:

FromXML in interface IDataType

Parameters:

XML - the XML serialization

Throws:

ExecutionSerializationException - A serialization error occurred

FromXML

public void FromXML(Element XML)
             throws ExecutionSerializationException

Description copied from interface: IDataType

Parses the xml serialization of the data type as retrieved by IDataType.ToXML()

Specified by:

FromXML in interface IDataType

Parameters:

XML - The root element of the serialization

Throws:

ExecutionSerializationException - A validation error occurred

ToXML

public String ToXML()
             throws ExecutionSerializationException

The payload of the data type is stored within a CDATA element

Specified by:

ToXML in interface IDataType

Returns:

the XML serialization

Throws:

ExecutionSerializationException - a serialization error occurred

See Also:

IDataType.ToXML()