IngestDocument (platform/sdk 5.5.1.0-SNAPSHOT API)

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

All Implemented Interfaces:

LocaleAware, Serializable, Cloneable, Iterable<IngestField>
```
public class IngestDocument
extends Object
implements Iterable<IngestField>, Serializable, Cloneable, LocaleAware
```
A document for content ingestion.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static DocumentMode DEFAULT_DOCUMENT_MODE

Fields
Modifier and Type	Field and Description
`static DocumentMode`	`DEFAULT_DOCUMENT_MODE`

Constructor Summary

Constructors
Constructor and Description
`IngestDocument(String id)` Construct a new IngestDocument.
`IngestDocument(String id, DocumentMode mode)` Construct a new IngestDocument.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addValue(String name, Boolean value)` Add a `Boolean` value to `field`.
`void`	`addValue(String name, ContentPointer value)` Add a `ContentPointer` value to `field`.
`void`	`addValue(String name, Date value)` Add a `Date` value to `field`.
`void`	`addValue(String name, Document value)` Add a `Document` value to `field`.
`void`	`addValue(String field, IngestFieldValue value)` Add a `value` to `field`.
`void`	`addValue(String name, Number value)` Add a `numeric` value to `field`.
`void`	`addValue(String name, Point value)` Add a `Point` value to `field`.
`void`	`addValue(String name, Shape value)` Add a `Shape` value to `field`.
`void`	`addValue(String name, String value)` Add a `String` value to `field`.
`void`	`addValues(String field, Boolean... values)` Add `Boolean` `values` to `field`.
`void`	`addValues(String field, ContentPointer... values)` Add `ContentPointer` `values` to `field`.
`void`	`addValues(String field, Date... values)` Add `Date` `values` to `field`.
`void`	`addValues(String field, Document... values)` Add `Document` `values` to `field`.
`void`	`addValues(String field, Number... values)` Add `numeric` `values` to `field`.
`void`	`addValues(String field, Point... values)` Add `Point` `values` to `field`.
`void`	`addValues(String field, Shape... values)` Add `Shape` `values` to `field`.
`void`	`addValues(String field, String... values)` Add `String` `values` to `field`.
`void`	`clear()` Remove all fields and attributes.
`IngestDocument`	`clone()`
`boolean`	`containsField(String name)` Get if this document contains `field`.
`void`	`ensureCapacity()`
`boolean`	`equals(Object other)`
`AttivioAcl`	`getAcl()` Get the `AttivioAcl` for this document.
`UUID`	`getCorrelationId()` Get the correlation ID for this document.
`long`	`getEstimatedSize()` Get the estimated size of the document in bytes.
`IngestField`	`getField(String field)` Get a `field` or null if `field` does not exist.
`Iterable<String>`	`getFieldNames()` Return an `Iterable` for iterating over all unique field names.
`IngestFieldValue`	`getFirstValue(String field)` Get the first `IngestFieldValue` for `field` or null if the field does not exist.
`AttivioGroupMembership`	`getGroupMembership()` Get the `AttivioGroupMembership` for this document.
`String`	`getId()` Get the unique document id.
`Locale`	`getLocale()` Get the `Locale` for this field.
`DocumentMode`	`getMode()` Gets the mode for ingesting this document.
`AttivioPrincipal`	`getPrincipal()` Get the `AttivioPrincipal` for this document.
`String`	`getZone()` Get the zone for this document.
`int`	`hashCode()`
`void`	`importFields(IngestDocument doc)` Import all fields into this document.
`Iterator<IngestField>`	`iterator()` Get an iterator for iterating over all `fields`.
`void`	`removeField(String name)` Remove a field by `name`.
`void`	`renameField(String oldName, String newName)` Rename a field.
`void`	`setAcl(AttivioAcl value)` Set the `AttivioAcl` for this document.
`void`	`setCorrelationId(UUID value)` Set the correlation ID for this document.
`void`	`setField(IngestField field)` Set a `field` for this document.
`void`	`setField(String field, Boolean... values)` Set the `values` for a `field`.
`void`	`setField(String field, ContentPointer... values)` Set the `values` for a `field`.
`void`	`setField(String field, Date... values)` Set the `values` for a `field`.
`void`	`setField(String field, Document... values)` Set the `values` for a `field`.
`void`	`setField(String field, Number... values)` Set the `values` for a `field`.
`void`	`setField(String field, Point... values)` Set the `values` for a `field`.
`void`	`setField(String field, Shape... values)` Set the `values` for a `field`.
`void`	`setField(String field, String... values)` Set the `values` for a `field`.
`void`	`setGroupMembership(AttivioGroupMembership value)` Set the `AttivioGroupMembership` for this document.
`void`	`setId(String value)` Set the unique document id.
`void`	`setLocale(Locale value)` Set the `Locale` for this field.
`void`	`setMode(DocumentMode value)` Gets the mode for ingesting this document.
`void`	`setPrincipal(AttivioPrincipal value)` Set the `AttivioPrincipal` for this document.
`void`	`setZone(String value)` Set the zone for this document.
`int`	`size()` Get the number of fields in this document.
`String`	`toString()`

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

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

Field Detail

DEFAULT_DOCUMENT_MODE

public static final DocumentMode DEFAULT_DOCUMENT_MODE

Constructor Detail

IngestDocument
```
public IngestDocument(String id)
```
Construct a new IngestDocument.

IngestDocument

public IngestDocument(String id,
                      DocumentMode mode)

Construct a new IngestDocument.

Method Detail

getId
```
public String getId()
```
Get the unique document id.

setId
```
public void setId(String value)
```
Set the unique document id.

getCorrelationId
```
public UUID getCorrelationId()
```
Get the correlation ID for this document.
The correlation ID is used to tie different instances of the same document sent in back to their original source.

setCorrelationId
```
public void setCorrelationId(UUID value)
```
Set the correlation ID for this document.
WARNING: internal use only. The correlation ID is set by the system and should not be modified by client code.

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

getMode
```
public DocumentMode getMode()
```
Gets the mode for ingesting this document.

setMode
```
public void setMode(DocumentMode value)
```
Gets the mode for ingesting this document.

getAcl
```
public AttivioAcl getAcl()
```
Get the AttivioAcl for this document.

setAcl
```
public void setAcl(AttivioAcl value)
```
Set the AttivioAcl for this document.

getPrincipal
```
public AttivioPrincipal getPrincipal()
```
Get the AttivioPrincipal for this document.

setPrincipal

public void setPrincipal(AttivioPrincipal value)

Set the AttivioPrincipal for this document.

getGroupMembership
```
public AttivioGroupMembership getGroupMembership()
```
Get the AttivioGroupMembership for this document.

setGroupMembership

public void setGroupMembership(AttivioGroupMembership value)

Set the AttivioGroupMembership for this document.

getZone
```
public String getZone()
```
Get the zone for this document.
If set the zone acts as a composite key with the value of getId().

setZone
```
public void setZone(String value)
```
Set the zone for this document.

size
```
public int size()
```
Get the number of fields in this document.

containsField
```
public boolean containsField(String name)
```
Get if this document contains field.

getFieldNames
```
public Iterable<String> getFieldNames()
```
Return an Iterable for iterating over all unique field names.

iterator
```
public Iterator<IngestField> iterator()
```
Get an iterator for iterating over all fields.

Specified by:

iterator in interface Iterable<IngestField>

clear
```
public void clear()
```
Remove all fields and attributes.

getField
```
public IngestField getField(String field)
```
Get a field or null if field does not exist.
NOTE: if the field exists, but contains no field values, null will be returned.

renameField

public void renameField(String oldName,
                        String newName)

Rename a field.

If the field does not exist no action is taken.

removeField
```
public void removeField(String name)
```
Remove a field by name.
Will have no effect if field does not exist.

importFields
```
public void importFields(IngestDocument doc)
```
Import all fields into this document.
Fields and FieldValues will be deep cloned.

getFirstValue
```
public IngestFieldValue getFirstValue(String field)
```
Get the first IngestFieldValue for field or null if the field does not exist.

setField
```
public void setField(IngestField field)
```
Set a field for this document.
If a field already exists with the same name, it will be replaced.