Package com.im.df.impl.db.field.extension

Class ExtensionField

  • All Implemented Interfaces:
    com.im.df.api.capabilities.DFFieldExtensionCapability, com.im.df.api.capabilities.InfoCapability, com.im.df.api.ddl.DFCapability, com.im.df.api.ddl.DFField, com.im.df.api.ddl.DFItem, com.im.df.api.ddl.DFUserItem, com.im.df.api.support.PropertiesEditingConfigurable, com.im.df.api.support.PropertiesEditingConfigurable.Extra
    public final class ExtensionField
extends com.chemaxon.dif.db.api.field.ColumnlessFieldAbstractImpl
implements com.im.df.api.capabilities.DFFieldExtensionCapability, com.im.df.api.ddl.DFUserItem
    Extension field implementation.
    Since:
    21.16.0

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.chemaxon.dif.db.api.field.FieldAbstract

        com.chemaxon.dif.db.api.field.FieldAbstract.FUpdater

      • Nested classes/interfaces inherited from class com.chemaxon.dif.db.api.item.DBItemAbstractImpl

        com.chemaxon.dif.db.api.item.DBItemAbstractImpl.AbstractUpdater

      • Nested classes/interfaces inherited from interface com.im.df.api.ddl.DFField

        com.im.df.api.ddl.DFField.Required

      • Nested classes/interfaces inherited from interface com.im.df.api.ddl.DFItem

        com.im.df.api.ddl.DFItem.Handle<T extends com.im.df.api.ddl.DFItem>

      • Nested classes/interfaces inherited from interface com.im.df.api.support.PropertiesEditingConfigurable

        com.im.df.api.support.PropertiesEditingConfigurable.Extra

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String FIELD_EXTENSION  

      • Fields inherited from class com.chemaxon.dif.db.api.item.DBItemAbstractImpl

        DEFAULT_CHARSET

      • Fields inherited from interface com.im.df.api.ddl.DFField

        PROP_DEFAULT_VALUE, PROP_DISTINCT_VALUES, PROP_REQUIRED

      • Fields inherited from interface com.im.df.api.ddl.DFItem

        PROP_CAPABILITIES, PROP_DESCRIPTION, PROP_ID, PROP_NAME, PROP_TYPE, PROP_VALID

    • Constructor Summary

      Constructors 
      Constructor Description
      ExtensionField​(com.chemaxon.dif.db.api.entity.DBEntityAbstractImpl entity, ExtensionFieldInfo dto, com.im.commons.progress.DFEnvironmentRW env)  
      ExtensionField​(com.im.df.api.ddl.DFEntity entity, String id, String name, String description, String implType, List<com.im.ijcs.api.ddl.dto.PropInfo> xAttr, String owner, int sharing, boolean iAmOwner, String handlerClass, String config)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clearQuery()  
      protected com.chemaxon.dif.db.api.field.ColumnlessFieldDataTypeAbstractImpl createFieldType​(String type, com.im.df.api.ddl.DFEntity entity, List<com.im.ijcs.api.ddl.dto.PropInfo> xAttrs)  
      protected com.chemaxon.dif.db.api.item.DBItemAbstractImpl.AbstractUpdater createUpdater()  
      Set<com.im.df.api.dml.DFOperator> customOperators()  
      boolean customValueCache()  
      Set<com.im.df.api.ddl.DFField> fieldDependencies()  
      String getConfig()  
      Class getFieldClass()  
      ExtensionFieldHandler getHandler()  
      boolean isQueryable()  
      Map<Comparable<?>,​Object> retrieveValues​(List<Comparable<?>> rowIds, Map<Comparable<?>,​Map<String,​Object>> inputData)  

      • Methods inherited from class com.chemaxon.dif.db.api.field.ColumnlessFieldAbstractImpl

        getConvertor, getDefaultValue, getEntity, getEntityImpl, getHandle, getNameValidator, getRequired, getSchema, getSchemaImpl, getTooltip, getType, getValidRequiredValues, getXmlBean, init, initType, isDistinctValues, isSortable, removeField, setDefaultValue, setDistinctValues, setRequired, updateFieldType

      • Methods inherited from class com.chemaxon.dif.db.api.field.FieldAbstract

        getXAttributes, putXAttribute

      • Methods inherited from class com.chemaxon.dif.db.api.item.DBItemAbstractImpl

        activateItem, addCapabilitiesFromCapabilityProviders, addCapability, addCommaSeparatedPropsForToString, addPropertyChangeListener, doGetHandle, ensureValid, equals, findOwner, firePropertyChange, firePropertyChange, getCapabilities, getDescription, getId, getName, getXAttributesImpl, handleChanges, handleOwner, handleUpdateDescription, handleUpdateName, handleXAttrs, hashCode, initXAttributes, invalidate, invalidateSubitems, isActive, isCapabilityProviderAllowed, isDifferent, isPropertyEditable, isValid, removeCapability, removePropertyChangeListener, replaceCapability, setDescription, setName, setPropertyEditable, toString

      • Methods inherited from interface com.im.df.api.ddl.DFItem

        addPropertyChangeListener, getCapabilities, getDescription, getId, getName, getType, isValid, removePropertyChangeListener, setDescription, setName

      • Methods inherited from interface com.im.df.api.support.PropertiesEditingConfigurable

        isPropertyEditable

      • Methods inherited from interface com.im.df.api.support.PropertiesEditingConfigurable.Extra

        setPropertyEditable

    • Constructor Detail

      • ExtensionField

        public ExtensionField​(com.chemaxon.dif.db.api.entity.DBEntityAbstractImpl entity,
                      ExtensionFieldInfo dto,
                      com.im.commons.progress.DFEnvironmentRW env)

      • ExtensionField

        public ExtensionField​(com.im.df.api.ddl.DFEntity entity,
                      String id,
                      String name,
                      String description,
                      String implType,
                      List<com.im.ijcs.api.ddl.dto.PropInfo> xAttr,
                      String owner,
                      int sharing,
                      boolean iAmOwner,
                      String handlerClass,
                      String config)

    • Method Detail

      • getConfig

        public String getConfig()

      • fieldDependencies

        public Set<com.im.df.api.ddl.DFField> fieldDependencies()
        Specified by:
        fieldDependencies in interface com.im.df.api.capabilities.DFFieldExtensionCapability

      • customValueCache

        public boolean customValueCache()
        Specified by:
        customValueCache in interface com.im.df.api.capabilities.DFFieldExtensionCapability

      • customOperators

        public Set<com.im.df.api.dml.DFOperator> customOperators()
        Specified by:
        customOperators in interface com.im.df.api.capabilities.DFFieldExtensionCapability

      • clearQuery

        public void clearQuery()
        Specified by:
        clearQuery in interface com.im.df.api.capabilities.DFFieldExtensionCapability

      • createFieldType

        protected com.chemaxon.dif.db.api.field.ColumnlessFieldDataTypeAbstractImpl createFieldType​(String type,
                                                                                            com.im.df.api.ddl.DFEntity entity,
                                                                                            List<com.im.ijcs.api.ddl.dto.PropInfo> xAttrs)
        Specified by:
        createFieldType in class com.chemaxon.dif.db.api.field.ColumnlessFieldAbstractImpl

      • isQueryable

        public boolean isQueryable()
        Specified by:
        isQueryable in interface com.im.df.api.ddl.DFField
        Overrides:
        isQueryable in class com.chemaxon.dif.db.api.field.ColumnlessFieldAbstractImpl

      • getFieldClass

        public Class getFieldClass()
        Specified by:
        getFieldClass in interface com.im.df.api.ddl.DFField
        Overrides:
        getFieldClass in class com.chemaxon.dif.db.api.field.ColumnlessFieldAbstractImpl

      • createUpdater

        protected com.chemaxon.dif.db.api.item.DBItemAbstractImpl.AbstractUpdater createUpdater()
        Specified by:
        createUpdater in class com.chemaxon.dif.db.api.item.DBItemAbstractImpl