IngestFieldValue (platform/sdk 5.5.1.0-SNAPSHOT API)

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

All Implemented Interfaces:

LocaleAware, Serializable, Cloneable
```
public class IngestFieldValue
extends Object
implements Cloneable, Serializable, LocaleAware
```
A field value for an IngestDocument.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected Serializable value

Fields
Modifier and Type	Field and Description
`protected Serializable`	`value`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`IngestFieldValue()`
	`IngestFieldValue(Boolean value)` Construct a new IngestFieldValue with a `Boolean` value.
	`IngestFieldValue(ContentPointer value)` Construct a new IngestFieldValue with a `ContentPointer` value.
	`IngestFieldValue(Date value)` Construct a new IngestFieldValue with a `Date` value.
	`IngestFieldValue(Document value)` Construct a new IngestFieldValue with a `Document` value.
	`IngestFieldValue(Number value)` Construct a new IngestFieldValue with a `Number` value.
	`IngestFieldValue(Point value)` Construct a new IngestFieldValue with a `Point` value.
`protected`	`IngestFieldValue(Serializable value)`
	`IngestFieldValue(Shape value)` Construct a new IngestFieldValue with a `Shape` value.
	`IngestFieldValue(String value)` Construct a new IngestFieldValue with a `String` value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`booleanValue()` Gets the value as a `boolean`.
`IngestFieldValue`	`clone()`
`ContentPointer`	`contentPointerValue()` Gets the value as a `ContentPointer`.
`Date`	`dateValue()` Gets the value as a `Date`.
`BigDecimal`	`decimalValue()` Gets the value as a `BigDecimal`.
`double`	`doubleValue()` Gets the value as a `double`.
`boolean`	`equals(Object other)`
`float`	`floatValue()` Gets the value as a `float`.
`long`	`getEstimatedSize()` Get the estimated size of this field in bytes.
`Locale`	`getLocale()` Get the value's locale (or null if not known).
`TokenList`	`getTokenList()` Get the `TokenList` for this value.
`Object`	`getValue()` Get the field value.
`int`	`hashCode()`
`int`	`intValue()` Gets the value as an `int`.
`long`	`longValue()` Gets the value as a `long`.
`Point`	`pointValue()` Gets the value as a `Point`.
`void`	`setLocale(Locale value)` Set the value's locale.
`void`	`setTokenList(TokenList value)` Set the `TokenList` for this value.
`void`	`setValue(Boolean value)` Set a `Boolean` value.
`void`	`setValue(ContentPointer value)` Set a `ContentPointer` value.
`void`	`setValue(Date value)` Set a `Date` value.
`void`	`setValue(Document value)` Set a `Document` value.
`void`	`setValue(Number value)` Set a `numeric` value.
`void`	`setValue(Point value)` Set a `Point` value.
`void`	`setValue(Shape value)` Set a `Shape` value.
`void`	`setValue(String value)` Set a `String` value.
`protected void`	`setValueInternal(Serializable newValue)`
`Shape`	`shapeValue()` Gets the value as a `Shape`.
`String`	`stringValue()` Gets the value as a string.
`String`	`toString()`
`boolean`	`valueEquals(Object other)` Returns `true` if `other` equals this `IngestFieldValue`'s value.
`static IngestFieldValue`	`valueOf(Object value)` Get an `IngestFieldValue` for `value`.
`Document`	`xmlValue()` Gets the value as a `Document`.

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

- Field Detail
  - value
```
protected Serializable value
```
- Constructor Detail
  - IngestFieldValue
```
protected IngestFieldValue()
```
  - IngestFieldValue
```
protected IngestFieldValue(Serializable value)
```
  - IngestFieldValue
```
public IngestFieldValue(String value)
```
    Construct a new IngestFieldValue with a String value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - IngestFieldValue
```
public IngestFieldValue(Number value)
```
    Construct a new IngestFieldValue with a Number value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - IngestFieldValue
```
public IngestFieldValue(Date value)
```
    Construct a new IngestFieldValue with a Date value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - IngestFieldValue
```
public IngestFieldValue(Boolean value)
```
    Construct a new IngestFieldValue with a Boolean value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - IngestFieldValue
```
public IngestFieldValue(Point value)
```
    Construct a new IngestFieldValue with a Point value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - IngestFieldValue
```
public IngestFieldValue(Shape value)
```
    Construct a new IngestFieldValue with a Shape value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - IngestFieldValue
```
public IngestFieldValue(ContentPointer value)
```
    Construct a new IngestFieldValue with a ContentPointer value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - IngestFieldValue
```
public IngestFieldValue(Document value)
```
    Construct a new IngestFieldValue with a Document value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
- Method Detail
  - getEstimatedSize
```
public long getEstimatedSize()
```
    Get the estimated size of this field in bytes.
    NOTE: Includes size of remote content pointers.
  - getLocale
```
public final Locale getLocale()
```
    Get the value's locale (or null if not known).
    This locale will be used for per-language linguistic processing.
    
    Specified by:
    
    getLocale in interface LocaleAware
  - setLocale
```
public void setLocale(Locale value)
```
    Set the value's locale.
    
    Specified by:
    
    setLocale in interface LocaleAware
  - getTokenList
```
public TokenList getTokenList()
```
    Get the TokenList for this value.
  - setTokenList
```
public void setTokenList(TokenList value)
```
    Set the TokenList for this value.
  - getValue
```
public Object getValue()
```
    Get the field value.
  - stringValue
```
public String stringValue()
```
    Gets the value as a string.
  - intValue
```
public int intValue()
```
    Gets the value as an int.
    
    Throws:
    
    IllegalArgumentException - if this value cannot be represented as an int.
  - longValue
```
public long longValue()
```
    Gets the value as a long.
    
    Throws:
    
    IllegalArgumentException - if this value cannot be represented as a long.
  - doubleValue
```
public double doubleValue()
```
    Gets the value as a double.
    
    Throws:
    
    IllegalArgumentException - if this value cannot be represented as a double.
  - floatValue
```
public float floatValue()
```
    Gets the value as a float.
    
    Throws:
    
    IllegalArgumentException - if this value cannot be represented as a float.
  - booleanValue
```
public boolean booleanValue()
```
    Gets the value as a boolean.
    
    Throws:
    
    IllegalArgumentException - if this value cannot be represented as a boolean.
  - dateValue
```
public Date dateValue()
```
    Gets the value as a Date.
    
    Throws:
    
    IllegalArgumentException - if this value cannot be represented as a Date.
  - decimalValue
```
public BigDecimal decimalValue()
```
    Gets the value as a BigDecimal.
    
    Throws:
    
    IllegalArgumentException - if this value cannot be represented as a BigDecimal.
  - pointValue
```
public Point pointValue()
```
    Gets the value as a Point.
    
    Throws:
    
    IllegalArgumentException - if this value cannot be represented as a Point.
  - shapeValue
```
public Shape shapeValue()
```
    Gets the value as a Shape.
    
    Throws:
    
    IllegalArgumentException - if this value cannot be represented as a Shape.
  - contentPointerValue
```
public ContentPointer contentPointerValue()
```
    Gets the value as a ContentPointer.
    
    Throws:
    
    IllegalArgumentException - if this value cannot be represented as a ContentPointer.
  - xmlValue
```
public Document xmlValue()
```
    Gets the value as a Document.
    
    Throws:
    
    IllegalArgumentException - if this value cannot be represented as a Document.
  - setValue
```
public void setValue(String value)
```
    Set a String value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - setValue
```
public void setValue(Number value)
```
    Set a numeric value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - setValue
```
public void setValue(Date value)
```
    Set a Date value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - setValue
```
public void setValue(Boolean value)
```
    Set a Boolean value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - setValue
```
public void setValue(Point value)
```
    Set a Point value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - setValue
```
public void setValue(Shape value)
```
    Set a Shape value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - setValue
```
public void setValue(ContentPointer value)
```
    Set a ContentPointer value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - setValue
```
public void setValue(Document value)
```
    Set a Document value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - setValueInternal
```
protected void setValueInternal(Serializable newValue)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - valueEquals
```
public boolean valueEquals(Object other)
```
    Returns true if other equals this IngestFieldValue's value.
  - clone
```
public IngestFieldValue clone()
```
    Overrides:
    
    clone in class Object
  - valueOf
```
public static IngestFieldValue valueOf(Object value)
```
    Get an IngestFieldValue for value.
    NOTE: returns null if value is null.
    
    Throws:
    
    IllegalArgumentException - if value is not a legal value.

Class IngestFieldValue

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

value

Constructor Detail

IngestFieldValue

IngestFieldValue

IngestFieldValue

IngestFieldValue

IngestFieldValue

IngestFieldValue

IngestFieldValue

IngestFieldValue

IngestFieldValue

IngestFieldValue

Method Detail

getEstimatedSize

getLocale

setLocale

getTokenList

setTokenList

getValue

stringValue

intValue

longValue

doubleValue

floatValue

booleanValue

dateValue

decimalValue

pointValue

shapeValue

contentPointerValue

xmlValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValueInternal

hashCode

toString

equals

valueEquals

clone

valueOf