Package com.attivio.sdk.ingest

Class IngestFieldValue

  • All Implemented Interfaces:
    LocaleAware, java.io.Serializable, java.lang.Cloneable
    public class IngestFieldValue
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable, LocaleAware
    A field value for an IngestDocument.
    See Also:
    Serialized Form

    • Field Detail

      • value

        protected java.io.Serializable value

    • Constructor Detail

      • IngestFieldValue

        protected IngestFieldValue()

      • IngestFieldValue

        protected IngestFieldValue​(java.io.Serializable value)

      • IngestFieldValue

        public IngestFieldValue​(java.lang.String value)
        Construct a new IngestFieldValue with a String value.
        Throws:
        java.lang.IllegalArgumentException - if value is null.

      • IngestFieldValue

        public IngestFieldValue​(java.lang.Number value)
        Construct a new IngestFieldValue with a Number value.
        Throws:
        java.lang.IllegalArgumentException - if value is null.

      • IngestFieldValue

        public IngestFieldValue​(java.util.Date value)
        Construct a new IngestFieldValue with a Date value.
        Throws:
        java.lang.IllegalArgumentException - if value is null.

      • IngestFieldValue

        public IngestFieldValue​(java.lang.Boolean value)
        Construct a new IngestFieldValue with a Boolean value.
        Throws:
        java.lang.IllegalArgumentException - if value is null.

      • IngestFieldValue

        public IngestFieldValue​(Point value)
        Construct a new IngestFieldValue with a Point value.
        Throws:
        java.lang.IllegalArgumentException - if value is null.

      • IngestFieldValue

        public IngestFieldValue​(Shape value)
        Construct a new IngestFieldValue with a Shape value.
        Throws:
        java.lang.IllegalArgumentException - if value is null.

      • IngestFieldValue

        public IngestFieldValue​(ContentPointer value)
        Construct a new IngestFieldValue with a ContentPointer value.
        Throws:
        java.lang.IllegalArgumentException - if value is null.

      • IngestFieldValue

        public IngestFieldValue​(org.w3c.dom.Document value)
        Construct a new IngestFieldValue with a Document value.
        Throws:
        java.lang.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 java.util.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​(java.util.Locale value)
        Set the value's locale.
        Specified by:
        setLocale in interface LocaleAware

      • setTokenList

        public void setTokenList​(TokenList value)
        Set the TokenList for this value.

      • getValue

        public java.lang.Object getValue()
        Get the field value.

      • stringValue

        public java.lang.String stringValue()
        Gets the value as a string.

      • intValue

        public int intValue()
        Gets the value as an int.
        Throws:
        java.lang.IllegalArgumentException - if this value cannot be represented as an int.

      • longValue

        public long longValue()
        Gets the value as a long.
        Throws:
        java.lang.IllegalArgumentException - if this value cannot be represented as a long.

      • doubleValue

        public double doubleValue()
        Gets the value as a double.
        Throws:
        java.lang.IllegalArgumentException - if this value cannot be represented as a double.

      • floatValue

        public float floatValue()
        Gets the value as a float.
        Throws:
        java.lang.IllegalArgumentException - if this value cannot be represented as a float.

      • booleanValue

        public boolean booleanValue()
        Gets the value as a boolean.
        Throws:
        java.lang.IllegalArgumentException - if this value cannot be represented as a boolean.

      • dateValue

        public java.util.Date dateValue()
        Gets the value as a Date.
        Throws:
        java.lang.IllegalArgumentException - if this value cannot be represented as a Date.

      • decimalValue

        public java.math.BigDecimal decimalValue()
        Gets the value as a BigDecimal.
        Throws:
        java.lang.IllegalArgumentException - if this value cannot be represented as a BigDecimal.

      • pointValue

        public Point pointValue()
        Gets the value as a Point.
        Throws:
        java.lang.IllegalArgumentException - if this value cannot be represented as a Point.

      • shapeValue

        public Shape shapeValue()
        Gets the value as a Shape.
        Throws:
        java.lang.IllegalArgumentException - if this value cannot be represented as a Shape.

      • xmlValue

        public org.w3c.dom.Document xmlValue()
        Gets the value as a Document.
        Throws:
        java.lang.IllegalArgumentException - if this value cannot be represented as a Document.

      • setValue

        public void setValue​(java.lang.String value)
        Set a String value.
        Throws:
        java.lang.IllegalArgumentException - if value is null.

      • setValue

        public void setValue​(java.lang.Number value)
        Set a numeric value.
        Throws:
        java.lang.IllegalArgumentException - if value is null.

      • setValue

        public void setValue​(java.util.Date value)
        Set a Date value.
        Throws:
        java.lang.IllegalArgumentException - if value is null.

      • setValue

        public void setValue​(java.lang.Boolean value)
        Set a Boolean value.
        Throws:
        java.lang.IllegalArgumentException - if value is null.

      • setValue

        public void setValue​(Point value)
        Set a Point value.
        Throws:
        java.lang.IllegalArgumentException - if value is null.

      • setValue

        public void setValue​(Shape value)
        Set a Shape value.
        Throws:
        java.lang.IllegalArgumentException - if value is null.

      • setValue

        public void setValue​(ContentPointer value)
        Set a ContentPointer value.
        Throws:
        java.lang.IllegalArgumentException - if value is null.

      • setValue

        public void setValue​(org.w3c.dom.Document value)
        Set a Document value.
        Throws:
        java.lang.IllegalArgumentException - if value is null.

      • setValueInternal

        protected void setValueInternal​(java.io.Serializable newValue)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • valueEquals

        public boolean valueEquals​(java.lang.Object other)
        Returns true if other equals this IngestFieldValue's value.

      • clone

        public IngestFieldValue clone()
        Overrides:
        clone in class java.lang.Object

      • valueOf

        public static IngestFieldValue valueOf​(java.lang.Object value)
        Get an IngestFieldValue for value.

        NOTE: returns null if value is null.

        Throws:
        java.lang.IllegalArgumentException - if value is not a legal value.