org.qore.lang.dataprovider.AbstractDataField Class Reference

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

Inheritance diagram for org.qore.lang.dataprovider.AbstractDataField:

Public Member Methods
	AbstractDataField (QoreObject obj) throws Throwable
	creates the object as a wrapper for the Qore object
boolean	isAssignableFrom (AbstractDataProviderType t) throws Throwable
	returns True if this field's type can be assigned from values of the argument type
boolean	isAssignableFrom (Type t) throws Throwable
	returns True if this field's type can be assigned from values of the argument type
boolean	isList () throws Throwable
	returns True if this field's type is a list
boolean	isMandatory () throws Throwable
	returns True if the field's type must have a value
Object	getOptionValue (String opt) throws Throwable
	returns the value of the given option on the field's type
HashMap< String, Object >	getOptions () throws Throwable
	returns options set on the field's type
HashMap< String, HashMap< String, Object > >	getSupportedOptions () throws Throwable
	returns supported options on the field's type
void	setOption (String opt, Object value) throws Throwable
	sets the given option on the field's type
void	setOptions (Map< String, Object > options) throws Throwable
	sets the given options on the field's type
String	getTypeName () throws Throwable
	returns the type name
void	setDefaultValue (Object default_value) throws Throwable
	sets the default value for the field
Object	getDefaultValue () throws Throwable
	get default value, if any
boolean	hasType () throws Throwable
	returns True if the field's type is not a wildcard type
Object	acceptsValue (Object value) throws Throwable
	returns the value if the value can be assigned to the type
HashMap< String, Object >	getInputInfo () throws Throwable
	returns information about the field as an input field
HashMap< String, Object >	getInfo () throws Throwable
	returns information about the field
AbstractDataField	getSoftType () throws Throwable
	returns a field with a "soft" type equivalent to the current type
String	getName () throws Throwable
	returns the name of the field
String	getDescription () throws Throwable
	returns the description, if any
AbstractDataProviderType	getType () throws Throwable
	returns the type of the field
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

Additional Inherited Members
Private Attributes inherited from org.qore.jni.QoreObjectWrapper
QoreObject	obj
	the wrapper Qore object

Detailed Description

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

Note

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

Deprecated

Use dynamic imports instead: import qoremod.DataProvider.AbstractDataField;

Member Function Documentation

acceptsValue()

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

inline

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

Parameters

value

the 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.AbstractDataField.getInputInfo ( ) throws Throwable

inline

returns information about the field as an input field

the default_value key is not returned, and the type key returns only input information

getSoftType()

AbstractDataField org.qore.lang.dataprovider.AbstractDataField.getSoftType ( ) throws Throwable

inline

returns a field with a "soft" type equivalent to the current type

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

Returns

a field with a "soft" type equivalent to the current type

setOption()

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

inline

sets the given option on the field's type

Parameters

opt	the option to set
value	the value to set

Exceptions

TYPE-OPTION-ERROR

invalid option or invalid option type

setOptions()

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

inline

sets the given options on the field's type

Parameters

options

a hash of options, if any options match supported options for this type, they are set

Exceptions

TYPE-OPTION-ERROR

option value has an invalid type

---

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

• src/java/org/qore/lang/dataprovider/AbstractDataField.java