Package com.im.df.api.capabilities

Interface DFFieldExtensionCapability

  • All Superinterfaces:
    DFCapability
    public interface DFFieldExtensionCapability
extends DFCapability
    Capability for Extension field.
    Since:
    21.16.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clearQuery()
      Called before query execution to clear any cache or previous results.
      java.util.Set<DFOperator> customOperators()
      Set of custom operators used by this field.
      boolean customValueCache()
      Does this field implement custom value cache?
      java.util.Set<DFField> fieldDependencies()
      Set of fields this Extension field depends on.
      java.util.Map<java.lang.Comparable<?>,​java.lang.Object> retrieveValues​(java.util.List<java.lang.Comparable<?>> rowIds, java.util.Map<java.lang.Comparable<?>,​java.util.Map<java.lang.String,​java.lang.Object>> inputData)
      Retrieves or calculates field values for all row ids.

    • Method Detail

      • fieldDependencies

        java.util.Set<DFField> fieldDependencies()
        Set of fields this Extension field depends on. Can be empty.
        Returns:
        set of field dependencies

      • retrieveValues

        java.util.Map<java.lang.Comparable<?>,​java.lang.Object> retrieveValues​(java.util.List<java.lang.Comparable<?>> rowIds,
                                                                             java.util.Map<java.lang.Comparable<?>,​java.util.Map<java.lang.String,​java.lang.Object>> inputData)
        Retrieves or calculates field values for all row ids.
        Parameters:
        rowIds - row ids
        inputData - Mapping of row ids to fields ids and values. Supplies data from dependent fields.
        Returns:
        mapping of row ids to field values

      • customValueCache

        boolean customValueCache()
        Does this field implement custom value cache?
        Returns:
        true if field implements custom value cache, false otherwise

      • customOperators

        java.util.Set<DFOperator> customOperators()
        Set of custom operators used by this field. Can be empty.
        Returns:
        set of custom operators

      • clearQuery

        void clearQuery()
        Called before query execution to clear any cache or previous results.