org.nuiton.wikitty.search
Class Criteria

java.lang.Object
  org.nuiton.wikitty.search.Criteria

All Implemented Interfaces:

Serializable, Cloneable

public class Criteria
extends Object
implements Serializable, Cloneable

Criteria represent the search on the wikitty with restriction on field and informations on facet, pagination and sorting.

For search multiple extension use ALL_EXTENSIONS as extension name and specify field type.

Example : Criteria.ALL_EXTENSIONS + Criteria.SEPARATOR + + Criteria.SEPARATOR + FieldType.TYPE.

Version:

$Revision: 1161 $ Last update: $Date: 2011-08-16 20:07:15 +0200 (Tue, 16 Aug 2011) $ by : $Author: bpoussin $

Author:

poussin

See Also:

Serialized Form

Field Summary

static int	ALL_ELEMENTS Use to not limit result.
static String	ALL_EXTENSIONS Search on all extension.
static String	ALL_VALUES Search on all values.
protected int	endIndex Last index to get result.
protected List<Criteria>	facetCriteria Facet on criteria.
protected List<String>	facetField Facet on field.
protected int	facetLimit Nombre maximum de facet a retourner apres la requete.
protected int	facetMinCount nombre minimum de valeur pour qu'une valeur apparaisse dans les facets.
protected int	firstIndex First index to get result.
protected String	name Criteria can have name this help for presentation and is very useful for facet created by criteria.
protected Restriction	restriction All restriction on fields.
static String	SEPARATOR Separator between extension name, field name and type.
protected List<String>	sortAscending Sort ascending on fields.
protected List<String>	sortDescending Sort descending on fields.

Constructor Summary

Criteria()
Default constructor.

Criteria(String name)
Create named criteria.

Method Summary

Criteria	addFacetCriteria(Criteria criteria)
Criteria	addFacetField(String field)
Criteria	addSortAscending(String... field)
Criteria	addSortDescending(String... field)
Criteria	clone() Cree un nouvel objet criteria ou l'objet restriction est pointer par les deux critere apres le clone.
static Criteria	fromXML(String xml) Deserialize xml to criteria.
int	getEndIndex()
List<Criteria>	getFacetCriteria()
List<String>	getFacetField()
int	getFacetLimit()
int	getFacetMinCount()
int	getFirstIndex()
String	getName()
Restriction	getRestriction()
List<String>	getSortAscending() Get field names where sort is configured ascending.
List<String>	getSortDescending() Get field names where sort is configured descending.
Criteria	setEndIndex(int endIndex)
Criteria	setFacetCriteria(Criteria[] facetCriteria)
Criteria	setFacetField(String[] facetField)
Criteria	setFacetLimit(int facetLimit)
Criteria	setFacetMinCount(int facetMinCount)
Criteria	setFirstIndex(int firstIndex)
void	setName(String name)
void	setRestriction(Restriction restriction)
void	setRestriction(Search search) Substitue la restriction de ce critere par celui de search
Criteria	setSortAscending(String... sortAscending)
Criteria	setSortDescending(String... sortDescending)
String	toString()
static String	toXML(Criteria criteria) Serialize criteria to xml.

Methods inherited from class java.lang.Object

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

Field Detail

ALL_ELEMENTS

public static final int ALL_ELEMENTS

Use to not limit result.

See Also:

Constant Field Values

ALL_EXTENSIONS

public static final String ALL_EXTENSIONS

Search on all extension.

See Also:

Constant Field Values

ALL_VALUES

public static final String ALL_VALUES

Search on all values.

See Also:

Constant Field Values

SEPARATOR

public static final String SEPARATOR

Separator between extension name, field name and type.

See Also:

Constant Field Values

name

protected String name

Criteria can have name this help for presentation and is very useful for facet created by criteria.

restriction

protected Restriction restriction

All restriction on fields.

firstIndex

protected int firstIndex

First index to get result.

endIndex

protected int endIndex

Last index to get result.

facetMinCount

protected int facetMinCount

nombre minimum de valeur pour qu'une valeur apparaisse dans les facets. par defaut, il doit y avoir plus que 1 valeur.

facetLimit

protected int facetLimit

Nombre maximum de facet a retourner apres la requete. Par default on en retourne 100.

facetCriteria

protected List<Criteria> facetCriteria

Facet on criteria.

facetField

protected List<String> facetField

Facet on field.

sortAscending

protected List<String> sortAscending

Sort ascending on fields.

sortDescending

protected List<String> sortDescending

Sort descending on fields.

Constructor Detail

Criteria

public Criteria()

Default constructor.

Criteria

public Criteria(String name)

Create named criteria.

Parameters:

name - criteria name

Method Detail

clone

public Criteria clone()

Cree un nouvel objet criteria ou l'objet restriction est pointer par les deux critere apres le clone. La modification d'une restriction impactera l'autre critere. (Ce comportement peut-etre modifier si besoin). Tous les autres champs sont en deepcopy.

Overrides:

clone in class Object

Returns:

Throws:

WikittyException

fromXML

public static Criteria fromXML(String xml)

Deserialize xml to criteria.

Parameters:

xml - xml to deserialize

Returns:

criteria criteria

toXML

public static String toXML(Criteria criteria)

Serialize criteria to xml.

Parameters:

criteria - criteria to serialize

Returns:

xml string

getRestriction

public Restriction getRestriction()

setRestriction

public void setRestriction(Restriction restriction)

setRestriction

public void setRestriction(Search search)

Substitue la restriction de ce critere par celui de search

Parameters:

search -

getName

public String getName()

setName

public void setName(String name)

getFirstIndex

public int getFirstIndex()

setFirstIndex

public Criteria setFirstIndex(int firstIndex)

getEndIndex

public int getEndIndex()

setEndIndex

public Criteria setEndIndex(int endIndex)

getFacetMinCount

public int getFacetMinCount()

setFacetMinCount

public Criteria setFacetMinCount(int facetMinCount)

getFacetLimit

public int getFacetLimit()

setFacetLimit

public Criteria setFacetLimit(int facetLimit)

getFacetCriteria

public List<Criteria> getFacetCriteria()

addFacetCriteria

public Criteria addFacetCriteria(Criteria criteria)

setFacetCriteria

public Criteria setFacetCriteria(Criteria[] facetCriteria)

getFacetField

public List<String> getFacetField()

addFacetField

public Criteria addFacetField(String field)

setFacetField

public Criteria setFacetField(String[] facetField)

getSortAscending

public List<String> getSortAscending()

Get field names where sort is configured ascending.

Returns:

field names

addSortAscending

public Criteria addSortAscending(String... field)

setSortAscending

public Criteria setSortAscending(String... sortAscending)

getSortDescending

public List<String> getSortDescending()

Get field names where sort is configured descending.

Returns:

field names

addSortDescending

public Criteria addSortDescending(String... field)

setSortDescending

public Criteria setSortDescending(String... sortDescending)

toString

public String toString()

Overrides:

toString in class Object