SearchField (platform/sdk 5.5.1.0-SNAPSHOT API)

java.lang.Object
- com.attivio.sdk.search.SearchField

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Iterable<SearchFieldValue>
```
public class SearchField
extends Object
implements Iterable<SearchFieldValue>, Externalizable, Cloneable
```
A list of field values for a SearchDocument.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SearchField()

SearchField(String name)
Construct a new SearchField.

Constructors
Constructor and Description
`SearchField()`
`SearchField(String name)` Construct a new SearchField.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addValue(Boolean value)` Add a `Boolean` value to this `SearchField`.
`void`	`addValue(Date value)` Add a `Date` value to this `SearchField`.
`void`	`addValue(Number value)` Add a `numeric` value to this `SearchField`.
`void`	`addValue(Point value)` Add a `Point` value to this `SearchField`.
`void`	`addValue(SearchFieldValue value)` Add a `value` to this `SearchField`.
`void`	`addValue(Shape value)` Add a `Shape` value to this `SearchField`.
`void`	`addValue(String value)` Add a `String` value to this `SearchField`.
`void`	`addValues(Boolean... values)` Add `Boolean` `values` to this `SearchField`.
`void`	`addValues(Date... values)` Add `Date` `values` to this `SearchField`.
`void`	`addValues(Number... values)` Add `numeric` `values` to this `SearchField`.
`void`	`addValues(Point... values)` Add `Point` `values` to this `SearchField`.
`void`	`addValues(Shape... values)` Add `Shape` `values` to this `SearchField`.
`void`	`addValues(String... values)` Add `String` `values` to this `SearchField`.
`void`	`clear()` Remove all values.
`SearchField`	`clone()`
`boolean`	`equals(Object other)`
`SearchFieldValue`	`getFirstValue()` Gets the first field value.
`String`	`getName()` Get the name of the field.
`SearchFieldValue`	`getValue(int index)` Get the `SearchFieldValue` at `index`.
`int`	`hashCode()`
`ListIterator<SearchFieldValue>`	`iterator()` Get an iterator for iterating over all `values`.
`void`	`readExternal(ObjectInput in)`
`void`	`removeValue(Object value)` Remove a field `value`.
`int`	`size()` Get the number of field values.
`String`	`toString()`
`void`	`writeExternal(ObjectOutput out)`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - SearchField
```
public SearchField()
```
  - SearchField
```
public SearchField(String name)
```
    Construct a new SearchField.
- Method Detail
  - getName
```
public String getName()
```
    Get the name of the field.
  - size
```
public int size()
```
    Get the number of field values.
  - getFirstValue
```
public SearchFieldValue getFirstValue()
```
    Gets the first field value.
    NOTE: may return null if this field has no values.
  - getValue
```
public SearchFieldValue getValue(int index)
```
    Get the SearchFieldValue at index.
  - iterator
```
public ListIterator<SearchFieldValue> iterator()
```
    Get an iterator for iterating over all values.
    
    Specified by:
    
    iterator in interface Iterable<SearchFieldValue>
  - clear
```
public void clear()
```
    Remove all values.
  - removeValue
```
public void removeValue(Object value)
```
    Remove a field value.
  - addValues
```
public void addValues(String... values)
```
    Add String values to this SearchField.
  - addValues
```
public void addValues(Number... values)
```
    Add numeric values to this SearchField.
  - addValues
```
public void addValues(Date... values)
```
    Add Date values to this SearchField.
  - addValues
```
public void addValues(Boolean... values)
```
    Add Boolean values to this SearchField.
  - addValues
```
public void addValues(Point... values)
```
    Add Point values to this SearchField.
  - addValues
```
public void addValues(Shape... values)
```
    Add Shape values to this SearchField.
  - addValue
```
public void addValue(SearchFieldValue value)
```
    Add a value to this SearchField.
  - addValue
```
public void addValue(String value)
```
    Add a String value to this SearchField.
  - addValue
```
public void addValue(Number value)
```
    Add a numeric value to this SearchField.
  - addValue
```
public void addValue(Date value)
```
    Add a Date value to this SearchField.
  - addValue
```
public void addValue(Boolean value)
```
    Add a Boolean value to this SearchField.
  - addValue
```
public void addValue(Point value)
```
    Add a Point value to this SearchField.
  - addValue
```
public void addValue(Shape value)
```
    Add a Shape value to this SearchField.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - clone
```
public SearchField clone()
```
    Overrides:
    
    clone in class Object
  - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException
```
    Specified by:
    
    readExternal in interface Externalizable
    
    Throws:
    
    IOException
  - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
    Specified by:
    
    writeExternal in interface Externalizable
    
    Throws:
    
    IOException

Class SearchField

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

SearchField

SearchField

Method Detail

getName

size

getFirstValue

getValue

iterator

clear

removeValue

addValues

addValues

addValues

addValues

addValues

addValues

addValue

addValue

addValue

addValue

addValue

addValue

addValue

toString

hashCode

equals

clone

readExternal

writeExternal