com.attivio.sdk.search

Class FieldCollapse

java.lang.Object

com.attivio.sdk.search.FieldCollapse

All Implemented Interfaces:

Serializable, Cloneable

public class FieldCollapse
extends Object
implements Cloneable, Serializable

Field Collapsing Specification.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldCollapse.Mode Mode for performing field collapsing.

Constructor Summary

Constructors

Constructor and Description
FieldCollapse()
FieldCollapse(String field)

Method Summary

Modifier and Type	Method and Description
FieldCollapse	clone()
boolean	equals(Object other)
String	getField() Get the field to use for field collapsing.
FieldCollapse.Mode	getMode() Get the FieldCollapse.Mode for field collapsing.
int	getRows() Get the number of rows to return for each group (including the group leader).
List<Sort>	getSort() Get the sort specification.
int	hashCode()
boolean	isFacet() Get if collapsed documents should be included in facet computations.
void	setFacet(boolean value)
void	setField(String value) Set the field to use for field collapsing.
void	setMode(FieldCollapse.Mode value) Set the FieldCollapse.Mode for field collapsing.
void	setRows(int value) Set the number of rows to return for each group (including the group leader).
void	setSort(List<Sort> value) Set the sort specification.
void	setSort(Sort... value) Set the sort.
void	setSort(String field, Sort.SortOrder order) Set the field to sort rows in a group.
String	toString()
static FieldCollapse	valueOf(Object value)
static FieldCollapse	valueOf(String value)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FieldCollapse

public FieldCollapse()

FieldCollapse

public FieldCollapse(String field)

Method Detail

getMode

public FieldCollapse.Mode getMode()

Get the FieldCollapse.Mode for field collapsing.

setMode

public void setMode(FieldCollapse.Mode value)

Set the FieldCollapse.Mode for field collapsing.

getField

public String getField()

Get the field to use for field collapsing.

This field must be a single value joinable field.

setField

public void setField(String value)

Set the field to use for field collapsing.

This field must be a single value joinable field.

getSort

public List<Sort> getSort()

Get the sort specification.

If null the default ordering will be used.

setSort

public void setSort(List<Sort> value)

Set the sort specification.

setSort

public void setSort(Sort... value)

Set the sort.

setSort

public void setSort(String field,
                    Sort.SortOrder order)

Set the field to sort rows in a group.

getRows

public int getRows()

Get the number of rows to return for each group (including the group leader).

setRows

public void setRows(int value)

Set the number of rows to return for each group (including the group leader).

isFacet

public boolean isFacet()

Get if collapsed documents should be included in facet computations.

This is only relevant for FieldCollapse.Mode.DEFAULT mode. 2-D field collapsing will always compute facets over all documents matching the search.

setFacet

public void setFacet(boolean value)

clone

public FieldCollapse clone()

Overrides:

clone in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

valueOf

public static FieldCollapse valueOf(Object value)

valueOf

public static FieldCollapse valueOf(String value)