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.
virtual FDO_API FdoLiteralValueType GetLiteralValueType () const
 Gets the literal value type of the FdoDataValue.
FdoString * GetXmlValue ()
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

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

Protected Member Functions

FdoCompareType Compare (FdoDataValue *other)
 DOXYGEN-IGNORE Compares this data value with another data value
virtual FdoCompareType DoCompare (FdoDataValue *other)
 Type-specific comparison function. Each sub-class has its own implementation.
 FdoDataValue ()
 Constructs a default instance of an FdoDataValue with data type string and a value of null.
FdoCompareType ReverseCompare (FdoDataValue *other)

Protected Attributes

bool m_isNull
FdoStringP m_XmlValue

Friends

class FdoByteValue
class FdoDecimalValue
class FdoDoubleValue
class FdoInt16Value
class FdoInt32Value
class FdoInt64Value
class FdoInternalDataValue
 DOXYGEN-IGNORE
class FdoSingleValue

Constructor & Destructor Documentation

FdoDataValue::FdoDataValue (   )  [protected]
 

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

Returns:
Returns nothing

Member Function Documentation

FdoCompareType FdoDataValue::Compare (  FdoDataValue *  other  )  [protected]
 

DOXYGEN-IGNORE Compares this data value with another data value

Parameters:
other Input the other data value
Returns:
Returns: FdoCompareType_Equal when this and the other value are equal or both null. FdoCompareType_Greater when this value is greater than the other value FdoCompareType_Less when this value is less than the other value FdoCompareType_Undefined when these two values cannot be compared. Cases where this happens are:
  • one value is null and the other is not null
  • the values have incompatible types (e.g. Int32 and DateTime).

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, FdoIntBinValue, and FdoIntHexValue.

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 FdoCompareType FdoDataValue::DoCompare (  FdoDataValue *  other  )  [protected, virtual]
 

Type-specific comparison function. Each sub-class has its own implementation.

Parameters:
other Input the other data value
Returns:
Returns: FdoCompareType_Equal when this and the other value are equal or both null. FdoCompareType_Greater when this value is greater than the other value FdoCompareType_Less when this value is less than the other value FdoCompareType_Undefined when these two values cannot be compared. Cases where this happens are:
  • one value is null and the other is not null
  • the values have incompatible types (e.g. Int32 and DateTime).
Base implementation always returns FdoCompareType_Undefined.

Reimplemented in FdoByteValue, FdoDateTimeValue, FdoDecimalValue, FdoDoubleValue, FdoInt16Value, FdoInt32Value, FdoInt64Value, FdoSingleValue, and FdoStringValue.

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.

virtual FDO_API FdoLiteralValueType FdoDataValue::GetLiteralValueType (   )  const [virtual]
 

Gets the literal value type of the FdoDataValue.

Returns:
Returns an FdoLiteralValueType

Implements FdoLiteralValue.

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

FdoCompareType FdoDataValue::ReverseCompare (  FdoDataValue *  other  )  [protected]
 

FdoCompareType_Greater when the other value is greater than this value FdoCompareType_Less when the other value is less than this 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.

Friends And Related Function Documentation

friend class FdoByteValue [friend]
 

Reimplemented in FdoDecimalValue, FdoDoubleValue, FdoInt16Value, FdoInt32Value, FdoInt64Value, FdoIntBinValue, FdoIntHexValue, and FdoSingleValue.

Definition at line 37 of file DataValue.h.

friend class FdoDecimalValue [friend]
 

Definition at line 38 of file DataValue.h.

friend class FdoDoubleValue [friend]
 

Definition at line 39 of file DataValue.h.

friend class FdoInt16Value [friend]
 

Reimplemented in FdoDecimalValue, FdoDoubleValue, FdoInt32Value, FdoInt64Value, FdoIntBinValue, FdoIntHexValue, and FdoSingleValue.

Definition at line 40 of file DataValue.h.

friend class FdoInt32Value [friend]
 

Reimplemented in FdoDecimalValue, FdoDoubleValue, FdoInt64Value, FdoIntBinValue, FdoIntHexValue, and FdoSingleValue.

Definition at line 41 of file DataValue.h.

friend class FdoInt64Value [friend]
 

Reimplemented in FdoDecimalValue, FdoDoubleValue, and FdoSingleValue.

Definition at line 42 of file DataValue.h.

friend class FdoInternalDataValue [friend]
 

DOXYGEN-IGNORE

Definition at line 36 of file DataValue.h.

friend class FdoSingleValue [friend]
 

Reimplemented in FdoDecimalValue, and FdoDoubleValue.

Definition at line 43 of file DataValue.h.

Member Data Documentation

bool FdoDataValue::m_isNull [protected]
 

Definition at line 281 of file DataValue.h.

FdoStringP FdoDataValue::m_XmlValue [protected]
 

Definition at line 282 of file DataValue.h.

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