IngestField (platform/sdk 5.5.1.0-SNAPSHOT API)

java.lang.Object
- com.attivio.sdk.ingest.IngestField

All Implemented Interfaces:

LocaleAware, Serializable, Cloneable, Iterable<IngestFieldValue>
```
public class IngestField
extends Object
implements Iterable<IngestFieldValue>, Serializable, Cloneable, LocaleAware
```
A list of field values for an IngestDocument.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

IngestField(String name)
Construct a new IngestField.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addValue(Boolean value)` Add a `Boolean` value to this `IngestField`.
`void`	`addValue(ContentPointer value)` Add a `ContentPointer` value to this `IngestField`.
`void`	`addValue(Date value)` Add a `Date` value to this `IngestField`.
`void`	`addValue(Document value)` Add a `Document` value to this `IngestField`.
`void`	`addValue(IngestFieldValue value)` Add a `value` to this `IngestField`.
`void`	`addValue(Number value)` Add a `numeric` value to this `IngestField`.
`void`	`addValue(Point value)` Add a `Point` value to this `IngestField`.
`void`	`addValue(Shape value)` Add a `Shape` value to this `IngestField`.
`void`	`addValue(String value)` Add a `String` value to this `IngestField`.
`void`	`addValues(Boolean... values)` Add `Boolean` `values` to this `IngestField`.
`void`	`addValues(ContentPointer... values)` Add `ContentPointer` `values` to this `IngestField`.
`void`	`addValues(Date... values)` Add `Date` `values` to this `IngestField`.
`void`	`addValues(Document... values)` Add `Document` `values` to this `IngestField`.
`void`	`addValues(Number... values)` Add `numeric` `values` to this `IngestField`.
`void`	`addValues(Point... values)` Add `Point` `values` to this `IngestField`.
`void`	`addValues(Shape... values)` Add `Shape` `values` to this `IngestField`.
`void`	`addValues(String... values)` Add `String` `values` to this `IngestField`.
`void`	`clear()` Remove all values.
`IngestField`	`clone()`
`boolean`	`equals(Object other)`
`int`	`filter(Predicate<? super IngestFieldValue> predicate)` Filter out all values that do not match `predicate`.
`void`	`forEach(Consumer<? super IngestFieldValue> consumer)`
`long`	`getEstimatedSize()` Get the estimated size of this field in bytes.
`IngestFieldValue`	`getFirstValue()` Gets the first field value.
`Locale`	`getLocale()` Get the `Locale` for this field.
`String`	`getName()` Get the name of the field.
`IngestFieldValue`	`getValue(int index)` Get the `IngestFieldValue` at `index`.
`int`	`hashCode()`
`int`	`indexOf(Object value)` Get the index of the `IngestFieldValue` with `value`.
`ListIterator<IngestFieldValue>`	`iterator()` Get an iterator for iterating over all `values`.
`void`	`removeValue(Object value)` Remove a field value.
`void`	`setLocale(Locale value)` Set the `Locale` for this field.
`int`	`size()` Get the number of field values.
`String`	`toString()`

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

Methods inherited from interface java.lang.Iterable
spliterator

- Constructor Detail
  - IngestField
```
public IngestField(String name)
```
    Construct a new IngestField.
- Method Detail
  - getEstimatedSize
```
public long getEstimatedSize()
```
    Get the estimated size of this field in bytes.
    NOTE: Includes size of remote content pointers.
  - getName
```
public String getName()
```
    Get the name of the field.
  - getLocale
```
public Locale getLocale()
```
    Get the Locale for this field.
    
    Specified by:
    
    getLocale in interface LocaleAware
  - setLocale
```
public void setLocale(Locale value)
```
    Set the Locale for this field.
    
    Specified by:
    
    setLocale in interface LocaleAware
  - size
```
public int size()
```
    Get the number of field values.
  - forEach
```
public void forEach(Consumer<? super IngestFieldValue> consumer)
```
    Specified by:
    
    forEach in interface Iterable<IngestFieldValue>
  - filter
```
public int filter(Predicate<? super IngestFieldValue> predicate)
```
    Filter out all values that do not match predicate.
    Returns the number of removed values.
  - iterator
```
public ListIterator<IngestFieldValue> iterator()
```
    Get an iterator for iterating over all values.
    
    Specified by:
    
    iterator in interface Iterable<IngestFieldValue>
  - getFirstValue
```
public IngestFieldValue getFirstValue()
```
    Gets the first field value.
    NOTE: may return null if this field has no values.
  - getValue
```
public IngestFieldValue getValue(int index)
```
    Get the IngestFieldValue at index.
  - indexOf
```
public int indexOf(Object value)
```
    Get the index of the IngestFieldValue with value.
    Returns -1 if value does not exist.
  - 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 IngestField.
  - addValues
```
public void addValues(Number... values)
```
    Add numeric values to this IngestField.
  - addValues
```
public void addValues(Date... values)
```
    Add Date values to this IngestField.
  - addValues
```
public void addValues(Boolean... values)
```
    Add Boolean values to this IngestField.
  - addValues
```
public void addValues(Point... values)
```
    Add Point values to this IngestField.
  - addValues
```
public void addValues(Shape... values)
```
    Add Shape values to this IngestField.
  - addValues
```
public void addValues(Document... values)
```
    Add Document values to this IngestField.
  - addValues
```
public void addValues(ContentPointer... values)
```
    Add ContentPointer values to this IngestField.
  - addValue
```
public void addValue(IngestFieldValue value)
```
    Add a value to this IngestField.
  - addValue
```
public void addValue(String value)
```
    Add a String value to this IngestField.
  - addValue
```
public void addValue(Number value)
```
    Add a numeric value to this IngestField.
  - addValue
```
public void addValue(Date value)
```
    Add a Date value to this IngestField.
  - addValue
```
public void addValue(Boolean value)
```
    Add a Boolean value to this IngestField.
  - addValue
```
public void addValue(Point value)
```
    Add a Point value to this IngestField.
  - addValue
```
public void addValue(Shape value)
```
    Add a Shape value to this IngestField.
  - addValue
```
public void addValue(Document value)
```
    Add a Document value to this IngestField.
  - addValue
```
public void addValue(ContentPointer value)
```
    Add a ContentPointer value to this IngestField.
  - 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 IngestField clone()
```
    Overrides:
    
    clone in class Object

Class IngestField

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

IngestField

Method Detail

getEstimatedSize

getName

getLocale

setLocale

size

forEach

filter

iterator

getFirstValue

getValue

indexOf

clear

removeValue

addValues

addValues

addValues

addValues

addValues

addValues

addValues

addValues

addValue

addValue

addValue

addValue

addValue

addValue

addValue

addValue

addValue

toString

hashCode

equals

clone