com.exalead.search.v30

Class GroupBy

java.lang.Object

com.exalead.search.v30.GroupBy

All Implemented Interfaces:

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

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

A comparative element used to identify group of documents.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_L_S_B
static int	DEFAULT_LIMIT
static int	DEFAULT_M_S_B
java.lang.String	expr
int	limit
int	LSB
int	MSB

Constructor Summary

Constructors

Constructor and Description
GroupBy()
GroupBy(GroupBy o) Copy constructor
GroupBy(java.lang.String expr)

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this GroupBy.
static GroupBy	fromString(java.lang.String s) String representation of this GroupBy.
java.lang.String	getExpr() Virtual expression to compare.
int	getLimit() Maximum number of characters to consider when comparing string values. 0 means the string is compared till the end. Applies to alphanumerical values only, ignored otherwize.
int	getLSB() Position of the least significant bit to be considered.
int	getMSB() Position of the most significant bit to be considered.
GroupBy	makeCopy() Creates and returns a deep copy of this GroupBy.
static GroupBy	readFrom(java.io.InputStream is) Read this GroupBy from an XML fragment.
void	setExpr(java.lang.String expr) Virtual expression to compare.
void	setLimit(int limit) Maximum number of characters to consider when comparing string values. 0 means the string is compared till the end. Applies to alphanumerical values only, ignored otherwize.
void	setLSB(int LSB) Position of the least significant bit to be considered.
void	setMSB(int MSB) Position of the most significant bit to be considered.
java.lang.String	toString() String representation of this GroupBy.
GroupBy	withExpr(java.lang.String expr)
GroupBy	withLimit(int limit)
GroupBy	withLimit(java.lang.Integer limit)
GroupBy	withLSB(int LSB)
GroupBy	withLSB(java.lang.Integer LSB)
GroupBy	withMSB(int MSB)
GroupBy	withMSB(java.lang.Integer MSB)
void	writeTo(java.io.OutputStream os) Write this GroupBy as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

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

Constructor Detail

GroupBy

public GroupBy()

GroupBy

public GroupBy(java.lang.String expr)

GroupBy

public GroupBy(GroupBy o)

Copy constructor

Method Detail

setExpr

public void setExpr(java.lang.String expr)

Virtual expression to compare.

getExpr

public java.lang.String getExpr()

Virtual expression to compare.

withExpr

public GroupBy 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, ignored otherwize.

getLSB

public int getLSB()

Position of the least significant bit to be considered. Applies to integer values only, ignored otherwize.

withLSB

public GroupBy withLSB(int LSB)

withLSB

public GroupBy 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, ignored otherwize.

getMSB

public int getMSB()

Position of the most significant bit to be considered. Applies to integer values only, ignored otherwize.

withMSB

public GroupBy withMSB(int MSB)

withMSB

public GroupBy withMSB(java.lang.Integer MSB)

setLimit

public void setLimit(int limit)

Maximum number of characters to consider when comparing string values.
0 means the string is compared till the end.
Applies to alphanumerical values only, ignored otherwize.

getLimit

public int getLimit()

Maximum number of characters to consider when comparing string values.
0 means the string is compared till the end.
Applies to alphanumerical values only, ignored otherwize.

withLimit

public GroupBy withLimit(int limit)

withLimit

public GroupBy withLimit(java.lang.Integer limit)

makeCopy

public GroupBy makeCopy()

Creates and returns a deep copy of this GroupBy.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this GroupBy.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this GroupBy.

Overrides:

toString in class java.lang.Object

check

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

Checks this GroupBy.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException