FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoDataValue Class Reference

#include <DataValue.h>

Inherits FdoLiteralValue.

Inherited by FdoBooleanValue, FdoByteValue, FdoDateTimeValue, FdoDecimalValue, FdoDoubleValue, FdoInt16Value, FdoInt32Value, FdoInt64Value, FdoLOBValue, FdoSingleValue, and FdoStringValue.

Inheritance diagram for FdoDataValue:

[legend]
List of all members.

Detailed Description

The FdoDataValue class derives from FdoLiteralValue and represents a literal value such as a string or a number.

Definition at line 33 of file DataValue.h.


Public Member Functions

virtual FDO_API FdoDataType GetDataType ()=0
 Gets the data type of the FdoDataValue.
FdoStringGetXmlValue ()
virtual FDO_API bool IsNull ()
 Returns true if the FdoDataValue represents a null value.
virtual FDO_API void SetNull ()
 Sets the FdoDataValue to a null value of the specified type.

Static Public Member Functions

FdoDataValueCreate (FdoString *value, FdoDataType dataType)
FDO_API FdoDataValueCreate (FdoByteArray *value, FdoDataType dataType)
 Constructs an instance of an FdoBLOBValue or FdoCLOBValue using the specified arguments.
FDO_API FdoDataValueCreate (FdoByte *value, FdoInt32 length, FdoDataType dataType)
 Constructs an instance of an FdoBLOBValue or FdoCLOBValue using the specified arguments.
FDO_API FdoDataValueCreate (FdoString *value)
 Constructs an instance of an FdoStringValue using the specified argument.
FDO_API FdoDataValueCreate (float value)
 Constructs an instance of an FdoSingleValue using the specified argument.
FDO_API FdoDataValueCreate (FdoInt64 value)
 Constructs an instance of an FdoInt64Value using the specified argument.
FDO_API FdoDataValueCreate (FdoInt32 value)
 Constructs an instance of an FdoInt32Value using the specified argument.
FDO_API FdoDataValueCreate (FdoInt16 value)
 Constructs an instance of an FdoInt16Value using the specified argument.
FDO_API FdoDataValueCreate (double value, FdoDataType dataType)
 Constructs an instance of an FdoDecimalValue or FdoDoubleValue using the specified arguments.
FDO_API FdoDataValueCreate (FdoDateTime value)
 Constructs an instance of an FdoDateTimeValue using the specified argument.
FDO_API FdoDataValueCreate (FdoByte value)
 Constructs an instance of an FdoByteValue using the specified argument.
FDO_API FdoDataValueCreate (bool value)
 Constructs an instance of an FdoBooleanValue using the specified argument.
FDO_API FdoDataValueCreate (FdoDataType dataType)
 Constructs an instance of a null FdoDataValue using the specified arguments.

Protected Member Functions

 FdoDataValue ()
 DOXYGEN-IGNORE Constructs a default instance of an FdoDataValue with data type string and a value of null.

Protected Attributes

bool m_isNull
 DOXYGEN-IGNORE
FdoStringP m_XmlValue

Constructor & Destructor Documentation

FdoDataValue::FdoDataValue  )  [protected]
 

DOXYGEN-IGNORE Constructs a default instance of an FdoDataValue with data type string and a value of null.

Returns:
Returns nothing

Member Function Documentation

FdoDataValue* FdoDataValue::Create FdoString value,
FdoDataType  dataType
[static]
 

FDO_API FdoDataValue* FdoDataValue::Create FdoByteArray value,
FdoDataType  dataType
[static]
 

Constructs an instance of an FdoBLOBValue or FdoCLOBValue using the specified arguments.

Parameters:
value Input a byte array
dataType Input the type of value to create
Returns:
Returns an FdoBLOBValue or an FdoCLOBValue

FDO_API FdoDataValue* FdoDataValue::Create FdoByte value,
FdoInt32  length,
FdoDataType  dataType
[static]
 

Constructs an instance of an FdoBLOBValue or FdoCLOBValue using the specified arguments.

Parameters:
value Input a byte array
length Input the length of the byte array
dataType Input the type of value to create
Returns:
Returns an FdoBLOBValue or an FdoCLOBValue

FDO_API FdoDataValue* FdoDataValue::Create FdoString value  )  [static]
 

Constructs an instance of an FdoStringValue using the specified argument.

Parameters:
value Input a character string
Returns:
Returns an FdoStringValue

Reimplemented in FdoStringValue.

FDO_API FdoDataValue* FdoDataValue::Create float  value  )  [static]
 

Constructs an instance of an FdoSingleValue using the specified argument.

Parameters:
value Input a single precision floating point value
Returns:
Returns an FdoSingleValue

Reimplemented in FdoSingleValue.

FDO_API FdoDataValue* FdoDataValue::Create FdoInt64  value  )  [static]
 

Constructs an instance of an FdoInt64Value using the specified argument.

Parameters:
value Input a 64 bit integer
Returns:
Returns an FdoInt64Value

Reimplemented in FdoInt64Value.

FDO_API FdoDataValue* FdoDataValue::Create FdoInt32  value  )  [static]
 

Constructs an instance of an FdoInt32Value using the specified argument.

Parameters:
value Input a 32 bit integer
Returns:
Returns an FdoInt32Value

Reimplemented in FdoInt32Value.

FDO_API FdoDataValue* FdoDataValue::Create FdoInt16  value  )  [static]
 

Constructs an instance of an FdoInt16Value using the specified argument.

Parameters:
value Input a 16 bit integer
Returns:
Returns an FdoInt16Value

Reimplemented in FdoInt16Value.

FDO_API FdoDataValue* FdoDataValue::Create double  value,
FdoDataType  dataType
[static]
 

Constructs an instance of an FdoDecimalValue or FdoDoubleValue using the specified arguments.

Parameters:
value Input a double
dataType Input a data type
Returns:
Returns an FdoDecimalValue or FdoDoubleValue

FDO_API FdoDataValue* FdoDataValue::Create FdoDateTime  value  )  [static]
 

Constructs an instance of an FdoDateTimeValue using the specified argument.

Parameters:
value Input a FdoDateTime
Returns:
Returns an FdoDateTimeValue

Reimplemented in FdoDateTimeValue.

FDO_API FdoDataValue* FdoDataValue::Create FdoByte  value  )  [static]
 

Constructs an instance of an FdoByteValue using the specified argument.

Parameters:
value Input a byte
Returns:
Returns an FdoByteValue

Reimplemented in FdoByteValue.

FDO_API FdoDataValue* FdoDataValue::Create bool  value  )  [static]
 

Constructs an instance of an FdoBooleanValue using the specified argument.

Parameters:
value Input a Boolean value
Returns:
Returns an FdoBooleanValue

Reimplemented in FdoBooleanValue.

FDO_API FdoDataValue* FdoDataValue::Create FdoDataType  dataType  )  [static]
 

Constructs an instance of a null FdoDataValue using the specified arguments.

Parameters:
dataType Input data type
Returns:
Returns nothing

virtual FDO_API FdoDataType FdoDataValue::GetDataType  )  [pure virtual]
 

Gets the data type of the FdoDataValue.

Returns:
Returns an FdoDataType

Implemented in FdoBLOBValue, FdoBooleanValue, FdoByteValue, FdoCLOBValue, FdoDateTimeValue, FdoDecimalValue, FdoDoubleValue, FdoInt16Value, FdoInt32Value, FdoInt64Value, FdoLOBValue, FdoSingleValue, and FdoStringValue.

FdoString* FdoDataValue::GetXmlValue  ) 
 

virtual FDO_API bool FdoDataValue::IsNull  )  [virtual]
 

Returns true if the FdoDataValue represents a null value.

Returns:
Returns true if the FdoDataValue represents a null value

virtual FDO_API void FdoDataValue::SetNull  )  [virtual]
 

Sets the FdoDataValue to a null value of the specified type.

Returns:
Returns nothing

Reimplemented in FdoBLOBValue, FdoCLOBValue, FdoLOBValue, and FdoStringValue.


Member Data Documentation

bool FdoDataValue::m_isNull [protected]
 

DOXYGEN-IGNORE

Definition at line 220 of file DataValue.h.

FdoStringP FdoDataValue::m_XmlValue [protected]
 

Definition at line 221 of file DataValue.h.


The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.