IndexForm

java.lang.Object
- ohos.data.search.model.IndexForm

```
public class IndexForm
extends Object
```
Defines the attribute of an index field for fusion search.
Before performing an indexing or search operation, ensure that index attributes are set. indexFieldName indicates the index field name, and indexType indicates the index type of a field, which is IndexType#ANALYZED by default. This default value indicates that the field value is analyzed. isPrimaryKey specifies whether a field is the primary key. Index attributes can contain only one primary key, and the primary key of each index must be unique. Indexes are updated or deleted based on the primary key. isStore specifies whether to store a field. Only a field that is stored can be retrieved from the search result. isSearch specifies whether a field is the default search field. If no field is specified in the input string for search, fields supporting this attribute will be used for search.

从以下版本开始:

3

SystemCapability

SystemCapability.Data#DATA_SEARCH

构造器概要

构造器
构造器	说明
`IndexForm(String indexFieldName)`	A constructor used to create an `IndexForm` instance with a specified index field name.
`IndexForm(String indexFieldName, String indexType, boolean isPrimaryKey, boolean isStore, boolean isSearch)`	A parameterized constructor used to create an `IndexForm` instance.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`String`	`getIndexFieldName()`	Obtains the index field name.
`String`	`getIndexType()`	Obtains the index type.
`int`	`hashCode()`	Returns a hash code value for the object.
`boolean`	`isPrimaryKey()`	Checks whether this field is the primary key.
`boolean`	`isSearch()`	Checks whether this field is the default search field.
`boolean`	`isStore()`	Checks whether to store this field.
`void`	`setIndexFieldName(String indexFieldName)`	Sets the index field name.
`void`	`setIndexType(String indexType)`	Sets the index type.
`void`	`setPrimaryKey(boolean primaryKey)`	Sets whether this field is the primary key.
`void`	`setSearch(boolean search)`	Sets whether this field is the default search field.
`void`	`setStore(boolean store)`	Sets whether to store this field.
`String`	`toString()`	Returns a string representation of the object.

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - IndexForm
```
public IndexForm(String indexFieldName)
```
    A constructor used to create an IndexForm instance with a specified index field name.
    
    参数:
    
    indexFieldName - Indicates the index field name.
    
    从以下版本开始:
    
    3
  - IndexForm
```
public IndexForm(String indexFieldName,
                 String indexType,
                 boolean isPrimaryKey,
                 boolean isStore,
                 boolean isSearch)
```
    A parameterized constructor used to create an IndexForm instance.
    
    参数:
    
    indexFieldName - Indicates the index field name.
    
    indexType - Indicates the index type.
    
    isPrimaryKey - Specifies whether this field is the primary key.
    
    isStore - Specifies whether to store this field.
    
    isSearch - Specifies whether this field is the default search field.
    
    从以下版本开始:
    
    3
- 方法详细资料
  - getIndexFieldName
```
public String getIndexFieldName()
```
    Obtains the index field name.
    
    返回:
    
    Returns the index field name.
    
    从以下版本开始:
    
    3
  - setIndexFieldName
```
public void setIndexFieldName(String indexFieldName)
```
    Sets the index field name.
    
    参数:
    
    indexFieldName - Indicates the index field name to set.
    
    从以下版本开始:
    
    3
  - getIndexType
```
public String getIndexType()
```
    Obtains the index type.
    
    返回:
    
    Returns the index type.
    
    从以下版本开始:
    
    3
  - setIndexType
```
public void setIndexType(String indexType)
```
    Sets the index type.
    
    参数:
    
    indexType - Indicates the index type to set.
    
    从以下版本开始:
    
    3
  - isPrimaryKey
```
public boolean isPrimaryKey()
```
    Checks whether this field is the primary key.
    
    返回:
    
    Returns true if this field is the primary key; returns false otherwise.
    
    从以下版本开始:
    
    3
  - setPrimaryKey
```
public void setPrimaryKey(boolean primaryKey)
```
    Sets whether this field is the primary key.
    
    参数:
    
    primaryKey - Specifies whether this field is the primary key.
    
    从以下版本开始:
    
    3
  - isStore
```
public boolean isStore()
```
    Checks whether to store this field.
    
    返回:
    
    Returns true if this field is stored; returns false otherwise.
    
    从以下版本开始:
    
    3
  - setStore
```
public void setStore(boolean store)
```
    Sets whether to store this field.
    
    参数:
    
    store - Specifies whether to store this field.
    
    从以下版本开始:
    
    3
  - isSearch
```
public boolean isSearch()
```
    Checks whether this field is the default search field.
    
    返回:
    
    Returns true if this field is the default search field; returns false otherwise.
    
    从以下版本开始:
    
    3
  - setSearch
```
public void setSearch(boolean search)
```
    Sets whether this field is the default search field.
    
    参数:
    
    search - Specifies whether this field is the default search field.
    
    从以下版本开始:
    
    3
  - toString
```
public String toString()
```
    从类复制的说明: Object
    Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
    The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
    getClass().getName() + '@' + Integer.toHexString(hashCode())
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    a string representation of the object.
  - equals
```
public boolean equals(Object obj)
```
    从类复制的说明: Object
    Indicates whether some other object is "equal to" this one.
    The equals method implements an equivalence relation on non-null object references:
    - It is reflexive: for any non-null reference value x, x.equals(x) should return true.
    - It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
    - It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
    - It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
    - For any non-null reference value x, x.equals(null) should return false.
    The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).
    Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.
    覆盖:
    
    equals 在类中 Object
    
    参数:
    
    obj - the reference object with which to compare.
    
    返回:
    
    true if this object is the same as the obj argument; false otherwise.
    
    另请参阅:
    
    Object.hashCode(), HashMap
  - hashCode
```
public int hashCode()
```
    从类复制的说明: Object
    Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.
    The general contract of hashCode is:
    - Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
    - If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
    - It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
    As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)
    覆盖:
    
    hashCode 在类中 Object
    
    返回:
    
    a hash code value for this object.
    
    另请参阅:
    
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

类 IndexForm

构造器概要

方法概要

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

构造器详细资料

IndexForm

IndexForm

方法详细资料

getIndexFieldName

setIndexFieldName

getIndexType

setIndexType

isPrimaryKey

setPrimaryKey

isStore

setStore

isSearch

setSearch

toString

equals

hashCode