Data Types
Type | Java Data Type | Notes |
---|---|---|
TYPE_UNKNOWN | This type is used when the data type is not known, or when a parameter does not have a storage value (as in the case of a button parameter). | |
TYPE_NUMERIC | BigDecimal | |
TYPE_TEXT | String | |
TYPE_DATE | java.sql.Date | |
TYPE_TIME | java.sql.Time | |
TYPE_TIMESTAMP | java.sql.Timestamp | |
TYPE_BOOLEAN | Boolean | |
TYPE_BINARY | byte[] | |
TYPE_GISPOINT TYPE_GISPOLYGON TYPE_GISLINESTRING TYPE_GISMULTILINE TYPE_GISMULTIPOLY TYPE_GISMULTIPOINT TYPE_GISMULTIGEOMETRY TYPE_GISGEOMETRY | GIS Geometry type | All relevant classes live under the com.hof.mi.gis.data package. |
TYPE_PASSWORD | String | Tells Yellowfin to display this in a password input box rather than a plain text input. |
TYPE_FIELD TYPE_GISCACHEFIELD | Integer | Special data types that indicates a report field is required. |
Display Types
Type | Options | Notes |
---|---|---|
DISPLAY_TEXT_TINY DISPLAY_TEXT_SMALL DISPLAY_TEXT_MED DISPLAY_TEXT_MEDLONG DISPLAY_TEXT_LONG | ViewOptions:
| Several different default widths of text input boxes. |
DISPLAY_SELECT | Options: Each option added to a parameter with this display type will be shown as an option in the dropdown list. The value and description are taken from the option. For example: p.addOption(“PUG”, “Small”);
ViewOptions:
| Select dropdown. Has a choice in the list for each option. |
DISPLAY_RADIO | Options: Each option added to a parameter with this display type will be shown as an option in the radio group. The value and description are taken from the option. For example: p.addOption(“ONE”, “1”);
ViewOptions:
| Radio button group. Has a radio button for each option. |
DISPLAY_DATE DISPLAY_TIMESTAMP | ViewOptions:
| Date input element with date-picker. |
DISPLAY_TIME | None. | Text input element which verifies time data input. |
DISPLAY_CHECKBOX | Options: Each option specified will be a checkbox in the list. Only the description will be shown, as the value will be true/false. For example, the options below will produce two checkboxes with the provided text. p.addOption(“Likes dogs?”); | |
DISPLAY_HIDDEN | None. | Element is on the page, but not shown. This is currently only available for Third party drivers and source connections, its use elsewhere is undefined. |
DISPLAY_SWITCH | Options: You can specify two options which will be used as value and description for the left and right switch positions. Example: p.addOption(“SOME_LEFT_VALUE”, “This is the left value”); | Toggle switch with description text for each value. |
DISPLAY_BUTTON | Options: You can set the text of the button by adding an option with the value “BUTTONTEXT” and description of the required text. Example: p.addOption(“BUTTONTEXT”, “Click Me!”); | Standard Yellowfin button. |
DISPLAY_URLBUTTON | Options: You can set the text of the button the same way as in DISPLAY_BUTTON, but this type also has another option for specifying the URL to open when clicked. It is specified by the option value “BUTTONURL” . Example: p.addOption(“BUTTONURL”, “http://google.com”); | Standard Yellowfin button which opens a given link when clicked. |
DISPLAY_STATIC_TEXT | None. | This value is not in use and is deprecated. Its use is undefined. |
DISPLAY_PASSWORD | None. | Password input text box. |
DISPLAY_COLOUR | None. | Standard Yellowfin colour-picker UI. |
DISPLAY_SLIDER_AND_TEXT | ViewOptions:
| Slider input with a linked textbox which allows input via either method. |