com.docmosis.template.population
Interface DataProviderGrouping

All Known Implementing Classes:

DataProviderSQLGrouping

public interface DataProviderGrouping

An interface to act as a blueprint for what a data provider will look like.

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

public 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

public Discriminator getDiscriminator()

Get the discriminator used to form data provider groups.

Returns:

the discriminator.

getFields

public 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.