com.exalead.search.v30

Class SortConfig

java.lang.Object

com.exalead.search.v30.SortConfig

All Implemented Interfaces:

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

public class SortConfig
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Define the order of returned documents.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_DISCARD_INVALID_SORT
boolean	discardInvalidSort
java.util.List<SortBy>	sortBy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this SortConfig.
static SortConfig	fromString(java.lang.String s) String representation of this SortConfig.
java.util.List<SortBy>	getSortBy() Ordered list of expresion that defines a lexicographical order (documents having the same value for the first criteria are then ordered using the second critera, and so on).
java.util.Map<java.lang.String,SortBy>	getSortByAsMap() Get the map of SortBy, indexed by name
SortBy	getSortByByName(java.lang.String _lookup) Get the SortBy for which the name matches _lookup
boolean	isDiscardInvalidSort() Auto discard sortBy not allowed rather than sending an error.
SortConfig	makeCopy() Creates and returns a deep copy of this SortConfig.
static SortConfig	readFrom(java.io.InputStream is) Read this SortConfig from an XML fragment.
boolean	removeSortByByName(java.lang.String _lookup) Removes the SortBy for which the name matches _lookup
void	setDiscardInvalidSort(boolean discardInvalidSort) Auto discard sortBy not allowed rather than sending an error.
java.lang.String	toString() String representation of this SortConfig.
SortConfig	withDiscardInvalidSort(boolean discardInvalidSort)
SortConfig	withDiscardInvalidSort(java.lang.Boolean discardInvalidSort)
SortConfig	withSortBy(java.util.Collection<SortBy> __values)
SortConfig	withSortBy(SortBy... __values) Ordered list of expresion that defines a lexicographical order (documents having the same value for the first criteria are then ordered using the second critera, and so on).
void	writeTo(java.io.OutputStream os) Write this SortConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

sortBy

public java.util.List<SortBy> sortBy

discardInvalidSort

public boolean discardInvalidSort

DEFAULT_DISCARD_INVALID_SORT

public static final boolean DEFAULT_DISCARD_INVALID_SORT

See Also:

Constant Field Values

Constructor Detail

SortConfig

public SortConfig()

SortConfig

public SortConfig(SortConfig o)

Copy constructor

Method Detail

getSortBy

public java.util.List<SortBy> getSortBy()

Ordered list of expresion that defines a lexicographical order (documents having the same value for the first criteria are then ordered using the second critera, and so on).

getSortByByName

public SortBy getSortByByName(java.lang.String _lookup)

Get the SortBy for which the name matches _lookup

Returns:

null if no matching SortBy is found

getSortByAsMap

public java.util.Map<java.lang.String,SortBy> getSortByAsMap()

Get the map of SortBy, indexed by name

removeSortByByName

public boolean removeSortByByName(java.lang.String _lookup)

Removes the SortBy for which the name matches _lookup

Returns:

false if no matching SortBy is found, true if one was found

withSortBy

public SortConfig withSortBy(SortBy... __values)

Ordered list of expresion that defines a lexicographical order (documents having the same value for the first criteria are then ordered using the second critera, and so on).

withSortBy

public SortConfig withSortBy(java.util.Collection<SortBy> __values)

setDiscardInvalidSort

public void setDiscardInvalidSort(boolean discardInvalidSort)

Auto discard sortBy not allowed rather than sending an error.

isDiscardInvalidSort

public boolean isDiscardInvalidSort()

Auto discard sortBy not allowed rather than sending an error.

withDiscardInvalidSort

public SortConfig withDiscardInvalidSort(boolean discardInvalidSort)

withDiscardInvalidSort

public SortConfig withDiscardInvalidSort(java.lang.Boolean discardInvalidSort)

makeCopy

public SortConfig makeCopy()

Creates and returns a deep copy of this SortConfig.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SortConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SortConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this SortConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException