com.docmosis.template.population
Interface DataProviderGrouping

All Known Implementing Classes:

DataProviderSQLGrouping

public interface DataProviderGrouping

Information for transforming a grid of data into a hierarchy. This means a "flat" tabular result set can be automatically transformed into groups of data for repeating over, stepping into etc.

Method Summary

Discriminator	getDiscriminator() Get the discriminator used to form data provider groups.
String[]	getFields() Get the names of all field that will be part of the data that the resulting data provider will provide.
String	getName() Get the name for the grouping.

Method Detail

getName

String getName()

Get the name for the grouping. This is the name that will be translated to the name used by data providers calling their children.

Returns:

the name of this data provider grouping.

getDiscriminator

Discriminator getDiscriminator()

Get the discriminator used to form data provider groups.

Returns:

the discriminator.

getFields

String[] getFields()

Get the names of all field that will be part of the data that the resulting data provider will provide. The implementation should ensure that columns that are part of the discriminator are included in the return value.

Returns:

all field names included for this grouping.