Qore DataProvider Module Reference  2.5
DataProvider::QoreSoftBinaryDataType Class Reference

describes a data type based on softbinary with validation for parsing strings More...

Inheritance diagram for DataProvider::QoreSoftBinaryDataType:

Public Member Functions

 constructor (__7_ hash< auto > options, __7_ hash< auto > tags)
 creates the object
 
- Public Member Functions inherited from DataProvider::QoreBinaryDataTypeBase
auto acceptsValue (auto value)
 returns the value if the value can be assigned to the type More...
 
AbstractDataProviderType getSoftType ()
 returns a "soft" type equivalent to the current type More...
 
- Public Member Functions inherited from DataProvider::QoreDataType
auto acceptsValue (auto value)
 returns the value if the value can be assigned to the type More...
 
 constructor (Type type, __7_ hash< auto > options, __7_ hash< auto > tags)
 creates the type
 
hash< string, bool > getAcceptTypeHash ()
 returns a hash of base types accepted by this type; keys are type names
 
string getDesc ()
 Returns the description.
 
__7_ hash< string, bool > getDirectTypeHash ()
 returns a hash of native base type code where no translations are performed; keys are type codes, not names
 
__7_ AbstractDataProviderType getElementType ()
 returns the subtype (for lists or hashes) if there is only one
 
__7_ hash< string, AbstractDataFieldgetFields ()
 returns the fields of the data structure; if any
 
hash< DataTypeInfogetInfo ()
 returns a description of the type as a hash
 
string getName ()
 returns the type name
 
AbstractDataProviderType getOrNothingType ()
 returns an "or nothing" type equivalent to the current type More...
 
hash< string, bool > getReturnTypeHash ()
 returns a hash of base types returned by this type; keys are type names
 
AbstractDataProviderType getSoftType ()
 returns a "soft" type equivalent to the current type More...
 
__7_ hash< string, hash< DataProviderTypeOptionInfo > > getSupportedOptions ()
 returns supported options
 
__7_ Type getValueType ()
 returns the base type for the type, if any
 
- Public Member Functions inherited from DataProvider::AbstractDataProviderType
 constructor ()
 creates the type
 
 constructor (hash< auto > options, __7_ hash< auto > tags)
 creates the type and sets options More...
 
int getBaseTypeCode ()
 Returns the base type code for the type.
 
string getBaseTypeName ()
 Returns the base type name for the type; must be a standard Qore base type name.
 
string getDesc ()
 Returns the description.
 
__7_ hash< string, bool > getDirectTypeHash ()
 Returns a hash of native base type code keys where no translations are performed; keys are type codes, not names.
 
__7_ AbstractDataField getField (string field_name)
 Returns the given field, if present, or NOTHING if not.
 
__7_ hash< string, hash< DataFieldInfo > > getFieldInfo ()
 Returns information on fields supported.
 
__7_ AbstractDataProviderType getFieldType (string field_name)
 get the given field type if it exists, otherwise return NOTHING
 
hash< DataTypeInfogetInfo ()
 Returns a description of the type as a hash.
 
hash< DataTypeInfogetInputInfo ()
 Returns a description of the type as an input type. More...
 
__7_ hash< auto > getOptions ()
 Returns options set on the type.
 
auto getOptionValue (string opt)
 Returns the value of the given option.
 
AbstractDataProviderType getOrNothingType ()
 Returns an "or nothing" type equivalent to the current type. More...
 
AbstractDataProviderType getSoftType ()
 Returns a "soft" type equivalent to the current type. More...
 
__7_ hash< string, hash< DataProviderTypeOptionInfo > > getSupportedOptions ()
 Returns supported options.
 
auto getTag (string tag)
 Returns the value of the given tag.
 
__7_ hash< auto > getTags ()
 Returns tags set on the type.
 
bool hasType ()
 Returns True if the type is not a wildcard type.
 
bool isAssignableFrom (AbstractDataProviderType t)
 Returns True if this type can be assigned from values of the argument type.
 
bool isAssignableFrom (Type t)
 Returns True if this type can be assigned from values of the argument type.
 
bool isList ()
 Returns True if this type is a list.
 
bool isMandatory ()
 Returns True if the type must have a value.
 
bool isOrNothingType ()
 Returns True if the type also accepts NOTHING.
 
 setOption (string opt, auto value)
 sets the given option on the type More...
 
 setOptions (hash< auto > options)
 sets options on the type More...
 

Additional Inherited Members

- Static Public Member Functions inherited from DataProvider::AbstractDataProviderType
static AbstractDataProviderType get (string typename, __7_ hash< auto > options)
 Returns an appropriate object for the given type. More...
 
static AbstractDataProviderType get (Type type, __7_ hash< auto > options, __7_ hash< auto > tags)
 Returns an appropriate object for the given type.
 
- Public Attributes inherited from DataProvider::AbstractDataProviderType
const DefaultDesc = "no description available"
 Default description.
 
- Protected Member Functions inherited from DataProvider::QoreBinaryDataTypeBase
 constructor (Type type, __7_ hash< auto > options, __7_ hash< auto > tags)
 creates the object More...
 
- Protected Member Functions inherited from DataProvider::AbstractDataProviderType
 setOptionIntern (string opt, auto value)
 sets the given option without any validation of the option
 
- Protected Attributes inherited from DataProvider::QoreDataType
__7_ hash< string, bool > accept_type_hash
 hash of base types accepted by this type; keys are type names
 
hash< string, bool > base_type_hash
 hash of base types where no translations are performed; keys are type codes, not names More...
 
hash< string, bool > blacklist_type_hash
 hash of type codes accepted by the base type but not accepted by this type: code -> True
 
bool or_nothing_type
 flag for "or nothing" types
 
__7_ hash< string, bool > return_type_hash
 hash of base types returned by this type; keys are type names
 
bool soft_type
 flag for soft types
 
const SoftTypeMap
 map from normal types to soft types
 
const SupportedOptions
 supported options
 
Type type
 the Qore type
 
- Protected Attributes inherited from DataProvider::AbstractDataProviderType
hash< auto > options
 type options
 
__7_ hash< auto > tags
 type tags
 

Detailed Description

describes a data type based on softbinary with validation for parsing strings

Note
Qore "soft" types that do not accept NOTHING also accept NULL; to ensure that soft types inheriting this class do not accept NULL, use the qore.no_null option in the constructor