Interface DFEntity

  • All Superinterfaces:
    DFItem, PropertiesEditingConfigurable

    public interface DFEntity
    extends DFItem

    The definition of an entity that contains fields. This can be thought of as the definition of data objects that can be used by Discovery Framework (DIF).

    A DFEntity is an abstraction of a set of values organised in a row and column paradigm. A database table would be a typical example, but the abstraction allows a single entity to represent multiple tables such as a master table and a lookup table. Also, the source data can be transformed (e.g pivoted) to generate the row/column model. A DFEntity contains one or more DFFields, and can also define DFRelationships and indexes.

    The DFEntity interface just defines the "structure" of the entity (e.g. think of it as the DDL aspects of SQL). To work with the values contained in the DFEntity you need to obtain a DFEntityDataProvider. Use DFEntityDataProviders.find(DFEntity).

    See Also:
    DFSchema, DFField, DFEntityDataProvider, DFCapability
    • Field Detail


        static final java.lang.String PROP_FIELDS
        The 'fields' property name.
        See Also:
        Constant Field Values
      • PROP_LISTS

        static final java.lang.String PROP_LISTS
        The 'lists' property name.
        See Also:
        Constant Field Values
    • Method Detail

      • getSchema

        DFSchema getSchema()
        Gets the IJC schema that this entity belongs to.
        The parent DFSchema instance.
      • getFields

        DFContainer<DFField> getFields()
        Gets the fields in this entity. The fields will also include the id field.
        The container with the fields belonging to this entity.
      • getIdField

        DFField getIdField()
        Gets the ID field for this entity. The ID field is a field which values can uniquely identify data rows obtained for this entity.
        Value of property idField.
      • getLists

        DFContainer<DFList> getLists()
        Gets the lists associated with this entity.
        The container with the lists based on this entity.