DataType 

DataType is used for defining the data type for a column or filter. 

Type 

Description 

TEXT 

Text value. A data set should return a Java String for this type. 

NUMERIC 

Numeric value. A data set should return a Java String for this type. 

INTEGER 

Integer value. A data set should return a Java Long or Integer for this type. 

DATE 

Date value. A data set should return a Java java.sql.Date for this type. 

TIMESTAMP 

Timestamp value. A data set should return a Java java.sql.Timestamp for this type. 

SHORT 

Short integer value. A data set should return a Java Long or Integer for this type. 

ARRAY 

Array. Currently unsupported. 

BOOLEAN 

Boolean value. A data set should return a Java Boolean for this type. 

BLOB 

Blob/Binary value. A data set should return a Java byte[] for this type. 

 

 

FieldType 

FieldType is used for defining the field type for a column or filter. 

Type 

Description 

DIMENSION 

Dimensional Value. The report builder will use dimensional filter paradigm for this column, and restrict aggregation types to COUNT and COUNT DISTINCT. 

METRIC 

Metric/Measure value. The report builder will use metric filter paradigm for this column, and allow all available aggregation types. 

UNKNOWN 

Unknown column type. This should not be used. 

 

 

AggregationType 

AggregationType is used for defining an aggregation that can be applied to a column or filter. 

Type 

Description 

COUNT 

Count all values of a column. 

COUNTDISTINCT 

Count all distinct values of a column. 

AVG 

Average the values of a column. 

MAX 

Return the maximum value of a column. 

MIN 

Return the minimum value of a column. 

SUM 

Return the sum of the values in the column. 

 

 

FilterOperator 

FilterOperator is used for defining operators for a column or filter. 

TypeDescription

EQUAL 

Values are equal. 

NOTEQUAL 

Values are not equal. 

INLIST 

Value is within a defined list of values. 

NOTINLIST 

Value is not withing a defined list of values. 

GREATER 

Value is greater than a value. 

GREATEREQUAL 

Value is greater than or equal to a value. 

LESS 

Value is less than a value. 

LESSEQUAL 

Value is less than or equal to a value. 

BETWEEN 

Value is between two bounds. 

NOTBETWEEN 

Value is not between two bounds. 

ISNULL 

Value is null. 

ISNOTNULL 

Value is not null. 

STARTSWITH 

Text starts with a value. 

NOTSTARTSWITH 

Text does not start with a value. 

ENDSWITH 

Text ends with a value. 

NOTENDSWITH 

Text does not end with a value. 

CONTAINS 

Text contains a value. 

NOTCONTAINS 

Text does not contain a value. 

ISEMPTYSTRING 

Text is empty string. 

ISNOTEMPTYSTRING 

Text is not an empty string. 

 

 

Parameter DataType 

Parameter DataType is used for defining the data stored for a given meta-data parameter. These are defined as final static integers in the UserInputParameter Class. 

TypeDescription

TYPE_UNKNOWN 

Unknown Value. 

TYPE_NUMERIC 

Numeric Value. 

TYPE_TEXT 

Text Value. 

TYPE_PASSWORD 

Password Value. 

TYPE_BOOLEAN 

Boolean Value. 

 

 

Display Type 

DisplayType is used for defining how data will be shown in the connection metadata wizard. These are defined as final static integers in the UserInputParameter Class. 

TypeDescription

DISPLAY_TEXT_TINY 

Short text input box. 

DISPLAY_TEXT_MED 

Medium length text input box. 

DISPLAY_TEXT_MED_LONG 

Medium-long text input box. 

DISPLAY_TEXT_LONG 

Long text input box. 

DISPLAY_SELECT 

Select dropdown input box. This type of parameter requires additional options. Options are added to Parameter with addOption(String Key, String Description). The key is stored as the parameter value when selected. The description is shown as a selectable option in a dropdown box. 

DISPLAY_RADIO 

Radio selection input box. This type of parameter requires additional options. Additional options are rendered as selectable elements in the UI. Options are added to Parameter with addOption(String Key, String Description). The key is stored as the parameter value when selected. The description is shown next to the selectable radio button. 

DISPLAY_HIDDEN 

Hidden input box. 

DISPLAY_BUTTON 

Button. This type of parameter requires additional options. This UI element makes a callback to the buttionPressed() function in the JDBCMetaData Class. Additional option “BUTTONTEXT” is used for setting the text shown on the button. 

DISPLAY_STATIC_TEXT 

Displays static text. The long description of the parameter will be displayed as static text. 

DISPLAY_URLBUTTON 

Button with a link to an external URL. This type of parameter requires additional options. Additional option “BUTTONTEXT” is used for setting the text shown on the button. Additional option “BUTTONURL” is used for setting the URL that the button links to. 

DISPLAY_PASSWORD 

Password input box. 

 

 

Previous topic: Package connector