Qore DataProvider Module Reference 2.7.5
|
describes a data type based on softstring with a target encoding More...
#include <QoreSoftStringDataType.qc.dox.h>
Public Member Methods | |
constructor (*hash< auto > options, *hash< auto > tags) | |
creates the object | |
Public Member Methods inherited from DataProvider::QoreStringDataTypeBase | |
auto | acceptsValue (auto value) |
returns the value if the value can be assigned to the type More... | |
constructor (Type type, *hash< auto > options, *hash< auto > tags) | |
creates the object with the given options More... | |
AbstractDataProviderType | getSoftType () |
returns a "soft" type equivalent to the current type More... | |
*hash< string, hash< DataProviderTypeOptionInfo > > | getSupportedOptions () |
returns supported options | |
Public Member Methods inherited from DataProvider::QoreDataType | |
auto | acceptsValue (auto value) |
returns the value if the value can be assigned to the type More... | |
constructor (Type type, *hash< auto > options, *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. | |
*hash< string, bool > | getDirectTypeHash () |
returns a hash of native base type code where no translations are performed; keys are type codes, not names | |
*AbstractDataProviderType | getElementType () |
returns the subtype (for lists or hashes) if there is only one | |
*hash< string, AbstractDataField > | getFields () |
returns the fields of the data structure; if any | |
hash< DataTypeInfo > | getInfo () |
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... | |
*hash< string, hash< DataProviderTypeOptionInfo > > | getSupportedOptions () |
returns supported options | |
*Type | getValueType () |
returns the base type for the type, if any | |
Public Member Methods inherited from DataProvider::AbstractDataProviderType | |
abstract auto | acceptsValue (auto value) |
Returns the value if the value can be assigned to the type. More... | |
constructor () | |
creates the type | |
constructor (hash< auto > options, *hash< auto > tags) | |
creates the type and sets options More... | |
abstract hash< string, bool > | getAcceptTypeHash () |
Returns a hash of types accepted by this type; keys are type names. | |
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. | |
*hash< string, bool > | getDirectTypeHash () |
Returns a hash of native base type code keys where no translations are performed; keys are type codes, not names. | |
abstract *AbstractDataProviderType | getElementType () |
Returns the subtype (for lists or hashes) if there is only one. | |
*AbstractDataField | getField (string field_name) |
Returns the given field, if present, or NOTHING if not. | |
*hash< string, hash< DataFieldInfo > > | getFieldInfo () |
Returns information on fields supported. | |
abstract *hash< string, AbstractDataField > | getFields () |
Returns the fields of the data structure; if any. | |
*AbstractDataProviderType | getFieldType (string field_name) |
get the given field type if it exists, otherwise return NOTHING | |
hash< DataTypeInfo > | getInfo () |
Returns a description of the type as a hash. | |
hash< DataTypeInfo > | getInputInfo () |
Returns a description of the type as an input type. More... | |
abstract string | getName () |
Returns the type name. | |
*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... | |
abstract hash< string, bool > | getReturnTypeHash () |
Returns a hash of types returned by this type; keys are type names. | |
AbstractDataProviderType | getSoftType () |
Returns a "soft" type equivalent to the current type. More... | |
*hash< string, hash< DataProviderTypeOptionInfo > > | getSupportedOptions () |
Returns supported options. | |
auto | getTag (string tag) |
Returns the value of the given tag. | |
*hash< auto > | getTags () |
Returns tags set on the type. | |
abstract *Type | getValueType () |
Returns the base type for the type, if any. | |
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 Methods inherited from DataProvider::AbstractDataProviderType | |
static AbstractDataProviderType | get (string typename, *hash< auto > options) |
Returns an appropriate object for the given type. More... | |
static AbstractDataProviderType | get (Type type, *hash< auto > options, *hash< auto > tags) |
Returns an appropriate object for the given type. | |
Public Attributes inherited from DataProvider::AbstractDataProviderType | |
const | DefaultDesc = "no description available" |
Default description. | |
Private Member Methods inherited from DataProvider::QoreStringDataTypeBase | |
setOptionInternal (string opt, auto value) | |
sets the given option without any validation of the option | |
Private Member Methods inherited from DataProvider::AbstractDataProviderType | |
setOptionIntern (string opt, auto value) | |
sets the given option without any validation of the option | |
Private Attributes inherited from DataProvider::QoreStringDataTypeBase | |
const | SupportedOptions |
supported options | |
const | SupportedOrNothingOptions |
supported "or nothing" options | |
Private Attributes inherited from DataProvider::QoreDataType | |
*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 | |
*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 | |
Private Attributes inherited from DataProvider::AbstractDataProviderType | |
hash< auto > | options |
type options | |
*hash< auto > | tags |
type tags | |
describes a data type based on softstring with a target encoding