SearchFieldValue (platform/sdk 5.5.1.0-SNAPSHOT API)

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

All Implemented Interfaces:

Externalizable, Serializable, Cloneable
```
public class SearchFieldValue
extends Object
implements Cloneable, Externalizable
```
A field value for a SearchDocument.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`SearchFieldValue()`
`SearchFieldValue(Boolean value)` Construct a new SearchFieldValue with a `Boolean` value.
`SearchFieldValue(Date value)` Construct a new SearchFieldValue with a `Date` value.
`SearchFieldValue(Number value)` Construct a new SearchFieldValue with a `numeric` value.
`SearchFieldValue(Point value)` Construct a new SearchFieldValue with a `Point` value.
`SearchFieldValue(Shape value)` Construct a new SearchFieldValue with a `Shape` value.
`SearchFieldValue(String value)` Construct a new SearchFieldValue 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`.
`SearchFieldValue`	`clone()`
`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`.
`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`.
`SearchFieldValue`	`readExternal(DataInput in)`
`void`	`readExternal(ObjectInput in)`
`void`	`setValue(Boolean value)` Set a `Boolean` value.
`void`	`setValue(Date value)` Set a `Date` 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.
`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 `SearchFieldValue`'s value.
`static SearchFieldValue`	`valueOf(Object value)` Get a `SearchFieldValue` for `value`.
`void`	`writeExternal(DataOutput out)`
`void`	`writeExternal(ObjectOutput out)`

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

- Constructor Detail
  - SearchFieldValue
```
public SearchFieldValue()
```
  - SearchFieldValue
```
public SearchFieldValue(String value)
```
    Construct a new SearchFieldValue with a String value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - SearchFieldValue
```
public SearchFieldValue(Number value)
```
    Construct a new SearchFieldValue with a numeric value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - SearchFieldValue
```
public SearchFieldValue(Date value)
```
    Construct a new SearchFieldValue with a Date value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - SearchFieldValue
```
public SearchFieldValue(Boolean value)
```
    Construct a new SearchFieldValue with a Boolean value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - SearchFieldValue
```
public SearchFieldValue(Point value)
```
    Construct a new SearchFieldValue with a Point value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - SearchFieldValue
```
public SearchFieldValue(Shape value)
```
    Construct a new SearchFieldValue with a Shape value.
    
    Throws:
    
    IllegalArgumentException - if value is null.
- Method Detail
  - 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.
  - dateValue
```
public Date dateValue()
```
    Gets the value as a Date.
    
    Throws:
    
    IllegalArgumentException - if this value cannot be represented as a Date.
  - booleanValue
```
public boolean booleanValue()
```
    Gets the value as a boolean.
    
    Throws:
    
    IllegalArgumentException - if this value cannot be represented as a boolean.
  - 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.
  - decimalValue
```
public BigDecimal decimalValue()
```
    Gets the value as a BigDecimal.
    
    Throws:
    
    IllegalArgumentException - if this value cannot be represented as a BigDecimal.
  - 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.
  - 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
  - valueEquals
```
public boolean valueEquals(Object other)
```
    Returns true if other equals this SearchFieldValue's value.
  - clone
```
public SearchFieldValue clone()
```
    Overrides:
    
    clone in class Object
  - valueOf
```
public static SearchFieldValue valueOf(Object value)
```
    Get a SearchFieldValue for value.
    NOTE: returns null if value is null.
    
    Throws:
    
    IllegalArgumentException - if value is not a legal value.
  - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException
```
    Specified by:
    
    readExternal in interface Externalizable
    
    Throws:
    
    IOException
  - readExternal
```
public SearchFieldValue readExternal(DataInput in)
                              throws IOException
```
    Throws:
    
    IOException
  - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
    Specified by:
    
    writeExternal in interface Externalizable
    
    Throws:
    
    IOException
  - writeExternal
```
public void writeExternal(DataOutput out)
                   throws IOException
```
    Throws:
    
    IOException

Class SearchFieldValue

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SearchFieldValue

SearchFieldValue

SearchFieldValue

SearchFieldValue

SearchFieldValue

SearchFieldValue

SearchFieldValue

Method Detail

getValue

stringValue

intValue

longValue

doubleValue

floatValue

dateValue

booleanValue

pointValue

shapeValue

decimalValue

setValue

setValue

setValue

setValue

setValue

setValue

toString

hashCode

equals

valueEquals

clone

valueOf

readExternal

readExternal

writeExternal

writeExternal