Page History
...
Data Set Function List
A connector DataSet data set is an implementation of abstract java class AbstractDataSet. When defining a DataSet data set the following functions require implementation:
...
Return a DataSetName as a Stringstring. This should not be internationalisedinternationalized.
| Styleclass | ||
|---|---|---|
| ||
...
Return a collection of ColumnMetaData objects that define the columns that are available in the DataSetdata set. A column can also be defined to be used as a filter.
ColumnMetaData objects require the following meta-data metadata to be defined:
Attribute | Description |
|---|---|
columnName | Name of the column. This should be unique and should not be internationalisedinternationalized. User friendly names and internationalisation internationalization can be applied at the Yellowfin metadata level. |
columnType | DataType of the column. See DataType in the appendix for more information. |
fieldType | FieldType of the column. See FieldType in the appendix for more information. |
availableAggregations | Array of AggregationType. This defines the aggregations that can be applied to this column. See AggregationType in the appendix for more information. |
availableFilterOperators | Array of FilterOperator. This defines the operators that can be applied to this column if it is used as a filter. If this column cannot be used as a filter is should be set as null. See FilterOperator in the appendix for more information. |
...
public abstract List<FilterMetaData> getFilters();
Return a collection of FilterMetaData objects that define the filters that are available in the DataSetdata set. A filter in this context is a parameter that can be used for a report, it does not return data like a column does.
FilterMetaData objects require the following meta-data metadata to be defined:
Attribute | Description |
|---|---|
filterName | Name of Filterfilter. This should be unique and should not be internationalisedinternationalized. User friendly names and internationalisation internationalization can be applied at the Yellowfin metadata level. |
filterType | FilterType Filter type of the column. See FilterType in the appendix for more information. |
Mandatory | Define whether this filter is mandatory or not. Data cannot be returned from this DataSet data set without this filter being set. |
availableAggregations | Array of AggregationType. This defines the aggregations that can be applied to this filter. Currently unsupported. See AggregationType in the appendix for more information. |
availableOperators | Array of FilterOperator. This defines the operators that can be applied to this filter. See FilterOperator in the appendix for more information. |
There are multiple constructors for FilterMetaData , that allow for defining this object with a single line of Java code.
...
Returns the result set from this DataSetdata set. This is the main function for processing the query. The parameter column specifies the columns that have been chosen for the query from Yellowfin. The parameter filters specifies the filters that have been assigned to the query from Yellowfin. The function must return a 2-dimensional object array with the contents of the columns requested.
...
The parameter filters is of the type FilterData. This has information about the filters selected and the values that have been assigned to them.
FilterData has the following attributes:
Attribute | Description |
|---|---|
filterName | Name of the filter or column that this filter represents. |
metaData | FilterMetaData of filter. This will be a link to the FilterMetaData object that was defined in getFilters() or FilterMetaData object that is created automatically to wrap a column that supports filtering. |
filterValue | The value of the filter. This is a java Object Java object that holds the data for the datatype of the filter. Filters that hold multiple values will be returned in a Java List. This is for filters using Between, Not Between and In List and Not In List. |
filterOperator | Instance of type FilterOperator. This defines the operator that has been applied to this filter. |
aggregationType | Instance of type AggregationOperator. This defines the operator that has been applied to this filter. |
A custom error message can be show shown if an error occurs by throwing a ThirdPartyException(). See Custom Error Messages.
...
If this is false, then Yellowfin will enable application level aggregations. This will allow for Yellowfin to aggregate data once it has been returned from the DataSetdata set.
If this is true, then the DataSet data set must return aggregated data when requested. Columns can be defined with what aggregations can be applied to them during report creation. This is defined in getColumns().
...