SearchDocument (platform/sdk 5.5.1.0-SNAPSHOT API)

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

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Iterable<SearchField>
```
public class SearchDocument
extends Object
implements Iterable<SearchField>, Cloneable, Externalizable
```
A document returned from a search.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SearchDocument()
Construct a new SearchDocument.

SearchDocument(String id)
Construct a new SearchDocument with an id.

Constructors
Constructor and Description
`SearchDocument()` Construct a new SearchDocument.
`SearchDocument(String id)` Construct a new SearchDocument with an `id`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChildDocument(SearchDocument value)` Add a child document.
`void`	`addValue(String field, Boolean value)` Add a `Boolean` value to `field`.
`void`	`addValue(String field, Date value)` Add a `Date` value to `field`.
`void`	`addValue(String field, Number value)` Add a `numeric` value to `field`.
`void`	`addValue(String field, Point value)` Add a `Point` value to `field`.
`void`	`addValue(String field, SearchFieldValue value)` Add a `value` to `field`.
`void`	`addValue(String field, Shape value)` Add a `Shape` value to `field`.
`void`	`addValue(String field, String value)` Add a `String` value to `field`.
`void`	`addValues(String field, Boolean... values)` Add `Boolean` `values` to `field`.
`void`	`addValues(String field, Date... values)` Add `Date` `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 child documents.
`SearchDocument`	`clone()`
`boolean`	`containsChildDocuments()` Get if this document contains child records.
`boolean`	`containsField(String field)` Get if this document contains `field`.
`boolean`	`equals(Object other)`
`SearchDocument`	`getChildDocument(int index)` Get a child document by `index`.
`int`	`getChildDocumentCount()` Get the number of attached child documents.
`Iterable<SearchDocument>`	`getChildDocuments()` Get all of the available child documents.
`RelevancyFeatureVector`	`getFeatures()` Get the feature vector for relevancy components.
`SearchField`	`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.
`SearchFieldValue`	`getFirstValue(String field)` Get the first `SearchFieldValue` for `field` or null if the field does not exist.
`String`	`getId()` The unique document id.
`float`	`getScore()` Get the document's score.
`long`	`getTotalChildren()` Get the total number of child documents available or `-1` if this count is not known or was not calculated.
`String`	`getZone()` Get the zone this document is in
`int`	`hashCode()`
`Iterator<SearchField>`	`iterator()` Get an iterator for iterating over all `fields`.
`void`	`readExternal(ObjectInput in)`
`void`	`removeField(String field)` Remove a `field` from the document.
`void`	`renameField(String oldName, String newName)` Rename a field.
`void`	`setChildDocuments(Iterable<SearchDocument> value)` Set the child documents.
`void`	`setChildDocuments(SearchDocument... value)` Set the child documents.
`void`	`setFeatures(RelevancyFeatureVector value)` Set the feature vector for relevancy components.
`void`	`setField(SearchField field)` Set a `field` for this document.
`void`	`setTotalChildren(long value)` Set the total number of child documents available.
`int`	`size()` Get the number of fields in this document.
`String`	`toString()`
`protected void`	`toString(StringBuilder buffer, int depth)`
`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
  - SearchDocument
```
public SearchDocument()
```
    Construct a new SearchDocument.
  - SearchDocument
```
public SearchDocument(String id)
```
    Construct a new SearchDocument with an id.
- Method Detail
  - getId
```
public String getId()
```
    The unique document id.
    NOTE: the document id may not be populated for SearchDocuments if not requested. If not populated, an empty string will be returned.
  - getZone
```
public String getZone()
```
    Get the zone this document is in
    NOTE: the zone name may not be populated for SearchDocuments if not requested. If not populated, null will be returned.
  - getFeatures
```
public RelevancyFeatureVector getFeatures()
```
    Get the feature vector for relevancy components.
  - setFeatures
```
public void setFeatures(RelevancyFeatureVector value)
```
    Set the feature vector for relevancy components.
  - getScore
```
public float getScore()
```
    Get the document's score.
    NOTE: May return 0.0f if no score was computed, or if score was requested with custom field name.
    
    Throws:
    
    IllegalArgumentException - if field named FieldNames.SCORE contains non-numeric values.
  - size
```
public int size()
```
    Get the number of fields in this document.
  - getFieldNames
```
public Iterable<String> getFieldNames()
```
    Return an Iterable for iterating over all unique field names.
  - iterator
```
public Iterator<SearchField> iterator()
```
    Get an iterator for iterating over all fields.
    
    Specified by:
    
    iterator in interface Iterable<SearchField>
  - containsField
```
public boolean containsField(String field)
```
    Get if this document contains field.
  - getField
```
public SearchField 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.
  - setField
```
public void setField(SearchField field)
```
    Set a field for this document.
    If a field already exists with the same name, it will be replaced.
  - getFirstValue
```
public SearchFieldValue getFirstValue(String field)
```
    Get the first SearchFieldValue for field or null if the field does not exist.
  - 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 field)
```
    Remove a field from the document.
  - clear
```
public void clear()
```
    Remove all fields and child documents.
  - addValues
```
public void addValues(String field,
                      String... values)
```
    Add String values to field.
  - addValues
```
public void addValues(String field,
                      Number... values)
```
    Add numeric values to field.
  - addValues
```
public void addValues(String field,
                      Date... values)
```
    Add Date values to field.
  - addValues
```
public void addValues(String field,
                      Boolean... values)
```
    Add Boolean values to field.
  - addValues
```
public void addValues(String field,
                      Point... values)
```
    Add Point values to field.
  - addValues
```
public void addValues(String field,
                      Shape... values)
```
    Add Shape values to field.
  - addValue
```
public void addValue(String field,
                     SearchFieldValue value)
```
    Add a value to field.
  - addValue
```
public void addValue(String field,
                     String value)
```
    Add a String value to field.
  - addValue
```
public void addValue(String field,
                     Number value)
```
    Add a numeric value to field.
  - addValue
```
public void addValue(String field,
                     Date value)
```
    Add a Date value to field.
  - addValue
```
public void addValue(String field,
                     Boolean value)
```
    Add a Boolean value to field.
  - addValue
```
public void addValue(String field,
                     Point value)
```
    Add a Point value to field.
  - addValue
```
public void addValue(String field,
                     Shape value)
```
    Add a Shape value to field.
  - getTotalChildren
```
public long getTotalChildren()
```
    Get the total number of child documents available or -1 if this count is not known or was not calculated.
    NOTE: the is the total number of possible child documents. Use getChildDocumentCount() to get the actual number of child documents returned with this SearchDocument.
  - setTotalChildren
```
public void setTotalChildren(long value)
```
    Set the total number of child documents available.
  - containsChildDocuments
```
public boolean containsChildDocuments()
```
    Get if this document contains child records.
  - getChildDocumentCount
```
public int getChildDocumentCount()
```
    Get the number of attached child documents.
  - getChildDocument
```
public SearchDocument getChildDocument(int index)
```
    Get a child document by index.
    
    Throws:
    
    IndexOutOfBoundsException - if child document at index is not available.
  - getChildDocuments
```
public Iterable<SearchDocument> getChildDocuments()
```
    Get all of the available child documents.
  - setChildDocuments
```
public void setChildDocuments(SearchDocument... value)
```
    Set the child documents.
  - setChildDocuments
```
public void setChildDocuments(Iterable<SearchDocument> value)
```
    Set the child documents.
  - addChildDocument
```
public void addChildDocument(SearchDocument value)
```
    Add a child document.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toString
```
protected void toString(StringBuilder buffer,
                        int depth)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - clone
```
public SearchDocument 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 SearchDocument

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

SearchDocument

SearchDocument

Method Detail

getId

getZone

getFeatures

setFeatures

getScore

size

getFieldNames

iterator

containsField

getField

setField

getFirstValue

renameField

removeField

clear

addValues

addValues

addValues

addValues

addValues

addValues

addValue

addValue

addValue

addValue

addValue

addValue

addValue

getTotalChildren

setTotalChildren

containsChildDocuments

getChildDocumentCount

getChildDocument

getChildDocuments

setChildDocuments

setChildDocuments

addChildDocument

toString

toString

hashCode

equals

clone

readExternal

writeExternal