SortBy (EXALEAD CloudView Custom code SDK)

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

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

Direct Known Subclasses:

SortHitsInGroupBy
```
public class SortBy
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable
```
Configures a sort criterion. An expression is calculated for every document matching the query and the results are
then sorted according to calculated values.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SortBy.Order

Nested Classes
Modifier and Type	Class and Description
`static class`	`SortBy.Order`

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`active`
`static boolean`	`DEFAULT_ACTIVE`
`static int`	`DEFAULT_L_S_B`
`static int`	`DEFAULT_LIMIT`
`static int`	`DEFAULT_M_S_B`
`static long`	`DEFAULT_MIN`
`static java.lang.String`	`DEFAULT_ORDER`
`java.lang.String`	`expr`
`int`	`limit`
`int`	`LSB`
`long`	`min`
`int`	`MSB`
`java.lang.String`	`name`
`java.lang.String`	`order`

Constructor Summary

Constructors
Constructor and Description

SortBy()

SortBy(SortBy o)
Copy constructor

SortBy(java.lang.String expr, java.lang.String order)

Constructors
Constructor and Description
`SortBy()`
`SortBy(SortBy o)` Copy constructor
`SortBy(java.lang.String expr, java.lang.String order)`

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 SortBy.
`static SortBy`	`fromString(java.lang.String s)` String representation of this SortBy.
`java.lang.String`	`getExpr()` Virtual expression to compare.
`int`	`getLimit()` Maximum number of characters to use when matching string values. 0 means the entire string is used for matching. Applies to alphanumerical values only.
`int`	`getLSB()` Position of the least significant bit to be considered.
`long`	`getMin()` Minimum value needed for a the document to be returned by the query. Applies to integer and double values only. 0 means keep all documents. Discards documents with a value below the minimum. Keeps documents with undefined value for this field.
`int`	`getMSB()` Position of the most significant bit to be considered.
`java.lang.String`	`getName()` Unique sort name.
`java.lang.String`	`getOrder()` Sort order Value can be null or one of asc desc
`SortBy.Order`	`getOrderAsEnum()` Sort order Value can be null or one of asc desc
`static boolean`	`isA(java.lang.String str, SortBy.Order item)`
`boolean`	`isActive()` Defines if the sort is applied by default.
`static boolean`	`isOneOf(java.lang.String str, SortBy.Order... items)`
`SortBy`	`makeCopy()` Creates and returns a deep copy of this SortBy.
`static SortBy`	`readFrom(java.io.InputStream is)` Read this SortBy from an XML fragment.
`void`	`setActive(boolean active)` Defines if the sort is applied by default.
`void`	`setExpr(java.lang.String expr)` Virtual expression to compare.
`void`	`setLimit(int limit)` Maximum number of characters to use when matching string values. 0 means the entire string is used for matching. Applies to alphanumerical values only.
`void`	`setLSB(int LSB)` Position of the least significant bit to be considered.
`void`	`setMin(long min)` Minimum value needed for a the document to be returned by the query. Applies to integer and double values only. 0 means keep all documents. Discards documents with a value below the minimum. Keeps documents with undefined value for this field.
`void`	`setMSB(int MSB)` Position of the most significant bit to be considered.
`void`	`setName(java.lang.String name)` Unique sort name.
`void`	`setOrder(SortBy.Order item)` Sort order Value can be null or one of asc desc
`void`	`setOrder(java.lang.String order)` Sort order Value can be null or one of asc desc
`java.lang.String`	`toString()` String representation of this SortBy.
`SortBy`	`withActive(boolean active)`
`SortBy`	`withActive(java.lang.Boolean active)`
`SortBy`	`withExpr(java.lang.String expr)`
`SortBy`	`withLimit(int limit)`
`SortBy`	`withLimit(java.lang.Integer limit)`
`SortBy`	`withLSB(int LSB)`
`SortBy`	`withLSB(java.lang.Integer LSB)`
`SortBy`	`withMin(long min)`
`SortBy`	`withMin(java.lang.Long min)`
`SortBy`	`withMSB(int MSB)`
`SortBy`	`withMSB(java.lang.Integer MSB)`
`SortBy`	`withName(java.lang.String name)`
`SortBy`	`withOrder(java.lang.String order)`
`void`	`writeTo(java.io.OutputStream os)` Write this SortBy as an XML fragment

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

Field Detail

name
```
public java.lang.String name
```

expr
```
public java.lang.String expr
```

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

limit
```
public int limit
```

DEFAULT_LIMIT
```
public static final int DEFAULT_LIMIT
```
See Also:

Constant Field Values

min
```
public long min
```

DEFAULT_MIN
```
public static final long DEFAULT_MIN
```
See Also:

Constant Field Values

order
```
public java.lang.String order
```

DEFAULT_ORDER

public static final java.lang.String DEFAULT_ORDER

See Also:: Constant Field Values

active
```
public boolean active
```

DEFAULT_ACTIVE
```
public static final boolean DEFAULT_ACTIVE
```
See Also:

Constant Field Values

Constructor Detail

SortBy
```
public SortBy()
```

SortBy

public SortBy(java.lang.String expr,
              java.lang.String order)

SortBy
```
public SortBy(SortBy o)
```
Copy constructor

Method Detail
- isA
```
public static boolean isA(java.lang.String str,
                          SortBy.Order item)
```
- isOneOf
```
public static boolean isOneOf(java.lang.String str,
                              SortBy.Order... items)
```
- setOrder
```
public void setOrder(SortBy.Order item)
```
  Sort order Value can be null or one of
  - asc
  - desc
- getOrderAsEnum
```
public SortBy.Order getOrderAsEnum()
```
  Sort order Value can be null or one of
  - asc
  - desc
- setName
```
public void setName(java.lang.String name)
```
  Unique sort name.
- getName
```
public java.lang.String getName()
```
  Unique sort name.
- withName
```
public SortBy withName(java.lang.String name)
```
- setExpr
```
public void setExpr(java.lang.String expr)
```
  Virtual expression to compare.
- getExpr
```
public java.lang.String getExpr()
```
  Virtual expression to compare.
- withExpr
```
public SortBy withExpr(java.lang.String expr)
```
- setLSB
```
public void setLSB(int LSB)
```
  Position of the least significant bit to be considered. Applies to integer values only.
- getLSB
```
public int getLSB()
```
  Position of the least significant bit to be considered. Applies to integer values only.
- withLSB
```
public SortBy withLSB(int LSB)
```
- withLSB
```
public SortBy withLSB(java.lang.Integer LSB)
```
- setMSB
```
public void setMSB(int MSB)
```
  Position of the most significant bit to be considered. Applies to integer values only.
- getMSB
```
public int getMSB()
```
  Position of the most significant bit to be considered. Applies to integer values only.
- withMSB
```
public SortBy withMSB(int MSB)
```
- withMSB
```
public SortBy withMSB(java.lang.Integer MSB)
```
- setLimit
```
public void setLimit(int limit)
```
  Maximum number of characters to use when matching string values.
  0 means the entire string is used for matching.
  Applies to alphanumerical values only.
- getLimit
```
public int getLimit()
```
  Maximum number of characters to use when matching string values.
  0 means the entire string is used for matching.
  Applies to alphanumerical values only.
- withLimit
```
public SortBy withLimit(int limit)
```
- withLimit
```
public SortBy withLimit(java.lang.Integer limit)
```
- setMin
```
public void setMin(long min)
```
  Minimum value needed for a the document to be returned by the query.
  Applies to integer and double values only.
  0 means keep all documents.
  Discards documents with a value below the minimum.
  Keeps documents with undefined value for this field.
- getMin
```
public long getMin()
```
  Minimum value needed for a the document to be returned by the query.
  Applies to integer and double values only.
  0 means keep all documents.
  Discards documents with a value below the minimum.
  Keeps documents with undefined value for this field.
- withMin
```
public SortBy withMin(long min)
```
- withMin
```
public SortBy withMin(java.lang.Long min)
```
- setOrder
```
public void setOrder(java.lang.String order)
```
  Sort order Value can be null or one of
  - asc
  - desc
- getOrder
```
public java.lang.String getOrder()
```
  Sort order Value can be null or one of
  - asc
  - desc
- withOrder
```
public SortBy withOrder(java.lang.String order)
```
- setActive
```
public void setActive(boolean active)
```
  Defines if the sort is applied by default.
- isActive
```
public boolean isActive()
```
  Defines if the sort is applied by default.
- withActive
```
public SortBy withActive(boolean active)
```
- withActive
```
public SortBy withActive(java.lang.Boolean active)
```
- makeCopy
```
public SortBy makeCopy()
```
  Creates and returns a deep copy of this SortBy.
- readFrom
```
public static SortBy readFrom(java.io.InputStream is)
                       throws javax.xml.bind.JAXBException
```
  Read this SortBy 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 SortBy as an XML fragment
  
  Throws:
  
  javax.xml.bind.JAXBException
  
  java.io.IOException
- fromString
```
public static SortBy fromString(java.lang.String s)
                         throws javax.xml.bind.JAXBException,
                                java.io.UnsupportedEncodingException
```
  String representation of this SortBy.
  
  Throws:
  
  javax.xml.bind.JAXBException
  
  java.io.UnsupportedEncodingException
- toString
```
public java.lang.String toString()
```
  String representation of this SortBy.
  
  Overrides:
  
  toString in class java.lang.Object
- check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
  Checks this SortBy.
  
  Specified by:
  
  check in interface com.exalead.util.Checkable
  
  Throws:
  
  com.exalead.util.TypedException

Class SortBy

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

expr

LSB

DEFAULT_L_S_B

MSB

DEFAULT_M_S_B

limit

DEFAULT_LIMIT

min

DEFAULT_MIN

order

DEFAULT_ORDER

active

DEFAULT_ACTIVE

Constructor Detail

SortBy

SortBy

SortBy

Method Detail

isA

isOneOf

setOrder

getOrderAsEnum

setName

getName

withName

setExpr

getExpr

withExpr

setLSB

getLSB

withLSB

withLSB

setMSB

getMSB

withMSB

withMSB

setLimit

getLimit

withLimit

withLimit

setMin

getMin

withMin

withMin

setOrder

getOrder

withOrder

setActive

isActive

withActive

withActive

makeCopy

readFrom

writeTo

fromString

toString

check