Sort (EXALEAD CloudView Custom code SDK)

java.lang.Object
- com.exalead.search.v30.Sort

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable
```
public class Sort
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable
```
No documentation for this element.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`ascending`
`static boolean`	`DEFAULT_ASCENDING`
`static boolean`	`DEFAULT_HAS_INVALID_VALUE`
`static int`	`DEFAULT_L_S_B`
`static int`	`DEFAULT_M_S_B`
`static boolean`	`DEFAULT_SECONDARY_SORT_KEY`
`boolean`	`hasInvalidValue`
`java.lang.String`	`indexField`
`long`	`invalidValue`
`int`	`LSB`
`int`	`MSB`
`boolean`	`secondarySortKey`

Constructor Summary

Constructors
Constructor and Description

Sort()

Sort(Sort o)
Copy constructor

Constructors
Constructor and Description
`Sort()`
`Sort(Sort o)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this Sort.
`static Sort`	`fromString(java.lang.String s)` String representation of this Sort.
`java.lang.String`	`getIndexField()` Index field on which we want to sort. You can only sort on an unsigned index field.
`long`	`getInvalidValue()` If hasInvalidValue is true, what is the invalid value?
`int`	`getLSB()` Least Significant Bit of the key inside the field.
`int`	`getMSB()` Most Significant Bit of the key inside the field.
`boolean`	`isAscending()` Inverse the total order relation.
`boolean`	`isHasInvalidValue()` Should one of the keys be considered as excluded from the set and always put at the end
`boolean`	`isSecondarySortKey()` Allows disambiguating documents having the same score, on a configurable key.
`Sort`	`makeCopy()` Creates and returns a deep copy of this Sort.
`static Sort`	`readFrom(java.io.InputStream is)` Read this Sort from an XML fragment.
`void`	`setAscending(boolean ascending)` Inverse the total order relation.
`void`	`setHasInvalidValue(boolean hasInvalidValue)` Should one of the keys be considered as excluded from the set and always put at the end
`void`	`setIndexField(java.lang.String indexField)` Index field on which we want to sort. You can only sort on an unsigned index field.
`void`	`setInvalidValue(long invalidValue)` If hasInvalidValue is true, what is the invalid value?
`void`	`setLSB(int LSB)` Least Significant Bit of the key inside the field.
`void`	`setMSB(int MSB)` Most Significant Bit of the key inside the field.
`void`	`setSecondarySortKey(boolean secondarySortKey)` Allows disambiguating documents having the same score, on a configurable key.
`java.lang.String`	`toString()` String representation of this Sort.
`Sort`	`withAscending(boolean ascending)`
`Sort`	`withAscending(java.lang.Boolean ascending)`
`Sort`	`withHasInvalidValue(boolean hasInvalidValue)`
`Sort`	`withHasInvalidValue(java.lang.Boolean hasInvalidValue)`
`Sort`	`withIndexField(java.lang.String indexField)`
`Sort`	`withInvalidValue(long invalidValue)`
`Sort`	`withInvalidValue(java.lang.Long invalidValue)`
`Sort`	`withLSB(int LSB)`
`Sort`	`withLSB(java.lang.Integer LSB)`
`Sort`	`withMSB(int MSB)`
`Sort`	`withMSB(java.lang.Integer MSB)`
`Sort`	`withSecondarySortKey(boolean secondarySortKey)`
`Sort`	`withSecondarySortKey(java.lang.Boolean secondarySortKey)`
`void`	`writeTo(java.io.OutputStream os)` Write this Sort as an XML fragment

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

- Field Detail
  - secondarySortKey
```
public boolean secondarySortKey
```
  - DEFAULT_SECONDARY_SORT_KEY
```
public static final boolean DEFAULT_SECONDARY_SORT_KEY
```
    See Also:
    
    Constant Field Values
  - indexField
```
public java.lang.String indexField
```
  - ascending
```
public boolean ascending
```
  - DEFAULT_ASCENDING
```
public static final boolean DEFAULT_ASCENDING
```
    See Also:
    
    Constant Field Values
  - LSB
```
public int LSB
```
  - DEFAULT_L_S_B
```
public static final int DEFAULT_L_S_B
```
    See Also:
    
    Constant Field Values
  - MSB
```
public int MSB
```
  - DEFAULT_M_S_B
```
public static final int DEFAULT_M_S_B
```
    See Also:
    
    Constant Field Values
  - hasInvalidValue
```
public boolean hasInvalidValue
```
  - DEFAULT_HAS_INVALID_VALUE
```
public static final boolean DEFAULT_HAS_INVALID_VALUE
```
    See Also:
    
    Constant Field Values
  - invalidValue
```
public long invalidValue
```
- Constructor Detail
  - Sort
```
public Sort()
```
  - Sort
```
public Sort(Sort o)
```
    Copy constructor
- Method Detail
  - setSecondarySortKey
```
public void setSecondarySortKey(boolean secondarySortKey)
```
    Allows disambiguating documents having the same score, on a configurable key. The rest of the comparator configuration is similar to the primary sort.
    If this option is enabled, the documents will be compared by score, and in case of equality, only by the key extracted from the configurable index field.
  - isSecondarySortKey
```
public boolean isSecondarySortKey()
```
    Allows disambiguating documents having the same score, on a configurable key. The rest of the comparator configuration is similar to the primary sort.
    If this option is enabled, the documents will be compared by score, and in case of equality, only by the key extracted from the configurable index field.
  - withSecondarySortKey
```
public Sort withSecondarySortKey(boolean secondarySortKey)
```
  - withSecondarySortKey
```
public Sort withSecondarySortKey(java.lang.Boolean secondarySortKey)
```
  - setIndexField
```
public void setIndexField(java.lang.String indexField)
```
    Index field on which we want to sort.
    You can only sort on an unsigned index field.
  - getIndexField
```
public java.lang.String getIndexField()
```
    Index field on which we want to sort.
    You can only sort on an unsigned index field.
  - withIndexField
```
public Sort withIndexField(java.lang.String indexField)
```
  - setAscending
```
public void setAscending(boolean ascending)
```
    Inverse the total order relation.
  - isAscending
```
public boolean isAscending()
```
    Inverse the total order relation.
  - withAscending
```
public Sort withAscending(boolean ascending)
```
  - withAscending
```
public Sort withAscending(java.lang.Boolean ascending)
```
  - setLSB
```
public void setLSB(int LSB)
```
    Least Significant Bit of the key inside the field.
  - getLSB
```
public int getLSB()
```
    Least Significant Bit of the key inside the field.
  - withLSB
```
public Sort withLSB(int LSB)
```
  - withLSB
```
public Sort withLSB(java.lang.Integer LSB)
```
  - setMSB
```
public void setMSB(int MSB)
```
    Most Significant Bit of the key inside the field.
  - getMSB
```
public int getMSB()
```
    Most Significant Bit of the key inside the field.
  - withMSB
```
public Sort withMSB(int MSB)
```
  - withMSB
```
public Sort withMSB(java.lang.Integer MSB)
```
  - setHasInvalidValue
```
public void setHasInvalidValue(boolean hasInvalidValue)
```
    Should one of the keys be considered as excluded from the set and
    always put at the end
  - isHasInvalidValue
```
public boolean isHasInvalidValue()
```
    Should one of the keys be considered as excluded from the set and
    always put at the end
  - withHasInvalidValue
```
public Sort withHasInvalidValue(boolean hasInvalidValue)
```
  - withHasInvalidValue
```
public Sort withHasInvalidValue(java.lang.Boolean hasInvalidValue)
```
  - setInvalidValue
```
public void setInvalidValue(long invalidValue)
```
    If hasInvalidValue is true, what is the invalid value?
  - getInvalidValue
```
public long getInvalidValue()
```
    If hasInvalidValue is true, what is the invalid value?
  - withInvalidValue
```
public Sort withInvalidValue(long invalidValue)
```
  - withInvalidValue
```
public Sort withInvalidValue(java.lang.Long invalidValue)
```
  - makeCopy
```
public Sort makeCopy()
```
    Creates and returns a deep copy of this Sort.
  - readFrom
```
public static Sort readFrom(java.io.InputStream is)
                     throws javax.xml.bind.JAXBException
```
    Read this Sort from an XML fragment.
    
    Throws:
    
    javax.xml.bind.JAXBException
  - writeTo
```
public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException
```
    Write this Sort as an XML fragment
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static Sort fromString(java.lang.String s)
                       throws javax.xml.bind.JAXBException,
                              java.io.UnsupportedEncodingException
```
    String representation of this Sort.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this Sort.
    
    Overrides:
    
    toString in class java.lang.Object
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this Sort.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Throws:
    
    com.exalead.util.TypedException

Class Sort

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

secondarySortKey

DEFAULT_SECONDARY_SORT_KEY

indexField

ascending

DEFAULT_ASCENDING

LSB

DEFAULT_L_S_B

MSB

DEFAULT_M_S_B

hasInvalidValue

DEFAULT_HAS_INVALID_VALUE

invalidValue

Constructor Detail

Sort

Sort

Method Detail

setSecondarySortKey

isSecondarySortKey

withSecondarySortKey

withSecondarySortKey

setIndexField

getIndexField

withIndexField

setAscending

isAscending

withAscending

withAscending

setLSB

getLSB

withLSB

withLSB

setMSB

getMSB

withMSB

withMSB

setHasInvalidValue

isHasInvalidValue

withHasInvalidValue

withHasInvalidValue

setInvalidValue

getInvalidValue

withInvalidValue

withInvalidValue

makeCopy

readFrom

writeTo

fromString

toString

check