org.nuiton.wikitty.query

Class WikittyQuery

java.lang.Object

org.nuiton.wikitty.query.WikittyQuery

All Implemented Interfaces:

Serializable

public class WikittyQuery
extends Object
implements Serializable

Classe permettant de faire des recherches dans les données.

Pour creer facilement la condition le plus simple est d'utiliser WikittyQueryMaker pour creer le WikittyQuery en appelant la method WikittyQueryMaker.end() a la fin.

Pour offrir au utilisateur de vos applications la possibilite d'ecrire eux meme des requetes vous pouvez utiliser WikittyQueryParser

Since:

3.3 Last update: $Date: 2012-08-23 11:04:02 +0200 (jeu. 23 août 2012) $ by : $Author: bpoussin $

Version:

$Revision: 1502 $

Author:

poussin

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	checkAuthorisation indique si dans les resultats on doit ajouter les id des objets que l'utilisateur ne peut pas lire.
protected Condition	condition query condition
protected boolean	facetExtension if true facet is done on extension name.
protected List<Element>	facetField Facet on field.
protected int	facetLimit Nombre maximum de topic par facet a retourner.
protected int	facetMinCount nombre minimum de valeur pour qu'une valeur apparaisse dans les facets.
protected List<FacetQuery>	facetQuery Facet on condition.
protected FacetSortType	facetSort sort topic order, default is sorted on count
protected int	limit Number of result to retrieve. 100 by default.
static int	MAX Use to not limit result.
protected String	name query name
protected int	offset First index to get result.
protected List<Element>	sortAscending Sort ascending on fields.
protected List<Element>	sortDescending Sort descending on fields.
protected int	wikittyFieldSearchDepth Profondeur de recherche sur les champs de type wikitty.

Constructor Summary

Constructors

Constructor and Description
WikittyQuery() create anonymous query
WikittyQuery(Condition condition)
WikittyQuery(String name) create named query
WikittyQuery(String name, Condition condition) create named query with condition

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(WikittyQueryVisitor visitor)
WikittyQuery	addFacetField(Element field)
WikittyQuery	addFacetQuery(FacetQuery facetQuery)
WikittyQuery	addFacetQuery(String name, Condition condition)
WikittyQuery	addSortAscending(ElementField... field)
WikittyQuery	addSortDescending(Element... field)
WikittyQuery	copy()
boolean	equals(Object o)
Condition	getCondition()
List<Element>	getFacetField()
int	getFacetLimit()
int	getFacetMinCount()
List<FacetQuery>	getFacetQuery()
FacetSortType	getFacetSort()
int	getFirst() Deprecated. since 3.5 use getOffset()
int	getLimit() Get result limit. 0 return no result (usefull for facets and result count). -1 return all results.
String	getName()
int	getOffset() Indique le premier element retourne par la requete.
List<Element>	getSortAscending() Get field names where sort is configured ascending.
List<Element>	getSortDescending() Get field names where sort is configured descending.
int	getWikittyFieldSearchDepth()
int	hashCode() Inefficient hashCode method but necessary with overloading of equals method This method return hashCode of object class.
boolean	isCheckAuthorisation() indique si dans les resultats on doit ajouter les id des objets que l'utilisateur ne peut pas lire.
boolean	isFacetExtension()
void	setCheckAuthorisation(boolean checkAuthorisation)
WikittyQuery	setCondition(Condition condition)
WikittyQuery	setFacetExtension(boolean facetExtension)
WikittyQuery	setFacetField(Element... facetField)
WikittyQuery	setFacetField(List<Element> facetField)
WikittyQuery	setFacetLimit(int facetLimit)
WikittyQuery	setFacetMinCount(int facetMinCount)
WikittyQuery	setFacetQuery(FacetQuery... facetQuery)
void	setFacetSort(FacetSortType facetSort)
WikittyQuery	setFirst(int first) Deprecated. since 3.5 use setOffset(int)
WikittyQuery	setLimit(int count) Set result limit. 0 return no result (usefull for facets and result count). negative value or MAX return all results.
WikittyQuery	setName(String name)
WikittyQuery	setOffset(int offset) Indique le premier element retourne par la requete.
WikittyQuery	setSortAscending(Element... sortAscending)
WikittyQuery	setSortAscending(List<Element> sortAscending)
WikittyQuery	setSortDescending(Element... sortDescending)
WikittyQuery	setSortDescending(List<Element> sortDescending)
WikittyQuery	setWikittyFieldSearchDepth(int wikittyFieldSearchDepth)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MAX

public static final int MAX

Use to not limit result.

See Also:

Constant Field Values

name

protected String name

query name

condition

protected Condition condition

query condition

offset

protected int offset

First index to get result.

limit

protected int limit

Number of result to retrieve. 100 by default.

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 topic par facet a retourner. Par default on en retourne 100.

facetSort

protected FacetSortType facetSort

sort topic order, default is sorted on count

facetQuery

protected List<FacetQuery> facetQuery

Facet on condition.

facetField

protected List<Element> facetField

Facet on field.

facetExtension

protected boolean facetExtension

if true facet is done on extension name. Extention facet can be found in WikittyQueryResult.getFacets() with key Element.EXTENSION#getValue()

sortAscending

protected List<Element> sortAscending

Sort ascending on fields.

sortDescending

protected List<Element> sortDescending

Sort descending on fields.

wikittyFieldSearchDepth

protected int wikittyFieldSearchDepth

Profondeur de recherche sur les champs de type wikitty. Ce qui permet de ne pas passer un id ou faire un select, mais directement passer une chaine. Par defaut pas de recherche profonde, une valeur superieur a 1 est dangereuse pour les performances.

checkAuthorisation

protected boolean checkAuthorisation

indique si dans les resultats on doit ajouter les id des objets que l'utilisateur ne peut pas lire. par defaut on ne remonte pas les objets que l'utilisateur ne peut pas lire. Si vrai alors on ne remonte pas les objets, si faux et que la requete n'est pas un select on remonte les objets non lisible

Constructor Detail

WikittyQuery

public WikittyQuery()

create anonymous query

WikittyQuery

public WikittyQuery(Condition condition)

WikittyQuery

public WikittyQuery(String name)

create named query

WikittyQuery

public WikittyQuery(String name,
            Condition condition)

create named query with condition

Method Detail

isCheckAuthorisation

public boolean isCheckAuthorisation()

indique si dans les resultats on doit ajouter les id des objets que l'utilisateur ne peut pas lire. par defaut on ne remonte pas les objets que l'utilisateur ne peut pas lire. Si vrai alors on ne remonte pas les objets, si faux et que la requete n'est pas un select on remonte les objets non lisible si checkAuthorisation est:

true alors filtre actif false et requete sans select alors filtre inactif false et requete select alors filtre actif

setCheckAuthorisation

public void setCheckAuthorisation(boolean checkAuthorisation)

copy

public WikittyQuery copy()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Inefficient hashCode method but necessary with overloading of equals method This method return hashCode of object class. There is no better way to compute stable hashCode in time

Overrides:

hashCode in class Object

Returns:

accept

public void accept(WikittyQueryVisitor visitor)

getName

public String getName()

setName

public WikittyQuery setName(String name)

getOffset

public int getOffset()

Indique le premier element retourne par la requete. Si la requete peut retourner 100 reponses, et qu'on fixe l'offset a 25 alors il n'y aura au maximume que 75 reponses retournees.

Returns:

setOffset

public WikittyQuery setOffset(int offset)

Indique le premier element retourne par la requete. Si la requete peut retourner 100 reponses, et qu'on fixe l'offset a 25 alors il n'y aura au maximume que 75 reponses retournees.

Returns:

getFirst

@Deprecated
public int getFirst()

Deprecated. since 3.5 use getOffset()

setFirst

@Deprecated
public WikittyQuery setFirst(int first)

Deprecated. since 3.5 use setOffset(int)

getLimit

public int getLimit()

Get result limit. 0 return no result (usefull for facets and result count). -1 return all results.

Returns:

result count

setLimit

public WikittyQuery setLimit(int count)

Set result limit. 0 return no result (usefull for facets and result count). negative value or MAX return all results.

Parameters:

count - new count

Returns:

this

getFacetMinCount

public int getFacetMinCount()

setFacetMinCount

public WikittyQuery setFacetMinCount(int facetMinCount)

getFacetLimit

public int getFacetLimit()

setFacetLimit

public WikittyQuery setFacetLimit(int facetLimit)

setFacetSort

public void setFacetSort(FacetSortType facetSort)

getFacetSort

public FacetSortType getFacetSort()

getFacetQuery

public List<FacetQuery> getFacetQuery()

addFacetQuery

public WikittyQuery addFacetQuery(FacetQuery facetQuery)

addFacetQuery

public WikittyQuery addFacetQuery(String name,
                         Condition condition)

setFacetQuery

public WikittyQuery setFacetQuery(FacetQuery... facetQuery)

getFacetField

public List<Element> getFacetField()

addFacetField

public WikittyQuery addFacetField(Element field)

setFacetField

public WikittyQuery setFacetField(Element... facetField)

setFacetField

public WikittyQuery setFacetField(List<Element> facetField)

isFacetExtension

public boolean isFacetExtension()

setFacetExtension

public WikittyQuery setFacetExtension(boolean facetExtension)

getSortAscending

public List<Element> getSortAscending()

Get field names where sort is configured ascending.

Returns:

field names

addSortAscending

public WikittyQuery addSortAscending(ElementField... field)

setSortAscending

public WikittyQuery setSortAscending(Element... sortAscending)

setSortAscending

public WikittyQuery setSortAscending(List<Element> sortAscending)

getSortDescending

public List<Element> getSortDescending()

Get field names where sort is configured descending.

Returns:

field names

addSortDescending

public WikittyQuery addSortDescending(Element... field)

setSortDescending

public WikittyQuery setSortDescending(Element... sortDescending)

setSortDescending

public WikittyQuery setSortDescending(List<Element> sortDescending)

getCondition

public Condition getCondition()

setCondition

public WikittyQuery setCondition(Condition condition)

getWikittyFieldSearchDepth

public int getWikittyFieldSearchDepth()

setWikittyFieldSearchDepth

public WikittyQuery setWikittyFieldSearchDepth(int wikittyFieldSearchDepth)