Package com.attivio.sdk.search

Class SearchField

  • All Implemented Interfaces:
    java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<SearchFieldValue>
    public class SearchField
extends java.lang.Object
implements java.lang.Iterable<SearchFieldValue>, java.io.Externalizable, java.lang.Cloneable
    A list of field values for a SearchDocument.
    See Also:
    Serialized Form

    • Constructor Detail

      • SearchField

        public SearchField()

      • SearchField

        public SearchField​(java.lang.String name)
        Construct a new SearchField.

    • Method Detail

      • getName

        public java.lang.String getName()
        Get the name of the field.

      • size

        public int size()
        Get the number of field values.

      • getFirstValue

        public SearchFieldValue getFirstValue()
        Gets the first field value.

        NOTE: may return null if this field has no values.

      • iterator

        public java.util.ListIterator<SearchFieldValue> iterator()
        Get an iterator for iterating over all values.
        Specified by:
        iterator in interface java.lang.Iterable<SearchFieldValue>

      • forEach

        public void forEach​(java.util.function.Consumer<? super SearchFieldValue> consumer)
        Specified by:
        forEach in interface java.lang.Iterable<SearchFieldValue>

      • clear

        public void clear()
        Remove all values.

      • removeValue

        public void removeValue​(java.lang.Object value)
        Remove a field value.

      • addValues

        public void addValues​(java.lang.String... values)
        Add String values to this SearchField.

      • addValues

        public void addValues​(java.lang.Number... values)
        Add numeric values to this SearchField.

      • addValues

        public void addValues​(java.util.Date... values)
        Add Date values to this SearchField.

      • addValues

        public void addValues​(java.lang.Boolean... values)
        Add Boolean values to this SearchField.

      • addValue

        public void addValue​(java.lang.String value)
        Add a String value to this SearchField.

      • addValue

        public void addValue​(java.lang.Number value)
        Add a numeric value to this SearchField.

      • addValue

        public void addValue​(java.util.Date value)
        Add a Date value to this SearchField.

      • addValue

        public void addValue​(java.lang.Boolean value)
        Add a Boolean value to this SearchField.

      • toString

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

      • hashCode

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

      • equals

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

      • clone

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

      • readExternal

        public void readExternal​(java.io.ObjectInput in)
                  throws java.io.IOException
        Specified by:
        readExternal in interface java.io.Externalizable
        Throws:
        java.io.IOException

      • writeExternal

        public void writeExternal​(java.io.ObjectOutput out)
                   throws java.io.IOException
        Specified by:
        writeExternal in interface java.io.Externalizable
        Throws:
        java.io.IOException