kd.bos.entity.filter

## 类 FilterField

- java.lang.Object
- - kd.bos.entity.filter.FilterField

-     public class FilterField
      extends java.lang.Object

  过滤字段信息

- - ### 构造器概要

    构造器
    构造器和说明
    `FilterField()` 构造函数
    `FilterField(kd.bos.dataentity.entity.LocaleString caption, java.lang.String fieldName, java.lang.String entityKey, java.lang.String compareGroupID, int fieldType)` 构造函数
    `FilterField(MainEntityType mainType, kd.bos.dataentity.metadata.IDataEntityProperty srcFieldProp, kd.bos.dataentity.metadata.IDataEntityProperty refProp1, kd.bos.dataentity.metadata.IDataEntityProperty refProp2, java.lang.String refEntityId)` 构造函数

  - ### 方法概要

    所有方法 静态方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `static java.lang.String` | `buildPropORMFullName(kd.bos.dataentity.metadata.IDataEntityProperty prop)` 输出ORM完整属性名，包含单据体前缀
    `static FilterField` | `create(MainEntityType mainType, java.lang.String fieldName)` 公共静态方法：传入字段标识，创建对应的过滤字段
    `java.util.Map<java.lang.String,java.lang.Object>` | `createFilterColumn()` 基于本对象，生成前端过滤表格中用到的过滤字段
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getBaseDataFilterControlType()`
    `kd.bos.dataentity.entity.LocaleString` | `getCaption()`
    `java.util.List<ValueMapItem>` | `getComboItems()` 字段枚举集
    `java.lang.String` | `getCompareGroupID()`
    `CompareType` | `getCompareType(java.lang.String compareTypeId)`
    `java.util.List<CompareType>` | `getCompareTypes()`
    `CompareType` | `getDefaultCompareType()`
    `java.lang.String` | `getDefaultCompareTypeId()`
    `CompareType` | `getDefaultMultiCompareType()`
    `java.lang.String` | `getDefaultMultiCompareTypeId()`
    `java.lang.String` | `getEntityKey()`
    `java.lang.String` | `getFieldName()` 字段标识
    `kd.bos.dataentity.metadata.IDataEntityProperty` | `getFieldProp()` 过滤字段
    `int` | `getFieldType()`
    `java.lang.String` | `getFilterControlType()`
    `java.lang.String` | `getFullFieldCaption()`
    `java.lang.String` | `getFullFieldName()` 字段完整的ORM属性名，需使用实体名作为前缀
    `MainEntityType` | `getMainType()` 公共属性
    `java.lang.String` | `getRefEntityId()` 过滤字段，f7点击时，打开的基础资料
    `kd.bos.dataentity.metadata.IDataEntityProperty` | `getRefProp1()` 基础资料引用属性1
    `kd.bos.dataentity.metadata.IDataEntityProperty` | `getRefProp2()` 基础资料第二层引用属性
    `java.lang.String` | `getRefPropKey()`
    `java.lang.String` | `getRefPropKey1()`
    `java.lang.String` | `getRefPropKey2()`
    `int` | `getSeq()`
    `java.lang.String` | `getSrcFieldKey()`
    `kd.bos.dataentity.metadata.IDataEntityProperty` | `getSrcFieldProp()` 单据字段
    `java.lang.Object` | `getValueFast(kd.bos.dataentity.entity.DynamicObject dynamicObject)`
    `int` | `hashCode()`
    `void` | `setCaption(kd.bos.dataentity.entity.LocaleString caption)`
    `void` | `setComboItems(java.util.List<ValueMapItem> comboItems)`
    `void` | `setCompareGroupID(java.lang.String compareGroupID)`
    `void` | `setCompareTypes(java.util.List<CompareType> compareTypes)`
    `void` | `setDefaultCompareTypeId(java.lang.String defaultCompareID)`
    `void` | `setDefaultMultiCompareTypeId(java.lang.String defaultCompareID)`
    `void` | `setFieldName(java.lang.String fieldName)`
    `void` | `setFieldType(int fieldType)`
    `void` | `setMainType(MainEntityType mainType)`
    `void` | `setRefEntityId(java.lang.String refEntityId)`
    `void` | `setRefPropKey(java.lang.String refPropKey)`
    `void` | `setSeq(int seq)`
    `java.lang.String` | `toString()`

    - ### 从类继承的方法 java.lang.Object

      `getClass, notify, notifyAll, wait, wait, wait`

- - ### 构造器详细资料

    - #### FilterField

          public FilterField()

      构造函数

    - #### FilterField

          public FilterField(MainEntityType mainType,
                             kd.bos.dataentity.metadata.IDataEntityProperty srcFieldProp,
                             kd.bos.dataentity.metadata.IDataEntityProperty refProp1,
                             kd.bos.dataentity.metadata.IDataEntityProperty refProp2,
                             java.lang.String refEntityId)

      构造函数
      参数:
        `srcFieldProp` - 单据字段
        `refProp1` - 引用属性1
        `refProp2` - 引用属性2
        `refEntityId` - 字段对应的实体标识

    - #### FilterField

          public FilterField(kd.bos.dataentity.entity.LocaleString caption,
                             java.lang.String fieldName,
                             java.lang.String entityKey,
                             java.lang.String compareGroupID,
                             int fieldType)

      构造函数
      参数:
        `caption` - 字段标题
        `fieldName` - 字段标识，不包含单据体前缀
        `entityKey` - 字段所在的单据体
        `compareGroupID` - 比较符号集
        `fieldType` - 数据库字段类型
        `isConstant` - 是否常量：专用于主组织

  - ### 方法详细资料

    - #### create

          public static FilterField create(MainEntityType mainType,
                                           java.lang.String fieldName)

      公共静态方法：传入字段标识，创建对应的过滤字段
      参数:
        `mainType` - 单据主实体
        `fieldName` - 字段名，格式：基础资料.引用属性1.引用属性2
      返回:

    - #### getMainType

          public MainEntityType getMainType()

      公共属性

    - #### setMainType

          public void setMainType(MainEntityType mainType)

    - #### getSeq

          public int getSeq()

      返回:
        序号

    - #### setSeq

          public void setSeq(int seq)

      参数:
        `seq` - 序号

    - #### getEntityKey

          public java.lang.String getEntityKey()

      返回:
        所属分录

    - #### getFieldName

          public java.lang.String getFieldName()

      字段标识
      返回:

    - #### setFieldName

          public void setFieldName(java.lang.String fieldName)

      参数:
        `fieldName` - 字段标识

    - #### getFullFieldName

          public java.lang.String getFullFieldName()

      字段完整的ORM属性名，需使用实体名作为前缀
      返回:

    - #### getCaption

          public kd.bos.dataentity.entity.LocaleString getCaption()

    - #### setCaption

          public void setCaption(kd.bos.dataentity.entity.LocaleString caption)

      参数:
        `caption` - 字段名称

    - #### getFieldProp

          public kd.bos.dataentity.metadata.IDataEntityProperty getFieldProp()

      过滤字段
      返回:

    - #### getSrcFieldProp

          public kd.bos.dataentity.metadata.IDataEntityProperty getSrcFieldProp()

      单据字段
      返回:

    - #### getSrcFieldKey

          public java.lang.String getSrcFieldKey()

    - #### getRefProp1

          public kd.bos.dataentity.metadata.IDataEntityProperty getRefProp1()

      基础资料引用属性1
      返回:

    - #### getRefPropKey1

          public java.lang.String getRefPropKey1()

    - #### getRefProp2

          public kd.bos.dataentity.metadata.IDataEntityProperty getRefProp2()

      基础资料第二层引用属性
      返回:

    - #### getRefPropKey2

          public java.lang.String getRefPropKey2()

    - #### getRefPropKey

          public java.lang.String getRefPropKey()

    - #### setRefPropKey

          public void setRefPropKey(java.lang.String refPropKey)

    - #### getRefEntityId

          public java.lang.String getRefEntityId()

      过滤字段，f7点击时，打开的基础资料
      返回:

    - #### setRefEntityId

          public void setRefEntityId(java.lang.String refEntityId)

    - #### getFieldType

          public int getFieldType()

      返回:
        字段数据类型，DBType, java.sql.Types

    - #### setFieldType

          public void setFieldType(int fieldType)

    - #### getDefaultCompareTypeId

          public java.lang.String getDefaultCompareTypeId()

      返回:
        列表常用过滤条件选择了一个值时使用的比较符

    - #### setDefaultCompareTypeId

          public void setDefaultCompareTypeId(java.lang.String defaultCompareID)

      参数:
        `defaultCompareID` - 字段默认比较符组标识

    - #### getDefaultMultiCompareTypeId

          public java.lang.String getDefaultMultiCompareTypeId()

      返回:
        列表快速搜索过滤条件或常用过滤条件选择了多个值时使用的比较符（比如文本是LIKE(59)）

    - #### setDefaultMultiCompareTypeId

          public void setDefaultMultiCompareTypeId(java.lang.String defaultCompareID)

      参数:
        `defaultCompareID` - 字段默认比较符组标识

    - #### getCompareGroupID

          public java.lang.String getCompareGroupID()

      返回:
        比较符组标识

    - #### setCompareGroupID

          public void setCompareGroupID(java.lang.String compareGroupID)

      参数:
        `compareGroupID` - 比较符组标识

    - #### getDefaultCompareType

          public CompareType getDefaultCompareType()

      返回:
        // 默认比较符(单个值)

    - #### getDefaultMultiCompareType

          public CompareType getDefaultMultiCompareType()

      返回:
        // 默认比较符(多个值)

    - #### getCompareTypes

          public java.util.List<CompareType> getCompareTypes()

      返回:
        比较符集合

    - #### setCompareTypes

          public void setCompareTypes(java.util.List<CompareType> compareTypes)

      参数:
        `compareTypes` - 比较符集合

    - #### getCompareType

          public CompareType getCompareType(java.lang.String compareTypeId)

      参数:
        `compareTypeId` - 比较符标识
      返回:
        比较符

    - #### getComboItems

          public java.util.List<ValueMapItem> getComboItems()

      字段枚举集
      返回:

    - #### setComboItems

          public void setComboItems(java.util.List<ValueMapItem> comboItems)

    - #### getBaseDataFilterControlType

          public java.lang.String getBaseDataFilterControlType()

    - #### getFilterControlType

          public java.lang.String getFilterControlType()

      返回:
        过滤字段类型，发给前端

    - #### createFilterColumn

          public java.util.Map<java.lang.String,java.lang.Object> createFilterColumn()

      基于本对象，生成前端过滤表格中用到的过滤字段
      返回:

    - #### equals

          public boolean equals(java.lang.Object obj)

      覆盖:
        `equals` 在类中 `java.lang.Object`

    - #### hashCode

          public int hashCode()

      覆盖:
        `hashCode` 在类中 `java.lang.Object`

    - #### toString

          public java.lang.String toString()

      覆盖:
        `toString` 在类中 `java.lang.Object`

    - #### buildPropORMFullName

          public static java.lang.String buildPropORMFullName(kd.bos.dataentity.metadata.IDataEntityProperty prop)

      输出ORM完整属性名，包含单据体前缀
      参数:
        `prop` - 属性对象
      返回:
        ORM完整属性名，包含单据体前缀

    - #### getFullFieldCaption

          public java.lang.String getFullFieldCaption()

    - #### getValueFast

          public java.lang.Object getValueFast(kd.bos.dataentity.entity.DynamicObject dynamicObject)