com.exalead.search.v30

Class SortHitsInGroupBy

java.lang.Object

com.exalead.search.v30.SortBy

com.exalead.search.v30.SortHitsInGroupBy

All Implemented Interfaces:

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

public class SortHitsInGroupBy
extends SortBy
implements com.exalead.util.Checkable, java.io.Serializable

A comparative element used to sort documents of a group.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.search.v30.SortBy

SortBy.Order

Field Summary

Fields inherited from class com.exalead.search.v30.SortBy

active, DEFAULT_ACTIVE, DEFAULT_L_S_B, DEFAULT_LIMIT, DEFAULT_M_S_B, DEFAULT_MIN, DEFAULT_ORDER, expr, limit, LSB, min, MSB, name, order

Constructor Summary

Constructors

Constructor and Description
SortHitsInGroupBy()
SortHitsInGroupBy(SortHitsInGroupBy o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this SortHitsInGroupBy.
static SortHitsInGroupBy	fromString(java.lang.String s) String representation of this SortHitsInGroupBy.
SortHitsInGroupBy	makeCopy() Creates and returns a deep copy of this SortHitsInGroupBy.
static SortHitsInGroupBy	readFrom(java.io.InputStream is) Read this SortHitsInGroupBy from an XML fragment.
java.lang.String	toString() String representation of this SortHitsInGroupBy.
SortHitsInGroupBy	withActive(boolean active)
SortHitsInGroupBy	withActive(java.lang.Boolean active)
SortHitsInGroupBy	withExpr(java.lang.String expr)
SortHitsInGroupBy	withLimit(int limit)
SortHitsInGroupBy	withLimit(java.lang.Integer limit)
SortHitsInGroupBy	withLSB(int LSB)
SortHitsInGroupBy	withLSB(java.lang.Integer LSB)
SortHitsInGroupBy	withMin(long min)
SortHitsInGroupBy	withMin(java.lang.Long min)
SortHitsInGroupBy	withMSB(int MSB)
SortHitsInGroupBy	withMSB(java.lang.Integer MSB)
SortHitsInGroupBy	withName(java.lang.String name)
SortHitsInGroupBy	withOrder(java.lang.String order)
void	writeTo(java.io.OutputStream os) Write this SortHitsInGroupBy as an XML fragment

Methods inherited from class com.exalead.search.v30.SortBy

getExpr, getLimit, getLSB, getMin, getMSB, getName, getOrder, getOrderAsEnum, isA, isActive, isOneOf, setActive, setExpr, setLimit, setLSB, setMin, setMSB, setName, setOrder, setOrder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SortHitsInGroupBy

public SortHitsInGroupBy()

SortHitsInGroupBy

public SortHitsInGroupBy(SortHitsInGroupBy o)

Copy constructor

Method Detail

withName

public SortHitsInGroupBy withName(java.lang.String name)

Overrides:

withName in class SortBy

withExpr

public SortHitsInGroupBy withExpr(java.lang.String expr)

Overrides:

withExpr in class SortBy

withLSB

public SortHitsInGroupBy withLSB(int LSB)

Overrides:

withLSB in class SortBy

withLSB

public SortHitsInGroupBy withLSB(java.lang.Integer LSB)

Overrides:

withLSB in class SortBy

withMSB

public SortHitsInGroupBy withMSB(int MSB)

Overrides:

withMSB in class SortBy

withMSB

public SortHitsInGroupBy withMSB(java.lang.Integer MSB)

Overrides:

withMSB in class SortBy

withLimit

public SortHitsInGroupBy withLimit(int limit)

Overrides:

withLimit in class SortBy

withLimit

public SortHitsInGroupBy withLimit(java.lang.Integer limit)

Overrides:

withLimit in class SortBy

withMin

public SortHitsInGroupBy withMin(long min)

Overrides:

withMin in class SortBy

withMin

public SortHitsInGroupBy withMin(java.lang.Long min)

Overrides:

withMin in class SortBy

withOrder

public SortHitsInGroupBy withOrder(java.lang.String order)

Overrides:

withOrder in class SortBy

withActive

public SortHitsInGroupBy withActive(boolean active)

Overrides:

withActive in class SortBy

withActive

public SortHitsInGroupBy withActive(java.lang.Boolean active)

Overrides:

withActive in class SortBy

makeCopy

public SortHitsInGroupBy makeCopy()

Creates and returns a deep copy of this SortHitsInGroupBy.

Overrides:

makeCopy in class SortBy

readFrom

public static SortHitsInGroupBy readFrom(java.io.InputStream is)
                                  throws javax.xml.bind.JAXBException

Read this SortHitsInGroupBy 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 SortHitsInGroupBy as an XML fragment

Overrides:

writeTo in class SortBy

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static SortHitsInGroupBy fromString(java.lang.String s)
                                    throws javax.xml.bind.JAXBException,
                                           java.io.UnsupportedEncodingException

String representation of this SortHitsInGroupBy.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SortHitsInGroupBy.

Overrides:

toString in class SortBy

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this SortHitsInGroupBy.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class SortBy

Throws:

com.exalead.util.TypedException