Qore jni Module  1.1.3
org.qore.lang.dataprovider.AbstractDataProviderType Class Reference

Java wrapper for the DataProvider::AbstractDataProviderType class in Qore. More...

Inheritance diagram for org.qore.lang.dataprovider.AbstractDataProviderType:
org.qore.jni.QoreObjectWrapper

Public Member Methods

 AbstractDataProviderType (QoreObject obj) throws Throwable
 creates the object as a wrapper for the Qore object
 
HashMap< String, HashMap< String, Object > > getSupportedOptions () throws Throwable
 returns supported options
 
HashMap< String, Object > getInputInfo () throws Throwable
 returns a description of the type as an input type More...
 
HashMap< String, Object > getInfo () throws Throwable
 returns a description of the type as a hash
 
HashMap< String, HashMap< String, Object > > getFieldInfo () throws Throwable
 Returns information on fields supported.
 
boolean isAssignableFrom (AbstractDataProviderType t) throws Throwable
 returns True if this type can be assigned from values of the argument type
 
boolean isAssignableFrom (Type t) throws Throwable
 returns True if this type can be assigned from values of the argument type
 
boolean isList () throws Throwable
 returns True if this type is a list
 
boolean isMandatory () throws Throwable
 returns True if the type must have a value
 
AbstractDataField getField (String field_name) throws Throwable
 returns the given field, if present, or nothing if not
 
boolean hasType () throws Throwable
 returns True if the type is not a wildcard type
 
String getBaseTypeName () throws Throwable
 returns the base type name for the type; must be a standard Qore base type name
 
int getBaseTypeCode () throws Throwable
 returns the base type code for the type
 
HashMap< String, Boolean > getDirectTypeHash () throws Throwable
 returns a hash of native base type code keys where no translations are performed; keys are type codes, not names
 
boolean isOrNothingType () throws Throwable
 returns True if the type also accepts nothing
 
AbstractDataProviderType getFieldType (String field_name) throws Throwable
 get the given field type if it exists, otherwise return nothing
 
Object getOptionValue (String opt) throws Throwable
 returns the value of the given option
 
HashMap< String, Object > getOptions () throws Throwable
 returns options set on the type
 
void setOption (String opt, Object value) throws Throwable
 sets the given option on the type More...
 
void setOptions (Map< String, Object > options) throws Throwable
 sets options on the type More...
 
AbstractDataProviderType getSoftType () throws Throwable
 returns a "soft" type equivalent to the current type More...
 
String getName () throws Throwable
 returns the type name
 
Type getValueType () throws Throwable
 returns the base type for the type, if any
 
AbstractDataProviderType getElementType () throws Throwable
 returns the subtype (for lists or hashes) if there is only one
 
HashMap< String, AbstractDataFieldgetFields () throws Throwable
 returns the fields of the data structure; if any
 
HashMap< String, Boolean > getAcceptTypeHash () throws Throwable
 returns a hash of types accepted by this type; keys are type names
 
HashMap< String, Boolean > getReturnTypeHash () throws Throwable
 returns a hash of types returned by this type; keys are type names
 
Object acceptsValue (Object value) throws Throwable
 returns the value if the value can be assigned to the type More...
 
- Public Member Methods inherited from org.qore.jni.QoreObjectWrapper
 QoreObjectWrapper (QoreObject obj)
 creates the wrapper object with the Qore object
 
void release ()
 releases the Qore object; do not call any further methods on the object after this call
 
QoreObject getQoreObject ()
 returns the Qore object
 
String className ()
 returns the class name for the Qore object
 
boolean instanceOf (String class_name)
 returns true if the object is an instance of the given class
 

Static Public Member Methods

static AbstractDataProviderType get (Type type, Map< String, Object > options) throws Throwable
 returns an appropriate object for the given type
 
static AbstractDataProviderType get (Type type) throws Throwable
 returns an appropriate object for the given type
 
static AbstractDataProviderType get (String typename, Map< String, Object > options) throws Throwable
 returns an appropriate object for the given type
 
static AbstractDataProviderType get (String typename) throws Throwable
 returns an appropriate object for the given type
 

Additional Inherited Members

- Private Attributes inherited from org.qore.jni.QoreObjectWrapper
QoreObject obj
 the wrapper Qore object
 

Detailed Description

Java wrapper for the DataProvider::AbstractDataProviderType class in Qore.

Note
Loads and initializes the Qore library and the jni module in static initialization if necessary

Member Function Documentation

◆ acceptsValue()

Object org.qore.lang.dataprovider.AbstractDataProviderType.acceptsValue ( Object  value) throws Throwable
inline

returns the value if the value can be assigned to the type

Parameters
valuethe value to assign to the type
Returns
the value to be assigned; can be converted by the type

◆ getInputInfo()

HashMap<String, Object> org.qore.lang.dataprovider.AbstractDataProviderType.getInputInfo ( ) throws Throwable
inline

returns a description of the type as an input type

Returns
a description of the type as an input type; only the following keys are returned
  • name
  • types_returned

◆ getSoftType()

AbstractDataProviderType org.qore.lang.dataprovider.AbstractDataProviderType.getSoftType ( ) throws Throwable
inline

returns a "soft" type equivalent to the current type

The base class method returns the same type; this method must be overridden in child classes to return a usable "soft" type

Returns
a "soft" type equivalent to the current type

◆ setOption()

void org.qore.lang.dataprovider.AbstractDataProviderType.setOption ( String  opt,
Object  value 
) throws Throwable
inline

sets the given option on the type

Parameters
optthe option to set
valuethe value to set
Exceptions
TYPE-OPTION-ERRORinvalid option or invalid option type

◆ setOptions()

void org.qore.lang.dataprovider.AbstractDataProviderType.setOptions ( Map< String, Object >  options) throws Throwable
inline

sets options on the type

Parameters
optionsthe options to set; unsupported options are ignored
Exceptions
TYPE-OPTION-ERRORinvalid option type

The documentation for this class was generated from the following file: