Package com.smartgwt.client.docs

Interface RelationalReference

public interface RelationalReference
A dot-notation string referencing a field on a related DataSource, used as a fieldName or valuePath within ServerDynamicCriteria.

Forms:

  • DS.field — traverse the default FK to DS and read field (e.g. Order.status)
  • fkField:DS.field — when multiple FK fields on the current DataSource point to the same target DataSource, fkField specifies which one to follow (e.g. processorId:Employee.workStatus where both processorId and managerId are FKs to Employee)
  • DS1.DS2.field — multi-hop traversal through intermediate DataSources (e.g. Order.Customer.region)
  • DS.field.#count, DS.field.#sum, etc. — aggregation shorthand for one-to-many relations (e.g. OrderLine.#count, OrderLine.amount.#sum)
The syntax is shared with DataSourceField.includeVia and queryFK. The last dot-separated segment is always the target field (or #aggregation function); everything before it identifies the relation path. Non-aggregation references traverse many-to-one relations (looking up a parent record via FK). With aggregation shorthand, one-to-many relations are also supported.